Skip to content

Docs: Improve documentation for indent rule#14168

Merged
mdjermanovic merged 5 commits intoeslint:masterfrom
srknzl:documentation-indent-rule-improvements-about-ignored-nodes
Mar 11, 2021
Merged

Docs: Improve documentation for indent rule#14168
mdjermanovic merged 5 commits intoeslint:masterfrom
srknzl:documentation-indent-rule-improvements-about-ignored-nodes

Conversation

@srknzl
Copy link
Copy Markdown
Contributor

@srknzl srknzl commented Mar 3, 2021

Prerequisites checklist

What is the purpose of this pull request? (put an "X" next to an item)

[x] Documentation update
[ ] Bug fix (template)
[ ] New rule (template)
[ ] Changes an existing rule (template)
[ ] Add autofixing to a rule
[ ] Add a CLI option
[ ] Add something to the core
[ ] Other, please explain:

What changes did you make? (Give an overview)

Currently, all the options in indent rule except SwitchCase, FunctionDeclaration.body and FunctionExpression.body can be set to "off" to disable checking.

I was setting up linting for one of my projects and I wanted to enable indent rule for just CallExpression option. After adding indent rule to eslint configuration file, default values for all options in indent rule are enabled. So, they are needed to be disabled explicitly.

I disabled all the options except the ones above as they don't have "off" option. I could not understand how I can disable them. I think the description in ignoredNodes option is hard to see and understand because it is close to last option and it does not clearly say it can be used to disable any of options.

My changes:

  • Move ignoredNodes option to top to make it easier to see.
  • Change ignoredNodes option's description to point out that it can be used to disable any option in indent rule.

Is there anything you'd like reviewers to focus on?

No

Loading
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

accepted There is consensus among the team that this change meets the criteria for inclusion archived due to age This issue has been archived; please open a new issue for any further discussion documentation Relates to ESLint's documentation rule Relates to ESLint's core rules

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants