Add reference in documentation for each rule to suppress or adjust `.editorconfig` - Githubissues

pinterest / ktlint

An anti-bikeshedding Kotlin linter with built-in formatter

https://pinterest.github.io/ktlint/

MIT License

6.06k stars 504 forks source link

Add reference in documentation for each rule to suppress or adjust `.editorconfig` #2705

Closed paul-dingemans closed 1 week ago

paul-dingemans commented 1 week ago

Description

Add reference in documentation for each rule to suppress or adjust .editorconfig

Display an annotation for each rule id containing code fragments to:

suppress the rule via an annotation
enable the rule in .editorconfig
disable the rule in .editorconfig Each of code fragments above contains a "copy to clipboard" button.

The solution now looks as follows:

Checklist

Before submitting the PR, please check following (checks which are not relevant may be ignored):

[X] Commit message are well written. In addition to a short title, the commit message also explain why a change is made.
[ ] At least one commit message contains a reference Closes #<xxx> or Fixes #<xxx> (replace<xxx> with issue number)
[ ] Tests are added
[ ] KtLint format has been applied on source code itself and violations are fixed
[ ] PR title is short and clear (it is used as description in the release changelog)
[ ] PR description added (background information)

Documentation is updated. See difference between snapshot and release documentation

[X] Snapshot documentation in case documentation is to be released together with a code change
[X] Release documentation in case documentation is related to a released version of ktlint and has to be published as soon as the change is merged to master