如何为 WebStorm 配置 eslint 缩进？

Question

如何在.eslintr.json 中设置"indent" 以匹配WebStorm 中使用的默认值？

到目前为止，我尝试过的所有东西都无法匹配the official documentation：

• "indent": ["error", 2] - 给了很多Expected indentation of 2 spaces but found 4
• "indent": ["error", 4] - 给了很多Expected indentation of 4 spaces but found 8
• "indent": ["error", 8] - 给了很多Expected indentation of 8 spaces but found 4

我完整的 eslint 配置：

{
  "env": {
    "es6": true,
    "node": true,
    "jasmine": true
  },
  "extends": "eslint:recommended",
  "parserOptions": {
  },
  "rules": {
    "no-else-return": "error",
    "no-multi-spaces": "error",
    "no-whitespace-before-property": "error",
    "camelcase": "error",
    "new-cap": "error",
    "no-console": "error",
    "comma-dangle": "error",
    "no-var": "error",
    "indent": ["error", 4],
    "quotes": [
      "error",
      "single"
    ],
    "semi": [
      "error",
      "always"
    ]
  }
}

在输入代码时，我总是使用Ctrl+Alt+L自动格式化代码，生成的代码格式化不符合任何eslint设置。

---

更新

如前所述，"indent": ["error", 4] 的代码示例：

对于此代码：（通过 Ctrl+Alt+L 格式化）

const a = 123;
switch (a) {
    case 1:
        return 1;
    case 2:
        return 2;
    case 3:
        return 3;
    default:
        break;
}

结果：

3:1  error  Expected indentation of 0 spaces but found 4
4:1  error  Expected indentation of 4 spaces but found 8
5:1  error  Expected indentation of 0 spaces but found 4
6:1  error  Expected indentation of 4 spaces but found 8
7:1  error  Expected indentation of 0 spaces but found 4
8:1  error  Expected indentation of 4 spaces but found 8
9:1  error  Expected indentation of 0 spaces but found 4
10:1  error  Expected indentation of 4 spaces but found 8

示例 2

obj.format('text', {
        value: '${two}'
    }
);

结果：

2:1   error  Expected indentation of 4 spaces but found 8
3:1   error  Expected indentation of 0 spaces but found 4

示例 3

return begin()
    .then(() => {
            return callback()
                .then(data => {
                    success = true;
                    return commit();
                }, reason => {
                    return rollback();
                })
        },
        function (reason) {
            update(false, false, reason);
            return $p.reject(reason);
        });

结果：

3:1   error  Expected indentation of 8 spaces but found 12
4:1   error  Expected indentation of 12 spaces but found 16
5:1   error  Expected indentation of 16 spaces but found 20
6:1   error  Expected indentation of 16 spaces but found 20
7:1   error  Expected indentation of 12 spaces but found 16
8:1   error  Expected indentation of 16 spaces but found 20
9:1   error  Expected indentation of 12 spaces but found 16
10:1   error  Expected indentation of 4 spaces but found 8
11:1   error  Expected indentation of 4 spaces but found 8
12:1   error  Expected indentation of 8 spaces but found 12
13:1   error  Expected indentation of 8 spaces but found 12
14:1   error  Expected indentation of 4 spaces but found 8

Answer 1

Switch-Case 似乎是 eslint 关于缩进的一个特例。默认情况下，case 子句不相对于switch 缩进：

"SwitchCase" (默认: 0) 强制 case 子句的缩进级别 在 switch 语句中

查看示例：http://eslint.org/docs/rules/indent#switchcase

您需要将SwitchCase 选项设置为 1，如下所示：

"indent": [
    "error", 
    4, 
    {"SwitchCase": 1}
]

所以你完整的 eslint 配置现在看起来像这样：

{
    "env": {
        "es6": true,
        "node": true,
        "jasmine": true
    },
    "extends": "eslint:recommended",
    "parserOptions": {
    },
    "rules": {
        "no-else-return": "error",
        "no-multi-spaces": "error",
        "no-whitespace-before-property": "error",
        "camelcase": "error",
        "new-cap": "error",
        "no-console": "error",
        "comma-dangle": "error",
        "no-var": "error",
        "indent": ["error", 4, {"SwitchCase": 1}],
        "quotes": [
            "error",
            "single"
        ],
        "semi": [
            "error",
            "always"
        ]
    }
}

关于你的第二个例子，我认为这样写是很常见的：

obj.format('text', {
    value: '${two}'
});

两个括号都在同一行打开，因此您将它们关闭在同一行。如果您在该行上使用自动格式，它们将不会改变。

第三个例子看起来有点棘手。我不知道您是否可以在同一页面上获得 eslint 和自动格式。我个人更喜欢 eslint 方式，但我不知道你是否可以调整自动格式来做到这一点。

编辑：你可以这样写：

return begin()
    .then(() => callback()
        .then(data => {
            success = true;
            return commit();
        }, reason => {
            return rollback();
        }),
        function(reason) {
            update(false, false, reason);
            return $p.reject(reason);
        });

Answer 2

我已经通过将缩进配置添加到文件 .eslintrc.js

来修复它

module.exports = {
    "rules": {
        "indent": ["error", 4]
    }
};

Answer 3

由于WebStorm 格式，您似乎收到了错误。

---

解决方案

在webstorm:

• File -> Setting
• 转到Editor -> Code Style -> HTML
• 在Do not indent children of中，添加标签script。
• 然后再次格式化源代码。

那么错误应该消失了。

---

屏幕截图：