Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document that multiple files can be included in analysis options, in analyzer 3.7 maybe #6174

Open
srawlins opened this issue Oct 28, 2024 · 2 comments
Assignees
Labels
d.enhancement Improves docs with specific ask e1-hours Can complete in < 8 hours of normal, not dedicated, work p3-low Valid but not urgent concern. Resolve when possible. Encourage upvote to surface. t.diagnostics Relates to diagnostics, analysis, or linting of code

Comments

@srawlins
Copy link
Member

The analyzer will start recognizing a list of included analysis options, where it currently supports including a single file. See dart-lang/sdk#47256

E.g.

include:
  - one.yaml
  - ../../two.yaml
  - package:foo/three.yaml

The "Customizing static analysis" page doesn't mention "include" a lot, or specify it. So we've got a blank slate to start at :D. We can specify how a chain, or directed graph, of "includes" works.

@parlough parlough added p2-medium Necessary but not urgent concern. Resolve when possible. t.diagnostics Relates to diagnostics, analysis, or linting of code d.enhancement Improves docs with specific ask p3-low Valid but not urgent concern. Resolve when possible. Encourage upvote to surface. st.blocked Issue cannot continue until another action completes e1-hours Can complete in < 8 hours of normal, not dedicated, work and removed p2-medium Necessary but not urgent concern. Resolve when possible. labels Oct 28, 2024
@srawlins
Copy link
Member Author

@parlough is this something I can start working on now? Dart 3.6 isn't out yet, but this feature is available starting with Dart 3.7... Is there an example of wording like this?

@parlough
Copy link
Member

I'd recommend a new section that focuses on include and starting with an example including a single file. Then a second part of that section can discuss multiple files, and that section could end with a version note similar to the following:

:::version-note
Support for including multiple files was added in Dart 3.7.
:::

@parlough parlough removed the st.blocked Issue cannot continue until another action completes label Oct 31, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
d.enhancement Improves docs with specific ask e1-hours Can complete in < 8 hours of normal, not dedicated, work p3-low Valid but not urgent concern. Resolve when possible. Encourage upvote to surface. t.diagnostics Relates to diagnostics, analysis, or linting of code
Projects
None yet
Development

No branches or pull requests

2 participants