Questions about new indent rule behavior in regards to comments

Tell us about your environment

• ESLint Version: Master
• Node Version: 6.x
• npm Version: 4.x

What parser (default, Babel-ESLint, etc.) are you using? Espree

Please show your full configuration:

{
  "rules": {
    "indent": ["error", 2]
  }
}

What did you do? Please include the actual source code causing the issue. Noticed an inconsistency with how comments are handled by the new indent rule

What did you expect to happen? For this to pass:

function foo() {
  if (true) {
    // some comment
  }
}

And for these to not:

function foo() {
  if (true) {
// some comment
  }
}

function foo() {
  if (true) {
  // some comment
  }
}

What actually happened? Please include the actual, raw output from ESLint. Both the following code snippets do not throw an error with the above configuration:

function foo() {
  if (true) {
    // some comment
  }
}

function foo() {
  if (true) {
  // some comment
  }
}

However, the following example does:

function foo() {
  if (true) {
// some comment
  }
}

/Users/cataldo/Code/test/eslint-test/index.js
  3:1  error  Expected indentation of 4 spaces but found 0  indent

I think there are two issues at play here:

• I believe the error message is correct, and that it should enforce for 4 spaces with the above code snippet
• It’s confusing that the error message expects 4 spaces but is satisfied with 2 spaces

[kaicataldo]

The problem I’m trying to solve is that I’ve enabled the new rule in our codebases at work and am able to fix everything but comments. Manually going through and fixing a PR that has +3,978 −3,991 changes is difficult.

I wonder if we could make the rule smarter by saying that it’s safe to assume the comment should be indented if it’s at the top of a block?

I have a lot of instances where the following:

function foo() {
  return bar
  .then((baz) => {
    // some comment
    return qux(baz);
  }
}

get autofixed to:

function foo() {
  return bar
    .then((baz) => {
    // some comment
      return qux(baz);
    }
}

It seems like a safe assumption that the comment should also be indented, but maybe I’m missing something here!

Edit: Also wanted to mention that the new indent rule is great! Having it not do crazy things when autofixing is amazing 🎉

Edit 2: Fixed a typo in the example

[not-an-aardvark]

@yairEO This is working as intended. If you’d like a version of the indent rule that is less strict and ignores comments, you can use the indent-legacy rule.