From dd84b9d64fb98746a230cd24233ff50a562c39c9 Mon Sep 17 00:00:00 2001
From: 简律纯 <hsiangnianian@outlook.com>
Date: Fri, 28 Apr 2023 01:36:44 +0800
Subject:

---
 .../docs/rules/no-undeclared-env-vars.md           | 74 ++++++++++++++++++++++
 1 file changed, 74 insertions(+)
 create mode 100644 packages/eslint-plugin-turbo/docs/rules/no-undeclared-env-vars.md

(limited to 'packages/eslint-plugin-turbo/docs')

diff --git a/packages/eslint-plugin-turbo/docs/rules/no-undeclared-env-vars.md b/packages/eslint-plugin-turbo/docs/rules/no-undeclared-env-vars.md
new file mode 100644
index 0000000..049d7af
--- /dev/null
+++ b/packages/eslint-plugin-turbo/docs/rules/no-undeclared-env-vars.md
@@ -0,0 +1,74 @@
+# Ensure all environment variables are correctly included in cache keys (`no-undeclared-env-vars`)
+
+Ensures that all detectable usage of environment variables are correctly included in cache keys. This ensures build outputs remain correctly cacheable across environments.
+
+## Rule Details
+
+This rule aims to prevent users from forgetting to include an environment variable in their `turbo.json` configuration.
+
+The following examples assume the following code:
+
+```js
+const client = MyAPI({ token: process.env.MY_API_TOKEN });
+```
+
+Examples of **incorrect** code for this rule:
+
+```json
+{
+  "pipeline": {
+    "build": {
+      "dependsOn": ["^build"],
+      "outputs": ["dist/**", ".next/**", "!.next/cache/**"]
+    },
+    "lint": {},
+    "dev": {
+      "cache": false
+    }
+  }
+}
+```
+
+Examples of **correct** code for this rule:
+
+```json
+{
+  "globalEnv": ["MY_API_TOKEN"],
+  "pipeline": {
+    "build": {
+      "dependsOn": ["^build"],
+      "outputs": ["dist/**", ".next/**", "!.next/cache/**"]
+    },
+    "lint": {},
+    "dev": {
+      "cache": false
+    }
+  }
+}
+```
+
+```json
+{
+  "pipeline": {
+    "build": {
+      "dependsOn": ["^build"],
+      "env": ["MY_API_TOKEN"],
+      "outputs": ["dist/**", ".next/**", "!.next/cache/**"]
+    },
+    "lint": {},
+    "dev": {
+      "cache": false
+    }
+  }
+}
+```
+
+## Options
+
+| Option      | Required | Default | Details                                                                                                                                     | Example                                      |
+| ----------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------- |
+| `allowList` | No       | []      | An array of strings (or regular expressions) to exclude. NOTE: an env variable should only be excluded if it has no effect on build outputs | `["MY_API_TOKEN", "^MY_ENV_PREFIX_[A-Z]+$"]` |
+
+## Further Reading
+
+- [Altering Caching Based on Environment Variables](https://turbo.build/repo/docs/core-concepts/caching#altering-caching-based-on-environment-variables)
-- 
cgit v1.2.3-70-g09d2