[XL] Change in dart/sdk[main]: Add documentation for most of the errors and warnings in analysis opt...
Brian Wilkerson (Gerrit)
New activity on the change![]( "Open in Gerrit")
Related details
- Samuel Rawlins
Code-Owners
Code-Review
Review-Enforcement
| Inspect html for hidden footers to help with email filtering. To unsubscribe visit settings. |
Samuel Rawlins (Gerrit)
Samuel Rawlins voted and added 2 comments![]( "Open in Gerrit")
Votes added by Samuel Rawlins
| Code-Review | +1 |
2 comments
Thanks for these additional 600 lines of documentation! Huge benefit!
"The URI 'analysis_options.yaml' included in "Thanks for these improvements!
Related details
- Brian Wilkerson
Code-Owners
Code-Review
Review-Enforcement
| Inspect html for hidden footers to help with email filtering. To unsubscribe visit settings. |
Connie Ooi (Gerrit)
Connie Ooi added 21 comments![]( "Open in Gerrit")
The following code produces this diagnostic because the included file
isn't valid YAML (the `analyzer` section has two `enable-experiment` keys
in the same map):"The following code produces this diagnostic because the included file isn't valid YAML: the `analyzer` map contains duplicate `enable-experiment` keys."
If the file is intended to be included, then change the content of the
included file to be valid YAML:
"If the file is intended to be included, then correct the included file to be valid YAML:"
Change the content of the file to be valid YAML:"Correct the file to be valid YAML:"
The analyzer produces this diagnostic when an option used in an analysis
options file is deprecated.
"The analyzer produces this diagnostic when an option in an analysis options file is deprecated."
If there's a new way to specify the same information, then update the file
to use the new way:"If a replacement option or format exists, update the file to use it:"
If there isn't a new way to specify the same information, then remove the
option."If no replacement is available, remove the deprecated option."
The analyzer produces this diagnostic when a lint rule is enabled when the
rule is deprecated and should no longer be used.
"The analyzer produces this diagnostic when an enabled lint rule is deprecated."
If there's a replacement for the rule, then enable the new lint rule:"If a replacement rule exists, enable it:"
If there isn't a replacement for the rule, then remove the deprecated lint
rule from the list:"If no replacement rule exists, remove the deprecated lint rule from the list:"
The analyzer produces this diagnostic when an analysis options file
contains an `include` key, and the included URI either can't be resolved
or the file doesn't exist.
"The analyzer produces this diagnostic when an `include` key in an analysis options file specifies a URI that either can't be resolved or doesn't exist."
If the URI is incorrect, replace the URI with a URI that exists:"If the URI is incorrect, replace it with a correct URI:"
If the URI is correct but the package isn't a dependency, then add a
dev-dependency to the package in the `pubspec.yaml` file and run either
`dart pub get` or `flutter pub get`."If the URI is correct but the package isn't a dependency, add a dev_dependency for the package to the `pubspec.yaml` file and run `dart pub get` or `flutter pub get`."
If you want to specify the option, then provide a valid value for it:If you specify the option, provide a valid value for it.
If you don't need to specify the option, then remove it:If you don't need the option, remove it.
The analyzer produces this diagnostic when an analysis options file
contains a section (key) and the content of that section is not the
expected format, such as having a list where a map is expected.The analyzer produces this diagnostic when an analysis options file contains a configuration section (key) whose content is not in the expected data structure or format. This occurs when the configuration requires a map but is provided a list.
Given a file named `analysis_options.yaml` in a directory below the root
directory of a package, the following code produces this diagnostic
because it defined plugins:Given an `analysis_options.yaml` file located in a subdirectory of the package root, the following code produces this diagnostic because it attempts to define plugins there:
The analyzer produces this diagnostic when an analysis options file
enables a lint that isn't defined.
The analyzer produces this diagnostic when an analysis options file attempts to enable a lint rule that is not defined
If there is no lint like the one being flagged, then remove the undefined
lint:If there is no lint corresponding to the flagged entry, then remove the undefined lint:
If there is a supported option that was intended to be used, then replace the unsupported option with the supported one:If you intended to use a supported option, then replace the unsupported option with the supported one.
If there is no option for what you're trying to accomplish, then remove the unsupported option:If no option exists for your intended purpose, then remove the unsupported option:
If there is a valid value that specifies the intended behavior, then
replace the unsupported value with it:If a valid value specifies the intended behavior, then replace the unsupported value with it:
Related details
- Brian Wilkerson
Code-Owners
Code-Review
Review-Enforcement
| Inspect html for hidden footers to help with email filtering. To unsubscribe visit settings. |