noUndeclaredEnvVars

JavaScript (and super languages)

摘要

¥Summary

规则生效日期：v2.3.10

¥Rule available since: v2.3.10
诊断类别：lint/nursery/noUndeclaredEnvVars

¥Diagnostic Category: lint/nursery/noUndeclaredEnvVars
此规则没有修复方案。

¥This rule doesn’t have a fix.
此规则的默认严重级别为 warning。

¥The default severity of this rule is warning.
此规则属于以下域：

¥This rule belongs to the following domains:
- turborepo
来源：

¥Sources:
- 与 turbo/no-undeclared-env-vars 相同
  
  ¥Same as turbo/no-undeclared-env-vars

如何配置

¥How to configure

1
{
2
  "linter": {
3
    "rules": {
4
      "nursery": {
5
        "noUndeclaredEnvVars": "error"
6
      }
7
    }
8
  }
9
}

描述

¥Description

禁止使用未声明的环境变量。

¥Disallow the use of undeclared environment variables.

在 Turborepo 项目中，任务中使用的环境变量必须在 turbo.json(c) 配置文件中声明，以确保正确的缓存行为。使用未声明的环境变量可能会导致缓存命中错误和构建行为不可预测。

¥In Turborepo projects, environment variables used in tasks must be declared in the turbo.json(c) configuration file to ensure proper caching behavior. Using undeclared environment variables can lead to incorrect cache hits and unpredictable build behavior.

此规则检查 process.env.VAR_NAME 和 import.meta.env.VAR_NAME 访问，并根据以下内容进行验证：

¥This rule checks for process.env.VAR_NAME and import.meta.env.VAR_NAME accesses and validates them against:

在 turbo.json(c)（globalEnv、globalPassThroughEnv、任务级 env 和任务级 passThroughEnv）中声明的环境变量

¥Environment variables declared in turbo.json(c) (globalEnv, globalPassThroughEnv, task-level env, and task-level passThroughEnv)
在规则的 allowedEnvVars 选项中指定的环境变量

¥Environment variables specified in the rule’s allowedEnvVars option
默认允许的变量（常用系统变量和框架特定模式）

¥Default allowed variables (common system vars and framework-specific patterns)

默认允许变量

¥Default Allowed Variables

以下环境变量始终允许使用，无需显式声明：

¥The following environment variables are always allowed without explicit declaration:

系统变量：

¥System variables:

CI, HOME, PATH, PWD, SHELL, TZ, USER

Node.js：

NODE_ENV

框架和提供程序特定模式（所有匹配这些前缀的变量）：

¥Framework and provider-specific patterns (all variables matching these prefixes):

NEXT_PUBLIC_*（Next.js）
VITE_*（Vite）
REACT_APP_*（Create React App）
VUE_APP_*（Vue CLI）
NUXT_*（Nuxt）
GATSBY_*（Gatsby）
EXPO_PUBLIC_*（Expo）
VERCEL、VERCEL_* (Vercel)

示例

¥Examples

无效

¥Invalid

当 MY_VAR 未在 turbo.json 或允许列表中声明时：

¥When MY_VAR is not declared in turbo.json or the allowed list:

1
const value = process.env.MY_VAR;

有效

¥Valid

1
// NODE_ENV is always allowed
2
const value = process.env.NODE_ENV;

选项

¥Options

使用以下选项指定未在 globalEnv、globalPassThroughEnv 或 turbo.json 中的任务级 env/passThroughEnv 中声明的其他环境变量。支持正则表达式模式（锚点 ^ 和 $ 是隐式的）。

¥Use the options to specify additional environment variables that are not declared in globalEnv, globalPassThroughEnv, or task-level env/passThroughEnv in turbo.json. Supports regular expression patterns (anchors ^ and $ are implicit).

1
{
2
  "linter": {
3
    "rules": {
4
      "nursery": {
5
        "noUndeclaredEnvVars": {
6
          "options": {
7
            "allowedEnvVars": [
8
              "MY_APP_.*",
9
              "ACME_TOKEN"
10
            ]
11
          }
12
        }
13
      }
14
    }
15
  }
16
}

noUndeclaredEnvVars

摘要

如何配置

描述

默认允许变量

示例

无效

有效

选项

相关链接