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

docs: explained rule fixers and suggestions #17657

Merged
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/src/_includes/components/rule-categories.macro.html
Expand Up @@ -21,7 +21,7 @@
<div class="rule-category">
<span class="rule-category__icon">💡 <span class="visually-hidden">hasSuggestions</span></span>
<p class="rule-category__description">
Some problems reported by this rule are manually fixable by editor <a href="../extend/custom-rules#providing-suggestions">suggestions</a>
Some problems reported by this rule are manually fixable by editor <a href="../use/core-concepts#report-suggestions">suggestions</a>
</p>
</div>
{%- endif -%}
Expand Down
14 changes: 14 additions & 0 deletions docs/src/use/core-concepts.md
Expand Up @@ -23,6 +23,20 @@ ESLint contains hundreds of built-in rules that you can use. You can also create

For more information, refer to [Rules](../rules/).

### Report Fixers

Rule reports may optionally provide "fixes" that safely correct the reported issue without changing application logic.
Fixes may be applied automatically with the [`--fix` command line option](https://eslint.org/docs/latest/use/command-line-interface#--fix) and via editor extensions.

Rules that may provide fixers are marked with 🔧 in [Rules](../rules/).
JoshuaKGoldberg marked this conversation as resolved.
Show resolved Hide resolved

### Report Suggestions

Rule reports may optionally provide "suggestions" that correct the reported issue but also change application logic.
Suggestions cannot be applied automatically, but may be applied manually via editor extensions.

Rules that may provide suggestions are marked with 💡 in [Rules](../rules/).
JoshuaKGoldberg marked this conversation as resolved.
Show resolved Hide resolved

## Configuration Files

An ESLint configuration file is a place where you put the configuration for ESLint in your project. You can include built-in rules, how you want them enforced, plugins with custom rules, shareable configurations, which files you want rules to apply to, and more.
Expand Down