Custom lint breaks when analysis_options.yaml is not at package root

[Clavum]

If a package has additional analysis_options.yaml files that are not at the root of the package, then custom lint will attempt to read a pubspec.yaml at the same location as the analysis options. The pubspec doesn't exist, and custom lint fails to start.

Example:

my_package
  lib
    ...
  test
    analysis_options.yaml
    ...
  analysis_options.yaml
  pubspec.yaml

Custom lint expects there to be a pubspec.yaml with every options file, and will throw the error:
PathNotFoundException: Cannot open file, path = 'project/path/my_package/test/pubspec.yaml' (OS Error: No such file or directory, errno = 2)

A PR was made to fix this several months ago, but was eventually abandoned.
#19

[rrousselGit]

That's not the behavior I've seen.
Do you mind making a quick github repository showcasing the problem, just so that we're on the same page?

I have multiple projects with a root analysis_options but no associated pubspec, and custom_lint works just fine on them.

[Clavum]

So I tried to make a minimal reproducible example, and yet for some reason it was not having the issue either. I kept trying to make it more similar to my package that isn't working (same Dart lints, structure, everything) but to no avail. I think the only difference between them at this point is the number of files/lines of code, and length of time they've existed...

Have any ideas what could cause it? I suppose when I get another chance to look into it I can clone and debug custom_lint myself.

[Clavum]

Looking into this a little bit right now.

For the package having issues, allContextRoots on line 178 of custom_lint/src/workspace.dart has two context roots, including the test folder.

For the package not having issues, allContextRoots has only a single context.

Seems pretty relevant to the issue. I'll continue to debug.

[Clavum]

Kinda embarrassing, but when trying to make the minimal reproducible example, I mistyped analysis_options.yaml in the test folder so I effectively only had one real options file in the project. After fixing it, I do get the error I initially reported. So, here's the example you asked for.

https://github.com/Clavum/lint_bug_example

[TimWhiting]

I can confirm this breaks it.

[rrousselGit]

TIL that we can put analysis_options.yamls inside the project instead of above it.Pretty sure I tried that before and it didn't work.

Fair enough then, this does need testing indeed

[Clavum]

@rrousselGit @TimWhiting Thanks for the progress made on the PR so far! It looks like it hasn't been touched for a few months now though. Is there any more progress being made? This seems like a significant issue because it entirely prevents the use of custom lint in some projects, which includes mine.

[TimWhiting]

Sorry, I've been out of the loop as far as this project goes. I'm unaware of what has changed as far as how custom_lint resolves packages since I last worked on the PR, but it looks like a lot has changed. Feel free to rebase the PR on the main branch and take over it if it is blocking you. I'm no longer actively working on it.

[bartekpacia]

I also experienced this problem when setting up custom_lint in Patrol repository. Here's the repro:

leancodepl/patrol#1947

[mrgnhnt96]

@rrousselGit I think that this may have regressed lately, my nested analysis options files are not being respected anymore, I jumped from version 0.5.11 to 0.6.4. Any idea what might have caused this?

[mrgnhnt96]

Actually, this is also happening with the 0.5.11 version as well. I did change flutter versions from 3.19.6 to 3.22.2. Perhaps there was a change in analyzer to make this act this way?