GSOC 2025 - Website - June

[SteLeo]

1. Completed the creation of a new PatternVariableAssignment check with relatively green CI: 

2. Currently working on recording the tutorial YouTube videos on how to read and access errors in CI for beginners.

The challenging part for me was satisfying the Ptest mutation coverage criteria in the new check pull request, while ensuring it won't conflict with other CI checks, particularly the "Checker / check (nullness-optional-interning)" check. This particular check often promoted the fixes that the Pitest would perceive as the new coverage problems, leading me to hours of attempted code change fluctuations and eventually resort to the suppression of the check.

[SteLeo]

Monday, June 09 report

1) Worked on completing the mentors' review requests in https://github.com/checkstyle/checkstyle/pull/16946
2) Thought over and recorded a draft for the first common part of the CI Tutorial video

The hardest part for me was familiarizing myself with the CI from the other perspective. I discovered a lot of room for growth in myself related to how CI functions.

[SteLeo]

Thursday, June 12 report

1. Polished completely the new PatternVariableAssignment check for review in the pull request and addressed its potential false-negative problem in the issue

2. Took ownership of the since version pull request, which I'm currently in progress on resolving.

3. Recorded the final draft and uploaded 2 CI tutorial videos to my playlist for new contributors 

4. Have plans for the implementation of a new Javadoc annotation to display and access the version of the check's property more efficiently

What blocked me was the parallel GSOC project's raw work impact on the official repository and IDEA. As other project affected some test inputs, the IDEA threw various problems with -source version compatibility as I tried to run the tests, leading me to look for how to exclude it for hours.

[SteLeo]

Thursday, June 16 report

1. Unraveled the problem of properties' since version calculation issue in more detail and proposed a solution by creating a separate issue
2. Completely analyzed all hardcoded cases of property versions and eliminated the ones, unconnected to the problem mentioned above, in https://github.com/checkstyle/checkstyle/pull/17216

3. Wrote the implementation for recognizing and extracting the actual version of the property from newly proposed Javadoc data in https://github.com/checkstyle/checkstyle/pull/17216

[SteLeo]

Thursday, June 19 report

1. Migrated the part with new javadoc data implementation from https://github.com/checkstyle/checkstyle/pull/17216 to new https://github.com/checkstyle/checkstyle/pull/17238 and created a new issue for the remaining part of the original pull request

2. Revised and confirmed each of the version updates with CLI in https://github.com/checkstyle/checkstyle/pull/17216, finalizing with the polishing of code and coverage of all CIs

3. For https://github.com/checkstyle/checkstyle/pull/17238, plan to integrate the newly written javadoc data implementation within the tests in order to solve the actual vs expected inconsistency

[SteLeo]

Monday, June 23 report

1. Addressed the inconsistency of actual vs expected outputs from https://github.com/checkstyle/checkstyle/pull/17238 in the new issue: https://github.com/checkstyle/checkstyle/issues/17251

2. Eliminated most of the map's hardcoded cases for property versions by extending the implementation of the newly added module's javadoc "Since version" marking in the following pull requests:
https://github.com/checkstyle/checkstyle/pull/17238
https://github.com/checkstyle/checkstyle/pull/17272

What blocked me was improperly organized release history of checkstyle versions, which made me guess and look for the date for quite a bit.

[SteLeo]

Thursday, June 26 report

1. Completely fixed the property since version calculation in version macros, resolving https://github.com/checkstyle/checkstyle/issues/17225 and finishing removing all hardcoded map cases with the final pull

2. Started working on creating a new description macro, making a ticket for it, and so far coding the implementation for the macro to extract the module's description in https://github.com/checkstyle/checkstyle/pull/17278

3. Spotted a bug with problematic code of JavadocMetadataScrapper extracting the description content improperly and addressed it in https://github.com/checkstyle/checkstyle/issues/17283

What was challenging and took the most time was me trying to figure out how I can access the data like DetailNode or any other information about the module from a Macro file with just 2 attributes: sink and request. I was also preoccupied for some time trying to find existing methods in the project for extracting various types of information from Javadoc (like description or starting indexes of Javadoc parts).

[SteLeo]

Monday, June 30 report

1. Finished fixing JavadocMetadataScraper not scraping the text completely

2. Discovered widespread misuse of <since> tag, addressing it in https://github.com/checkstyle/checkstyle/issues/17295 and sending the first draft update in https://github.com/checkstyle/checkstyle/pull/17297

3. Disabled and addressed the problem of IDEA CI JavadocBlankLines inspection in https://github.com/checkstyle/checkstyle/issues/17298

4. Worked on organizing code and fixing some of CIs for coming new Description Macro

[SteLeo]

Thursday, July 3 report

1. Revised supplemented tag updated in https://github.com/checkstyle/checkstyle/pull/17297, finishing in new pull: https://github.com/checkstyle/checkstyle/pull/17307

2. Fixed all CIs and improved code features in https://github.com/checkstyle/checkstyle/pull/17278
3. Spotted problem of Notes section overlapping with Description, addressing it in https://github.com/checkstyle/checkstyle/issues/17310 and sending first draft in https://github.com/checkstyle/checkstyle/pull/17311
4. Started to migrate checks to the new macro in:

https://github.com/checkstyle/checkstyle/pull/17315
https://github.com/checkstyle/checkstyle/pull/17318

[SteLeo]

Monday, July 7 report

1. Organized extension of new Description Macro to check templates workflow into module types
2. Suppressed expected vs actual inconsistency in https://github.com/checkstyle/checkstyle/pull/17311#issuecomment-3041638886

[SteLeo]

Thursday, July 10 report

1. Extended Description Macro to more module types:
https://github.com/checkstyle/checkstyle/pull/17334
https://github.com/checkstyle/checkstyle/pull/17338
https://github.com/checkstyle/checkstyle/pull/17339
https://github.com/checkstyle/checkstyle/pull/17347
https://github.com/checkstyle/checkstyle/pull/17349
https://github.com/checkstyle/checkstyle/pull/17339
https://github.com/checkstyle/checkstyle/pull/17350
https://github.com/checkstyle/checkstyle/pull/17351
https://github.com/checkstyle/checkstyle/pull/17352
https://github.com/checkstyle/checkstyle/pull/17357
https://github.com/checkstyle/checkstyle/pull/17361

2. Removed XdocsJavaDocsTest expected vs actual inconsistency in https://github.com/checkstyle/checkstyle/pull/17337

3. Fixed all CIs and polished Notes Macro in https://github.com/checkstyle/checkstyle/pull/17311

4. Discovered problem with uncovered <table> tags in module javadoc, addressed it in https://github.com/checkstyle/checkstyle/issues/17355, and sent draft pull https://github.com/checkstyle/checkstyle/pull/17356)

5. Fixed problem of loss of indentation by macro, sending fix in https://github.com/checkstyle/checkstyle/pull/17350

The challenging part was solving the loss of indentation by Description Macro in https://github.com/checkstyle/checkstyle/pull/17352/checks?check_run_id=45695619593 and https://github.com/checkstyle/checkstyle/pull/17350, as CI didn't share any details and reasons behind the inconsistency, having to closely inspect every aspect of the imported methods to eventually find the reason for \r not being accounted properly, along with \n between Windows and Linux 

[SteLeo]

Monday, July 14 report

1. Finished migration of sole Description Macro to check types

2. Polished and completed Notes macro https://github.com/checkstyle/checkstyle/pull/17311
2. Initiated migration of Notes Macro with Description Macro in bundle to checks:

https://github.com/checkstyle/checkstyle/pull/17380
https://github.com/checkstyle/checkstyle/pull/17381

https://github.com/checkstyle/checkstyle/pull/17380
https://github.com/checkstyle/checkstyle/pull/17381

3. Initiated migration of Notes and Description macros to filter-type modules:
https://github.com/checkstyle/checkstyle/pull/17388
https://github.com/checkstyle/checkstyle/pull/17389

4. Created implementation for new module javadoc parsing Utility class: https://github.com/checkstyle/checkstyle/pull/17377

[SteLeo]

Thursday, July 17 report

1. Added new RegexpSingleline check instance for Description Macro and revised it for other macros: https://github.com/checkstyle/checkstyle/pull/17397

2. Finished migration of Notes and Description macro to xdoc template files.

3. Revised and ensured that all of the notes sections in the module's javadoc are underneath the description section: https://github.com/checkstyle/checkstyle/pull/17405

4. Started enabling the Examples macro for the ImportControl check:
https://github.com/checkstyle/checkstyle/pull/17412
https://github.com/checkstyle/checkstyle/pull/17416

[SteLeo]

Monday, July 21 report

Finished enabling example macros for import control checks:
https://github.com/checkstyle/checkstyle/pull/17416
https://github.com/checkstyle/checkstyle/pull/17423
https://github.com/checkstyle/checkstyle/pull/17431
https://github.com/checkstyle/checkstyle/pull/17434
https://github.com/checkstyle/checkstyle/pull/17440
https://github.com/checkstyle/checkstyle/pull/17441

[SteLeo]

Thursday, July 24 report

1. Successfully enabled examples macro for SuppressionXpathFilter with CI green:
https://github.com/checkstyle/checkstyle/pull/17450
https://github.com/checkstyle/checkstyle/pull/17455

2. Work on enabling the examples macro for SuppressionXpathFilter:
https://github.com/checkstyle/checkstyle/pull/17457
https://github.com/checkstyle/checkstyle/pull/17456

[SteLeo]

Monday, July 28 report

1. Finished enabling examples macros for SuppressionXpathFilter:
https://github.com/checkstyle/checkstyle/pull/17457
https://github.com/checkstyle/checkstyle/pull/17456
https://github.com/checkstyle/checkstyle/pull/17462
https://github.com/checkstyle/checkstyle/pull/17463
https://github.com/checkstyle/checkstyle/pull/17473
https://github.com/checkstyle/checkstyle/pull/17476
https://github.com/checkstyle/checkstyle/pull/17478
https://github.com/checkstyle/checkstyle/pull/17479
https://github.com/checkstyle/checkstyle/pull/17481
https://github.com/checkstyle/checkstyle/pull/17482
https://github.com/checkstyle/checkstyle/pull/17483
https://github.com/checkstyle/checkstyle/pull/17485


2. Fixed anchor link tags in google_style.xml and sun_style.xml: https://github.com/checkstyle/checkstyle/pull/17496

3. Sent draft pull for splitting SiteUtil.getPropertiesJavadocs method into two: https://github.com/checkstyle/checkstyle/pull/17498

[SteLeo]

Thursday, July 31 report

- Finished fixing anchor links: https://github.com/checkstyle/checkstyle/pull/17496

- Finished splitting SiteUtil.getPropertiesJavadocs method into two: https://github.com/checkstyle/checkstyle/pull/17498

- Send draft PR for refactoring property get since version methods in SiteUtil: https://github.com/checkstyle/checkstyle/pull/17515

- Removed anchor from module links: https://github.com/checkstyle/checkstyle/pull/17519

- Attempted to digest and understand the problem of updating the Doxia: https://github.com/checkstyle/checkstyle/issues/17403

- Started making structure for the IT regression area for the following issue: https://github.com/checkstyle/checkstyle/issues/14769

Because I'm not really familiar with the Doxia API and the dependencies system in our project, I spent a lot of time trying to figure out the underlying problems in updating Doxia and coming up with the first plan.

[SteLeo]

Monday, August 04 report

- Finished up the previous report's work:

https://github.com/checkstyle/checkstyle/pull/17519
https://github.com/checkstyle/checkstyle/pull/17498

- Researched how our Xdoc generation works, accounting for the Sink and Parsers from Doxia

- Brainstormed with mentors on how to update Doxia, and decided to move on from it for now, sending the draft PR: https://github.com/checkstyle/checkstyle/pull/17534

- Organized IT Structure for annotation modules and prepared foundations for further migration of other modules: https://github.com/checkstyle/checkstyle/pull/17534

- Added link anchors to examples in confgix.xml: https://github.com/checkstyle/checkstyle/pull/17548

[SteLeo]

Thursday, August 07 report

- Implemented structure for IT for the rest of the module packages:

https://github.com/checkstyle/checkstyle/pull/17555
https://github.com/checkstyle/checkstyle/pull/17556

https://github.com/checkstyle/checkstyle/pull/17576
https://github.com/checkstyle/checkstyle/pull/17577
https://github.com/checkstyle/checkstyle/pull/17578
https://github.com/checkstyle/checkstyle/pull/17579
https://github.com/checkstyle/checkstyle/pull/17580
https://github.com/checkstyle/checkstyle/pull/17582
https://github.com/checkstyle/checkstyle/pull/17583
https://github.com/checkstyle/checkstyle/pull/17584
https://github.com/checkstyle/checkstyle/pull/17587

- Continued adding link anchors for examples in config documentation:

https://github.com/checkstyle/checkstyle/pull/17558

- Recorded the draft video for https://github.com/checkstyle/checkstyle/issues/17404

[SteLeo]

Monday, August 11 report

- Continued Harsh-kumar-jha's PR about adding filter table validation, supplementing it with more implementation:
https://github.com/checkstyle/checkstyle/pull/17589

- Transitioned checkstyle's example class name check to TypeName check: 

https://github.com/checkstyle/checkstyle/pull/17596

- Recorded 2nd and 3rd drafts for fixing the module's problem from the issue description tutorial: https://github.com/checkstyle/checkstyle/issues/17404

- Removed site log anchor name warnings for annotation modules: 

https://github.com/checkstyle/checkstyle/pull/17607

[SteLeo]

Thursday, August 14 report

- Recorded and uploaded the final video drafts on how to solve the module's problem from the issue's description:
https://youtu.be/CoMKo1X5daU?si=DPFZjOFui-iGpOX3
https://youtu.be/VnenZbbh1WU?si=4zGmKXYLU9LSKd5H

- Continue to do mentor review for adding new filter validations:
https://github.com/checkstyle/checkstyle/pull/17589

- Continue to remove site log warnings about anchors being used more than once:

https://github.com/checkstyle/checkstyle/pull/17618
https://github.com/checkstyle/checkstyle/pull/17621
https://github.com/checkstyle/checkstyle/pull/17624

- Wrote documentation draft about testing techniques:
https://github.com/checkstyle/checkstyle/pull/17623

[SteLeo]

Monday, August 18 report

- Finished adding filters table validation:
https://github.com/checkstyle/checkstyle/pull/17589

- Completed wiki testing techniques tutorial page:
https://github.com/checkstyle/checkstyle/pull/17623

- United Filter and Checks validations:
https://github.com/checkstyle/checkstyle/pull/17639

- Added anchored links for each property:
https://github.com/checkstyle/checkstyle/pull/17652

- Finished removing site log warnings about anchors being used more than once:
https://github.com/checkstyle/checkstyle/pull/17627
https://github.com/checkstyle/checkstyle/pull/17628
https://github.com/checkstyle/checkstyle/pull/17640
https://github.com/checkstyle/checkstyle/pull/17641
https://github.com/checkstyle/checkstyle/pull/17647
https://github.com/checkstyle/checkstyle/pull/17648
https://github.com/checkstyle/checkstyle/pull/17649
https://github.com/checkstyle/checkstyle/pull/17650

[SteLeo]

Thursday, August 21 report

- Started working on creating xdoc generation project:
https://github.com/checkstyle/checkstyle/issues/13426
https://github.com/SteLeo1602/XdocGeneration

- Started reusing metadata module scrapper with xdocs, reproducing the PR: https://github.com/checkstyle/checkstyle/issues/13626

[SteLeo]

Monday, August 25 report

Analyzed the original PR, fixed the extraction of the module's description, and some other bugs with mentor review for reusing meta and xdocs to shrink module javadocs:
https://github.com/checkstyle/checkstyle/pull/17675

[SteLeo]

Thursday, August 28

Continue to work on utilizing Metadata and Xdoc to simplify module javadocs: https://github.com/checkstyle/checkstyle/pull/17675

[SteLeo]

Monday, September 1

Continue to work on utilizing Metadata and Xdoc to simplify module javadocs: https://github.com/checkstyle/checkstyle/pull/17675