spotbugs / spotbugs-maven-plugin

Maven Mojo Plug-In to generate reports based on the SpotBugs Analyzer
https://spotbugs.github.io/spotbugs-maven-plugin/
Apache License 2.0
69 stars 51 forks source link

Add support to load onlyAnalyze classes/packages from specified file. #635

Closed Rahul-khandelwal closed 6 months ago

Rahul-khandelwal commented 7 months ago

Use Case

When adding spotbugs to a large project, no every file can be fixed at once. In the gradual process of fixing all files, onlyAnalyze is a good tool to include selected files at very beginning of analysis.

Current implementation of parsing onlyAnalyze can't read classes/packages from file.

Having all classes/packages in pom.xml introduces a lot of boiler plate into pom file.

So it makes sense to have onlyAnalyze support for reading classes/packages from file(s).

Changes

Add support to load onlyAnalyze classes/packages from specified file.

Excluded txt files for licensing.

Rahul-khandelwal commented 7 months ago

@hazendaz I am not able to test negative scenario in my implementation. Every time newly introduced test onlyAnalyzeFileSource completed successfully. It would be great if you can point me to how to verify or if I am missing something.

hazendaz commented 7 months ago

@Rahul-khandelwal Approved to run, will have to look at later, most likely this would be introduced sometime after spotbugs 4.8.0 is released.

Rahul-khandelwal commented 7 months ago

Sure @hazendaz , Please have a look when possible. Also let me know if I am missing something in testing. It looks like all checks have passed except for 3 which failed while setting up JDK-21 ea, looks to be some unrelated issue. I am marking the PR ready for review as well.

hazendaz commented 7 months ago

note: switched to master branch as target. Moving entire repo back to 'master'. The original split was due to upstream repo but its since retired and points here. So rather than have a one-off in spotbugs or for that matter in most repos, moving back to 'master'. Thanks.

hazendaz commented 6 months ago

Thanks @Rahul-khandelwal .

Rahul-khandelwal commented 6 months ago

@hazendaz Thanks for merging. could you tell me any tentative dates for next release starting when I can use this feature?

hazendaz commented 6 months ago

It's out now

Sent from my Verizon, Samsung Galaxy smartphone Get Outlook for Androidhttps://aka.ms/AAb9ysg


From: Rahul-khandelwal @.> Sent: Tuesday, November 7, 2023 4:49:40 AM To: spotbugs/spotbugs-maven-plugin @.> Cc: Jeremy Landis @.>; Mention @.> Subject: Re: [spotbugs/spotbugs-maven-plugin] Add support to load onlyAnalyze classes/packages from specified file. (PR #635)

@hazendazhttps://github.com/hazendaz Thanks for merging. could you tell me any tentative dates for next release starting when I can use this feature?

— Reply to this email directly, view it on GitHubhttps://github.com/spotbugs/spotbugs-maven-plugin/pull/635#issuecomment-1798157312, or unsubscribehttps://github.com/notifications/unsubscribe-auth/AAHODIYQ2L2V5HYQKTQNH2DYDH73JAVCNFSM6AAAAAA5FBCT52VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTOOJYGE2TOMZRGI. You are receiving this because you were mentioned.Message ID: @.***>

hazendaz commented 6 months ago

Released in 4.8.0.0 and 4.8.1.0