Turborepo logo
API 参考

eslint-plugin-turbo

eslint-plugin-turbo 包 帮助你找到代码中使用的但未包含在 Turborepo 哈希中的环境变量。源代码中使用的未在 turbo.json 中声明的环境变量将在编辑器中高亮显示，并以 ESLint 输出错误的形式展示。

安装

将 eslint-config-turbo 安装到你的 ESLint 配置所在的目录

终端
npm i --save-dev eslint-config-turbo -w @acme/eslint-config

用法（扁平配置 eslint.config.js）

ESLint v9 使用如下所示的扁平配置格式

./packages/eslint-config/base.js
import turbo from 'eslint-plugin-turbo';
 
export default [turbo.configs['flat/recommended']];

或者，你可以在 rules 部分配置你想使用的规则。

./packages/eslint-config/base.js
import turbo from 'eslint-plugin-turbo';
 
export default [
  {
    plugins: {
      turbo,
    },
    rules: {
      'turbo/no-undeclared-env-vars': 'error',
    },
  },
];

示例（扁平配置 eslint.config.js）

./packages/eslint-config/base.js
import turbo from 'eslint-plugin-turbo';
 
export default [
  {
    plugins: {
      turbo,
    },
    rules: {
      'turbo/no-undeclared-env-vars': [
        'error',
        {
          allowList: ['^ENV_[A-Z]+$'],
        },
      ],
    },
  },
];

用法（旧版 eslintrc*）

将 turbo 添加到你的 .eslintrc 配置文件的 plugins 部分。你可以省略 eslint-plugin- 前缀

./packages/eslint-config/base.json
{
  "plugins": ["turbo"]
}

然后在 rules 部分配置你想使用的规则。

./packages/eslint-config/base.json
{
  "rules": {
    "turbo/no-undeclared-env-vars": "error"
  }
}

示例（旧版 eslintrc*）

./packages/eslint-config/base.json
{
  "plugins": ["turbo"],
  "rules": {
    "turbo/no-undeclared-env-vars": [
      "error",
      {
        "allowList": ["^ENV_[A-Z]+$"]
      }
    ]
  }
}

上一篇

eslint-config-turbo

下一篇

turbo-ignore

小时

总计节省计算时间
开始使用
远程缓存 →

本页内容