Skip to content

[analyzer plugins] Plugin-reported diagnostics should be ignorable inline #59647

Closed
@srawlins

Description

@srawlins

The design we've roughly landed on is that // ignore: and // ignore_for_file: comments will supported for plugin-defined diagnostics (lints and warnings) via a plugin-namespaced name:

// ignore: foo.bar

This will direct the analyzer plugin tooling to ignore a report of the bar diagnostic from the foo plugin.

Notice the period (.) delimiter. We discussed also the : delimiter, but that looks confusing with ignore:, especially since there does not need to be whitespace after ignore: (e.g. // ignore:foo:bar). We also considered /, which I believe tslint uses, something like // ignore: foo/bar. We decided that the period looks the most "darty," being reminiscent of property access, like "the bar diagnostic of the foo plugin."

Metadata

Metadata

Assignees

Labels

P2A bug or feature request we're likely to work ondevexp-pluginlegacy-area-analyzerUse area-devexp instead.type-enhancementA request for a change that isn't a bug

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions