False Positive "include_file_not_found"

[RohitSaily]

Dart SDK version: 3.7.0-209.1.beta (beta) (Tue Dec 3 23:59:04 2024 -0800) on "macos_x64"

Including analysis options from another file can lead to an "include_file_not_found" error, even though the file is actually found and the options are included as expected. This issue occurs when the included path is quoted (whether using single or double quotes).

Expectation

When including analysis options from a file which definitely exists, the "analysis_options.yaml" file:

include: 'package:lints/recommended.yaml'

should function identically to:

include: package:lints/recommended.yaml

and:

include: "package:lints/recommended.yaml"

Reproduction

A Dart package with the following files can be constructed to reproduce this issue. This reproduction demonstrates that inclusion works, while the "include_file_not_found" error is still reported.

pubspec.yaml:

name: 'lint_test'
publish_to: 'none'
environment:
      sdk: '^3.7.0-209.1.beta'
dev_dependencies:
      lints: '^5.1.1'

analysis_options.yaml:

include: 'package:lints/recommended.yaml'

main.dart:

void main()=>
	null;

The error "include_file_not_found" is reported but the lint rule "avoid_returning_null_for_void" from the included file is enforced, indicating that the file was found.

[pankajc2005]

@RohitSaily Can i work on this issue ?

[RohitSaily]

Hey @pankajc2005, I would be happy to work on this with you! It will give me a great opportunity to learn more about the codebase and contributing patches. Let us continue the discussion elsewhere to allow this thread to focus on the issue itself.

You can find preferred communication channels updated at rohitsaily.com. Reach out to me once you are ready to get started!

[RohitSaily]

Incidentally, the bug prevents a "recursive_include_file" error from being reported when a file includes itself with a quoted "include" field value.

See Fix: False Positive "include_file_not_found" for a proposed fix and additional discussion.

[RohitSaily]

Fixed by cc5612e.