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.

Sign up for GitHub

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

Jump to bottom

Docs: Improve documentation for indent rule #14168

Merged
merged 5 commits into from Mar 11, 2021
Merged

Docs: Improve documentation for indent rule #14168

Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
d9d81ba
Docs: Improve documentation for indent regarding ignoredNodes
srknzl Mar 3, 2021
843df45
Docs: Add AST node description at the end of long description
srknzl Mar 9, 2021
0f3ebfe
add blank line
srknzl Mar 9, 2021
a9fa4a5
Add deleted sentence again to ignoredNodes
srknzl Mar 11, 2021
a7c50cf
move long description of indent to match short description pos
srknzl Mar 11, 2021
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
4 changes: 3 additions & 1 deletion docs/rules/indent.md
View file
Open in desktop
Expand Up @@ -68,6 +68,7 @@ if (a) {

This rule has an object option:

* `"ignoredNodes"` can be used to disable indentation checking for any AST node. This accepts an array of [selectors](/docs/developer-guide/selectors.md). If an AST node is matched by any of the selectors, the indentation of tokens which are direct children of that node will be ignored.
* `"SwitchCase"` (default: 0) enforces indentation level for `case` clauses in `switch` statements
* `"VariableDeclarator"` (default: 1) enforces indentation level for `var` declarators; can also take an object to define separate rules for `var`, `let` and `const` declarations. It can also be `"first"`, indicating all the declarators should be aligned with the first declarator.
* `"outerIIFEBody"` (default: 1) enforces indentation level for file-level IIFEs. This can also be set to `"off"` to disable checking for file-level IIFEs.
Expand All @@ -85,7 +86,6 @@ This rule has an object option:
* `"ImportDeclaration"` (default: 1) enforces indentation level for import statements. It can be set to the string `"first"`, indicating that all imported members from a module should be aligned with the first member in the list. This can also be set to `"off"` to disable checking for imported module members.
* `"flatTernaryExpressions": true` (`false` by default) requires no indentation for ternary expressions which are nested in other ternary expressions.
* `"offsetTernaryExpressions": true` (`false` by default) requires indentation for values of ternary expressions.
* `"ignoredNodes"` accepts an array of [selectors](/docs/developer-guide/selectors.md). If an AST node is matched by any of the selectors, the indentation of tokens which are direct children of that node will be ignored. This can be used as an escape hatch to relax the rule if you disagree with the indentation that it enforces for a particular syntactic pattern.
mdjermanovic marked this conversation as resolved.
Show resolved Hide resolved
* `"ignoreComments"` (default: false) can be used when comments do not need to be aligned with nodes on the previous or next line.

Level of indentation denotes the multiple of the indent specified. Example:
Expand Down Expand Up @@ -773,6 +773,8 @@ bar();
})
```

All AST node types can be found at [ESTree](https://github.com/estree/estree) specification. You can use [AST Explorer](https://astexplorer.net/) with the espree parser to examine AST tree of a code snippet.

### ignoreComments

Examples of additional **correct** code for this rule with the `4, { "ignoreComments": true }` option:
Expand Down