Update: add ignoreComments option to indent rule (fixes #9018) (#…

…9752)

* Update: add `ignoreComments` option to `indent` rule (fixes #9018)

* Chore: Added basic tests for block comments

docs/rules/indent.md

@@ -84,7 +84,8 @@ This rule has an object option:
 * `"ObjectExpression"` (default: 1) enforces indentation level for properties in objects. It can be set to the string `"first"`, indicating that all properties in the object should be aligned with the first property. This can also be set to `"off"` to disable checking for object properties.
 * `"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.
-* `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.
+* `"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.
+* `"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:
 
@@ -641,6 +642,22 @@ bar();
 })
 ```
 
+### ignoreComments
+
+Examples of additional **correct** code for this rule with the `4, { "ignoreComments": true }` option:
+
+```js
+/*eslint indent: ["error", 4, { "ignoreComments": true }] */
+
+if (foo) {
+    doSomething();
+
+// comment intentionally de-indented
+    doSomethingElse();
+}
+```
+
+
 ## Compatibility
 
 * **JSHint**: `indent`

lib/rules/indent.js

@@ -600,6 +600,9 @@ module.exports = {
                                 pattern: ":exit$"
                             }
                         }
+                    },
+                    ignoreComments: {
+                        type: "boolean"
                     }
                 },
                 additionalProperties: false
@@ -638,7 +641,8 @@ module.exports = {
             ObjectExpression: 1,
             ImportDeclaration: 1,
             flatTernaryExpressions: false,
-            ignoredNodes: []
+            ignoredNodes: [],
+            ignoreComments: false
         };
 
         if (context.options.length) {
@@ -1457,6 +1461,12 @@ module.exports = {
                 },
                 "Program:exit"() {
 
+                    // If ignoreComments option is enabled, ignore all comment tokens.
+                    if (options.ignoreComments) {
+                        sourceCode.getAllComments()
+                            .forEach(comment => offsets.ignoreToken(comment));
+                    }
+
                     // Invoke the queued offset listeners for the nodes that aren't ignored.
                     listenerCallQueue
                         .filter(nodeInfo => !ignoredNodes.has(nodeInfo.node))

tests/lib/rules/indent.js

@@ -4774,6 +4774,28 @@ ruleTester.run("indent", rule, {
                 ]
             `,
             options: ["tab", { ArrayExpression: "first", ignoredNodes: ["CallExpression"] }]
+        },
+        {
+            code: unIndent`
+                if (foo) {
+                    doSomething();
+
+                // Intentionally unindented comment
+                    doSomethingElse();
+                }
+            `,
+            options: [4, { ignoreComments: true }]
+        },
+        {
+            code: unIndent`
+                if (foo) {
+                    doSomething();
+
+                /* Intentionally unindented comment */
+                    doSomethingElse();
+                }
+            `,
+            options: [4, { ignoreComments: true }]
         }
     ],
 
@@ -9199,6 +9221,46 @@ ruleTester.run("indent", rule, {
                 ignoredNodes: ["ExpressionStatement > CallExpression > FunctionExpression.callee > BlockStatement"]
             }],
             errors: expectedErrors([3, 4, 0, "Identifier"])
+        },
+        {
+            code: unIndent`
+                if (foo) {
+                    doSomething();
+
+                // Intentionally unindented comment
+                    doSomethingElse();
+                }
+            `,
+            output: unIndent`
+                if (foo) {
+                    doSomething();
+
+                    // Intentionally unindented comment
+                    doSomethingElse();
+                }
+            `,
+            options: [4, { ignoreComments: false }],
+            errors: expectedErrors([4, 4, 0, "Line"])
+        },
+        {
+            code: unIndent`
+                if (foo) {
+                    doSomething();
+
+                /* Intentionally unindented comment */
+                    doSomethingElse();
+                }
+            `,
+            output: unIndent`
+                if (foo) {
+                    doSomething();
+
+                    /* Intentionally unindented comment */
+                    doSomethingElse();
+                }
+            `,
+            options: [4, { ignoreComments: false }],
+            errors: expectedErrors([4, 4, 0, "Block"])
         }
     ]
 });