Add an option to not include line and column numbers in lint baseline [269759189]

Fixed

Feature Request

Status Update

No update yet.

Description

au...@google.com

created issue #1

Feb 17, 2023 05:58PM

Today, running updateLintBaselines adds line and column numbers to the baseline xml file. For projects that have upstream and downstream branches that automerge, this is problematic as it leads to merge conflicts if baselines are updated out of band. Lint can already run just fine without line and column numbers in the baseline file - it fuzzy matches.

This is a feature request for Android Gradle Plugin to do this for us. AndroidX currently has a task that intercepts the xml and does this rewrite and we'd like to drop that hack.

Comments

ha...@google.com <ha...@google.com> Feb 21, 2023 07:11PM

Assigned to an...@google.com.

au...@google.com <au...@google.com> #2Feb 22, 2023 10:59PM

gharrma@ do you think this is a reasonable FR?

pa...@google.com <pa...@google.com> #3Feb 23, 2023 04:54PM

Status: New

Tentatively raising to a P1 FR, as I think it would be easy to add on the lint side.

au...@google.com <au...@google.com> #4Apr 4, 2023 07:58PM

Any updates here?

gh...@google.com <gh...@google.com> #5Apr 4, 2023 08:43PM

Assigned to pa...@google.com.

Paul, is this something you could look at give that you have been working on baselines recently?

pa...@google.com <pa...@google.com> #6Apr 5, 2023 09:33AM

Yes, sounds good.

au...@google.com <au...@google.com> #7May 1, 2023 09:35PM

Any updates on this?

au...@google.com <au...@google.com> #8May 23, 2023 04:58PM

paulthomson@ is there something I can help with to get this in?

pa...@google.com <pa...@google.com> #9May 23, 2023 05:07PM

Reassigned to sp...@google.com.

Sorry for the delay. ag/22509882 was merged, so there is now a Lint command line flag --baseline-omit-line-numbers.

spollom@google.com: would you or somebody familiar with AGP be able to add a way to activate this from AGP? If not, feel free to assign back to me, and I can try; if assigned back to me, is ag/17112268 still a good example for adding a BooleanOption? If yes, what is the deal with protos/src/main/proto/analytics_enums.proto?

sp...@google.com <sp...@google.com> #10May 23, 2023 05:23PM

is ag/17112268 still a good example for adding a BooleanOption?

Instead of a BooleanOption, should AGP just always use --baseline-omit-line-numbers?

pa...@google.com <pa...@google.com> #11May 23, 2023 05:32PM

Hmm, good question. My instinct is that it should probably be an option because most users will probably appreciate being able to understand where baselined issues have come from (which specific line in a file) given a freshly generated baseline file. In particular, multiple "identical" issues that occur within one file can look a bit strange when are no line numbers to disambiguate. I could be wrong here, though; perhaps nobody really looks at baseline files, or perhaps most users don't use them at all. I also assume that a lot of users (especially for smaller codebases) are not worried about merging branches that contain (regenerated) baseline files. aurimas@ might have an opinion on whether the situation is likely to occur in other codebases.

au...@google.com <au...@google.com> #12May 23, 2023 05:36PM

We dont need baseline numbers because we maintain downstream branches that make it super painful of the line numbers are included as it causes continuous merge conflicts. I suspect most users dont have such set up, and might prefer line numbers as suggested in #11

sp...@google.com <sp...@google.com> #13May 26, 2023 03:19PM

Marked as fixed.

You can set android.lint.baselineOmitLineNumbers=true starting in AGP 8.2.0-alpha07.