如何将 ESLInt 自定义规则目录添加到 VSCode

Question

我正在使用 ESLint 插件运行 VSCode。 我的项目包含一些自定义规则，它们位于特定目录中。

如果我从命令行运行 ESLint 并传入--rulesdir=./custom-eslint-rules一切都按预期工作。

但是，我特别指的是编辑器本身中每个文件发生的 linting。 在那里，它使用正常规则进行检查，但显示错误，我的自定义规则的定义丢失了。

我如何配置 VSCode，以便每个文件 linting 看到我在特定目录中的自定义规则定义？

Answer 1

在您的 setting.json 中：

"eslint.options": {
  "rulePaths": "<path>"
}

参考： https : //eslint.org/docs/developer-guide/nodejs-api#cliengine

Answer 2

有没有办法传递额外的参数来忽略我的自定义规则目录中的某些文件。 就我而言，我在与自定义规则相同的目录中有测试文件（.spec.js）。 我想忽略eslint.options.rulePaths这个测试文件。

Answer 3

编写自己的 eslint 插件并使用它与 vs 代码兼容

1. 安装eslint-plugin-rulesdir@0.2.1

yarn add --dev eslint-plugin-rulesdir@0.2.1

2. 添加到.eslintrc.js

进口

const rulesDirPlugin = require("eslint-plugin-rulesdir");
rulesDirPlugin.RULES_DIR = "src/rules"; // it is example

插件

plugins: [...,"rulesdir"]

规则

rules: {
  ...,
  "rulesdir/no-get-payments": "error"
}

3. 创建规则文件 src/rules/no-get-payments.js

module.exports = {
  create: function (context) {
    return {
      CallExpression: function (node) {
        if (node.callee.name === "getPayments") {
          context.report({
            node: node,
            message: "getPayments is depricated! ",
          });
        }
      },
    };
  },
};