Linter should not be referred to as a 'plugin'

srawlins commented 1 year ago

Page URL

https://dart.dev/guides/language/analysis-options

Page source

No response

Describe the problem

The text currently reads:

You can also configure the linter, one of the analyzer’s plugins, to ensure that your code [...]

Since 'plugin' has a specific meaning in terms of the analyzer, and the linter is not an analyzer plugin, we should use a different term. We will start using the term 'plugin' as part of https://github.com/dart-lang/site-www/issues/2013.

Expected fix

So what word should we use? CC @bwilkerson @pq for thoughts. In many aspects we don't want to burden the users with any unnecessary distinction between the linter and the analyzer, but (for now) they are configured in different top-level sections (analyzer: vs linter:), so maybe it's best to keep the mention and just rewrite to avoid the word 'plugin'. Maybe "You can also configure linter rules, to ensure your code [...]" or similar...

Additional context

No response

srawlins commented 1 year ago

I'm happy to mail a PR if we land on some good text. :)

bwilkerson commented 1 year ago

I'm happy with your suggestion of "configure linter rules".

parlough commented 1 year ago

I like that too :)

srawlins commented 1 year ago

Other outdated text in this paragraph:

Dart tools such as the Dart compiler (dart compile), dart analyze, flutter analyze, and JetBrains IDEs use the analyzer package to evaluate your code.

I don't think dart compile in any way uses analysis_options.yaml.
JetBrains IDEs? Er... let's update that.

bwilkerson commented 1 year ago

The dart compile doesn't use the analyzer package. The rest do (though I agree that we should probably also mention VS Code).

dart-lang / site-www