安装和配置Vega ESLint插件

​

先决条件

npm install --save-dev @amazon-devices/eslint-plugin-kepler jsonc-eslint-parser

​

配置插件

1. 更新.eslintrc配置文件的extends、plugins和overrides部分：
   {
      "extends": [
         "@react-native",
         "eslint:recommended",
         "plugin:@amazon-devices/eslint-plugin-kepler/kepler" // 添加扩展
      ],
      "plugins": [
         "@typescript-eslint",
         "@amazon-devices/kepler" // 纳入插件
      ],
      "overrides": [
         {
            "files": ["**/*.ts", "**/*.tsx"],
            "parser": "@typescript-eslint/parser",
            "parserOptions": {
               "project": "./tsconfig.json"
         },
         {
            "files": ["package.json"],
            "parser": "jsonc-eslint-parser" // 需要这个解析器来检查package.json
         }
      ]
   }
   
   插件配置包括：
   • performance - 仅限性能相关规则
   • system-distributed-libs - 仅限系统分布式库检查（package.json验证和导入信息标记）
   您可以同时启用performance和system-distributed-libs以达到相同的效果。
   module.exports = {
      plugins: ["@amazon-devices/eslint-plugin-kepler"],
      extends： [
         "plugin:@amazon-devices/eslint-plugin-kepler/performance",
         "plugin:@amazon-devices/eslint-plugin-kepler/system-distributed-libs"
      ],
   }
   
2. （可选）配置ESLint规则 （可选）按照ESLint的配置规则指南自定义lint规则。 有关Vega ESLint插件提供的规则，请参阅了解性能规则。
3. 在package.json中指定自定义格式化器：
   {
   "scripts": {
      :
      "lint": "eslint src test package.json --ext .ts,.tsx --format node_modules/@amazon-devices/eslint-plugin-kepler/dist/formatters/default.js",
      :
      }
   }
   
4. 运行linter：
   npm run lint
   
   您可以在控制台上看到结果： linter还会生成一个HTML报告： 在悬停于代码上方时，您可以在VS Code上查看这些linter警告：

​

了解性能规则

​

了解系统分布式库规则

​

（可选）配置语义化版本规范

• 仅限修补程序模式 (semverGuidance: "patch")：使用~前缀限制对修补程序的更新。
• 次要模式和修补程序模式 (semverGuidance: "minor")：允许使用^前缀的小更新。
• 自动模式 (semverGuidance: "auto")：根据项目存储库中的项目签名检测设置。这是默认设置。

module.exports = {
  plugins: ["@amazon-devices/eslint-plugin-kepler"],
  rules: {
    "@amazon-devices/kepler/sdl-package-version-check": [
      "error",
      { semverGuidance: "patch" },
    ], // auto是默认值
    "@amazon-devices/kepler/sdl-package-version-check-imports": [
      "warn",
      { semverGuidance: "patch" },
    ],
  },
};

​

（可选）配置VS Code进行JSON验证

"eslint.validate": [
    "javascript",
    "javascriptreact",
    "typescript",
    "typescriptreact",
    // 在下面添加一行
    "json"
  ],
  "eslint.probe": [
    "javascript",
    "javascriptreact",
    "typescript",
    "typescriptreact",
    // 在下面添加一行
    "json"
  ],

​

相关主题

• ESLint官方文档（仅提供英文版）