noUndeclaredEnvVars

Ta treść nie jest jeszcze dostępna w Twoim języku.

JavaScript (and super languages)

Summary

Rule available since: v2.3.10
Diagnostic Category: lint/nursery/noUndeclaredEnvVars
This rule doesn’t have a fix.
The default severity of this rule is warning.
This rule belongs to the following domains:
- turborepo
Sources:
- 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.

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.

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

Environment variables declared in turbo.json(c) (globalEnv, globalPassThroughEnv, task-level env, and task-level passThroughEnv)
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

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

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
}