aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/packages/eslint-plugin-turbo
diff options
context:
space:
mode:
author简律纯 <hsiangnianian@outlook.com>2023-04-28 01:36:44 +0800
committer简律纯 <hsiangnianian@outlook.com>2023-04-28 01:36:44 +0800
commitdd84b9d64fb98746a230cd24233ff50a562c39c9 (patch)
treeb583261ef00b3afe72ec4d6dacb31e57779a6faf /packages/eslint-plugin-turbo
parent0b46fcd72ac34382387b2bcf9095233efbcc52f4 (diff)
downloadHydroRoll-dd84b9d64fb98746a230cd24233ff50a562c39c9.tar.gz
HydroRoll-dd84b9d64fb98746a230cd24233ff50a562c39c9.zip
Diffstat (limited to 'packages/eslint-plugin-turbo')
-rw-r--r--packages/eslint-plugin-turbo/LICENSE373
-rw-r--r--packages/eslint-plugin-turbo/README.md53
-rw-r--r--packages/eslint-plugin-turbo/__fixtures__/configs/single/turbo.json25
-rw-r--r--packages/eslint-plugin-turbo/__fixtures__/workspace-configs/apps/docs/index.js6
-rw-r--r--packages/eslint-plugin-turbo/__fixtures__/workspace-configs/apps/docs/package.json4
-rw-r--r--packages/eslint-plugin-turbo/__fixtures__/workspace-configs/apps/docs/turbo.json9
-rw-r--r--packages/eslint-plugin-turbo/__fixtures__/workspace-configs/apps/web/index.js6
-rw-r--r--packages/eslint-plugin-turbo/__fixtures__/workspace-configs/apps/web/package.json4
-rw-r--r--packages/eslint-plugin-turbo/__fixtures__/workspace-configs/apps/web/turbo.json9
-rw-r--r--packages/eslint-plugin-turbo/__fixtures__/workspace-configs/package.json14
-rw-r--r--packages/eslint-plugin-turbo/__fixtures__/workspace-configs/packages/ui/index.js6
-rw-r--r--packages/eslint-plugin-turbo/__fixtures__/workspace-configs/packages/ui/package.json4
-rw-r--r--packages/eslint-plugin-turbo/__fixtures__/workspace-configs/packages/ui/turbo.json9
-rw-r--r--packages/eslint-plugin-turbo/__fixtures__/workspace-configs/turbo.json9
-rw-r--r--packages/eslint-plugin-turbo/__fixtures__/workspace/.eslintrc.js4
-rw-r--r--packages/eslint-plugin-turbo/__fixtures__/workspace/child/child.js2
-rw-r--r--packages/eslint-plugin-turbo/__fixtures__/workspace/package-lock.json58
-rw-r--r--packages/eslint-plugin-turbo/__fixtures__/workspace/package.json5
-rw-r--r--packages/eslint-plugin-turbo/__fixtures__/workspace/peer.js1
-rw-r--r--packages/eslint-plugin-turbo/__fixtures__/workspace/turbo.json34
-rw-r--r--packages/eslint-plugin-turbo/__tests__/cwd.test.ts88
-rw-r--r--packages/eslint-plugin-turbo/__tests__/lib/no-undeclared-env-vars.test.ts433
-rw-r--r--packages/eslint-plugin-turbo/docs/rules/no-undeclared-env-vars.md74
-rw-r--r--packages/eslint-plugin-turbo/jest.config.js12
-rw-r--r--packages/eslint-plugin-turbo/lib/configs/recommended.ts26
-rw-r--r--packages/eslint-plugin-turbo/lib/constants.ts5
-rw-r--r--packages/eslint-plugin-turbo/lib/index.ts17
-rw-r--r--packages/eslint-plugin-turbo/lib/rules/no-undeclared-env-vars.ts187
-rw-r--r--packages/eslint-plugin-turbo/lib/utils/getEnvVarDependencies.ts75
-rw-r--r--packages/eslint-plugin-turbo/package.json51
-rw-r--r--packages/eslint-plugin-turbo/tsconfig.json6
-rw-r--r--packages/eslint-plugin-turbo/tsup.config.ts8
-rw-r--r--packages/eslint-plugin-turbo/turbo.json9
33 files changed, 1626 insertions, 0 deletions
diff --git a/packages/eslint-plugin-turbo/LICENSE b/packages/eslint-plugin-turbo/LICENSE
new file mode 100644
index 0000000..fa0086a
--- /dev/null
+++ b/packages/eslint-plugin-turbo/LICENSE
@@ -0,0 +1,373 @@
+Mozilla Public License Version 2.0
+==================================
+
+1. Definitions
+--------------
+
+1.1. "Contributor"
+ means each individual or legal entity that creates, contributes to
+ the creation of, or owns Covered Software.
+
+1.2. "Contributor Version"
+ means the combination of the Contributions of others (if any) used
+ by a Contributor and that particular Contributor's Contribution.
+
+1.3. "Contribution"
+ means Covered Software of a particular Contributor.
+
+1.4. "Covered Software"
+ means Source Code Form to which the initial Contributor has attached
+ the notice in Exhibit A, the Executable Form of such Source Code
+ Form, and Modifications of such Source Code Form, in each case
+ including portions thereof.
+
+1.5. "Incompatible With Secondary Licenses"
+ means
+
+ (a) that the initial Contributor has attached the notice described
+ in Exhibit B to the Covered Software; or
+
+ (b) that the Covered Software was made available under the terms of
+ version 1.1 or earlier of the License, but not also under the
+ terms of a Secondary License.
+
+1.6. "Executable Form"
+ means any form of the work other than Source Code Form.
+
+1.7. "Larger Work"
+ means a work that combines Covered Software with other material, in
+ a separate file or files, that is not Covered Software.
+
+1.8. "License"
+ means this document.
+
+1.9. "Licensable"
+ means having the right to grant, to the maximum extent possible,
+ whether at the time of the initial grant or subsequently, any and
+ all of the rights conveyed by this License.
+
+1.10. "Modifications"
+ means any of the following:
+
+ (a) any file in Source Code Form that results from an addition to,
+ deletion from, or modification of the contents of Covered
+ Software; or
+
+ (b) any new file in Source Code Form that contains any Covered
+ Software.
+
+1.11. "Patent Claims" of a Contributor
+ means any patent claim(s), including without limitation, method,
+ process, and apparatus claims, in any patent Licensable by such
+ Contributor that would be infringed, but for the grant of the
+ License, by the making, using, selling, offering for sale, having
+ made, import, or transfer of either its Contributions or its
+ Contributor Version.
+
+1.12. "Secondary License"
+ means either the GNU General Public License, Version 2.0, the GNU
+ Lesser General Public License, Version 2.1, the GNU Affero General
+ Public License, Version 3.0, or any later versions of those
+ licenses.
+
+1.13. "Source Code Form"
+ means the form of the work preferred for making modifications.
+
+1.14. "You" (or "Your")
+ means an individual or a legal entity exercising rights under this
+ License. For legal entities, "You" includes any entity that
+ controls, is controlled by, or is under common control with You. For
+ purposes of this definition, "control" means (a) the power, direct
+ or indirect, to cause the direction or management of such entity,
+ whether by contract or otherwise, or (b) ownership of more than
+ fifty percent (50%) of the outstanding shares or beneficial
+ ownership of such entity.
+
+2. License Grants and Conditions
+--------------------------------
+
+2.1. Grants
+
+Each Contributor hereby grants You a world-wide, royalty-free,
+non-exclusive license:
+
+(a) under intellectual property rights (other than patent or trademark)
+ Licensable by such Contributor to use, reproduce, make available,
+ modify, display, perform, distribute, and otherwise exploit its
+ Contributions, either on an unmodified basis, with Modifications, or
+ as part of a Larger Work; and
+
+(b) under Patent Claims of such Contributor to make, use, sell, offer
+ for sale, have made, import, and otherwise transfer either its
+ Contributions or its Contributor Version.
+
+2.2. Effective Date
+
+The licenses granted in Section 2.1 with respect to any Contribution
+become effective for each Contribution on the date the Contributor first
+distributes such Contribution.
+
+2.3. Limitations on Grant Scope
+
+The licenses granted in this Section 2 are the only rights granted under
+this License. No additional rights or licenses will be implied from the
+distribution or licensing of Covered Software under this License.
+Notwithstanding Section 2.1(b) above, no patent license is granted by a
+Contributor:
+
+(a) for any code that a Contributor has removed from Covered Software;
+ or
+
+(b) for infringements caused by: (i) Your and any other third party's
+ modifications of Covered Software, or (ii) the combination of its
+ Contributions with other software (except as part of its Contributor
+ Version); or
+
+(c) under Patent Claims infringed by Covered Software in the absence of
+ its Contributions.
+
+This License does not grant any rights in the trademarks, service marks,
+or logos of any Contributor (except as may be necessary to comply with
+the notice requirements in Section 3.4).
+
+2.4. Subsequent Licenses
+
+No Contributor makes additional grants as a result of Your choice to
+distribute the Covered Software under a subsequent version of this
+License (see Section 10.2) or under the terms of a Secondary License (if
+permitted under the terms of Section 3.3).
+
+2.5. Representation
+
+Each Contributor represents that the Contributor believes its
+Contributions are its original creation(s) or it has sufficient rights
+to grant the rights to its Contributions conveyed by this License.
+
+2.6. Fair Use
+
+This License is not intended to limit any rights You have under
+applicable copyright doctrines of fair use, fair dealing, or other
+equivalents.
+
+2.7. Conditions
+
+Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
+in Section 2.1.
+
+3. Responsibilities
+-------------------
+
+3.1. Distribution of Source Form
+
+All distribution of Covered Software in Source Code Form, including any
+Modifications that You create or to which You contribute, must be under
+the terms of this License. You must inform recipients that the Source
+Code Form of the Covered Software is governed by the terms of this
+License, and how they can obtain a copy of this License. You may not
+attempt to alter or restrict the recipients' rights in the Source Code
+Form.
+
+3.2. Distribution of Executable Form
+
+If You distribute Covered Software in Executable Form then:
+
+(a) such Covered Software must also be made available in Source Code
+ Form, as described in Section 3.1, and You must inform recipients of
+ the Executable Form how they can obtain a copy of such Source Code
+ Form by reasonable means in a timely manner, at a charge no more
+ than the cost of distribution to the recipient; and
+
+(b) You may distribute such Executable Form under the terms of this
+ License, or sublicense it under different terms, provided that the
+ license for the Executable Form does not attempt to limit or alter
+ the recipients' rights in the Source Code Form under this License.
+
+3.3. Distribution of a Larger Work
+
+You may create and distribute a Larger Work under terms of Your choice,
+provided that You also comply with the requirements of this License for
+the Covered Software. If the Larger Work is a combination of Covered
+Software with a work governed by one or more Secondary Licenses, and the
+Covered Software is not Incompatible With Secondary Licenses, this
+License permits You to additionally distribute such Covered Software
+under the terms of such Secondary License(s), so that the recipient of
+the Larger Work may, at their option, further distribute the Covered
+Software under the terms of either this License or such Secondary
+License(s).
+
+3.4. Notices
+
+You may not remove or alter the substance of any license notices
+(including copyright notices, patent notices, disclaimers of warranty,
+or limitations of liability) contained within the Source Code Form of
+the Covered Software, except that You may alter any license notices to
+the extent required to remedy known factual inaccuracies.
+
+3.5. Application of Additional Terms
+
+You may choose to offer, and to charge a fee for, warranty, support,
+indemnity or liability obligations to one or more recipients of Covered
+Software. However, You may do so only on Your own behalf, and not on
+behalf of any Contributor. You must make it absolutely clear that any
+such warranty, support, indemnity, or liability obligation is offered by
+You alone, and You hereby agree to indemnify every Contributor for any
+liability incurred by such Contributor as a result of warranty, support,
+indemnity or liability terms You offer. You may include additional
+disclaimers of warranty and limitations of liability specific to any
+jurisdiction.
+
+4. Inability to Comply Due to Statute or Regulation
+---------------------------------------------------
+
+If it is impossible for You to comply with any of the terms of this
+License with respect to some or all of the Covered Software due to
+statute, judicial order, or regulation then You must: (a) comply with
+the terms of this License to the maximum extent possible; and (b)
+describe the limitations and the code they affect. Such description must
+be placed in a text file included with all distributions of the Covered
+Software under this License. Except to the extent prohibited by statute
+or regulation, such description must be sufficiently detailed for a
+recipient of ordinary skill to be able to understand it.
+
+5. Termination
+--------------
+
+5.1. The rights granted under this License will terminate automatically
+if You fail to comply with any of its terms. However, if You become
+compliant, then the rights granted under this License from a particular
+Contributor are reinstated (a) provisionally, unless and until such
+Contributor explicitly and finally terminates Your grants, and (b) on an
+ongoing basis, if such Contributor fails to notify You of the
+non-compliance by some reasonable means prior to 60 days after You have
+come back into compliance. Moreover, Your grants from a particular
+Contributor are reinstated on an ongoing basis if such Contributor
+notifies You of the non-compliance by some reasonable means, this is the
+first time You have received notice of non-compliance with this License
+from such Contributor, and You become compliant prior to 30 days after
+Your receipt of the notice.
+
+5.2. If You initiate litigation against any entity by asserting a patent
+infringement claim (excluding declaratory judgment actions,
+counter-claims, and cross-claims) alleging that a Contributor Version
+directly or indirectly infringes any patent, then the rights granted to
+You by any and all Contributors for the Covered Software under Section
+2.1 of this License shall terminate.
+
+5.3. In the event of termination under Sections 5.1 or 5.2 above, all
+end user license agreements (excluding distributors and resellers) which
+have been validly granted by You or Your distributors under this License
+prior to termination shall survive termination.
+
+************************************************************************
+* *
+* 6. Disclaimer of Warranty *
+* ------------------------- *
+* *
+* Covered Software is provided under this License on an "as is" *
+* basis, without warranty of any kind, either expressed, implied, or *
+* statutory, including, without limitation, warranties that the *
+* Covered Software is free of defects, merchantable, fit for a *
+* particular purpose or non-infringing. The entire risk as to the *
+* quality and performance of the Covered Software is with You. *
+* Should any Covered Software prove defective in any respect, You *
+* (not any Contributor) assume the cost of any necessary servicing, *
+* repair, or correction. This disclaimer of warranty constitutes an *
+* essential part of this License. No use of any Covered Software is *
+* authorized under this License except under this disclaimer. *
+* *
+************************************************************************
+
+************************************************************************
+* *
+* 7. Limitation of Liability *
+* -------------------------- *
+* *
+* Under no circumstances and under no legal theory, whether tort *
+* (including negligence), contract, or otherwise, shall any *
+* Contributor, or anyone who distributes Covered Software as *
+* permitted above, be liable to You for any direct, indirect, *
+* special, incidental, or consequential damages of any character *
+* including, without limitation, damages for lost profits, loss of *
+* goodwill, work stoppage, computer failure or malfunction, or any *
+* and all other commercial damages or losses, even if such party *
+* shall have been informed of the possibility of such damages. This *
+* limitation of liability shall not apply to liability for death or *
+* personal injury resulting from such party's negligence to the *
+* extent applicable law prohibits such limitation. Some *
+* jurisdictions do not allow the exclusion or limitation of *
+* incidental or consequential damages, so this exclusion and *
+* limitation may not apply to You. *
+* *
+************************************************************************
+
+8. Litigation
+-------------
+
+Any litigation relating to this License may be brought only in the
+courts of a jurisdiction where the defendant maintains its principal
+place of business and such litigation shall be governed by laws of that
+jurisdiction, without reference to its conflict-of-law provisions.
+Nothing in this Section shall prevent a party's ability to bring
+cross-claims or counter-claims.
+
+9. Miscellaneous
+----------------
+
+This License represents the complete agreement concerning the subject
+matter hereof. If any provision of this License is held to be
+unenforceable, such provision shall be reformed only to the extent
+necessary to make it enforceable. Any law or regulation which provides
+that the language of a contract shall be construed against the drafter
+shall not be used to construe this License against a Contributor.
+
+10. Versions of the License
+---------------------------
+
+10.1. New Versions
+
+Mozilla Foundation is the license steward. Except as provided in Section
+10.3, no one other than the license steward has the right to modify or
+publish new versions of this License. Each version will be given a
+distinguishing version number.
+
+10.2. Effect of New Versions
+
+You may distribute the Covered Software under the terms of the version
+of the License under which You originally received the Covered Software,
+or under the terms of any subsequent version published by the license
+steward.
+
+10.3. Modified Versions
+
+If you create software not governed by this License, and you want to
+create a new license for such software, you may create and use a
+modified version of this License if you rename the license and remove
+any references to the name of the license steward (except to note that
+such modified license differs from this License).
+
+10.4. Distributing Source Code Form that is Incompatible With Secondary
+Licenses
+
+If You choose to distribute Source Code Form that is Incompatible With
+Secondary Licenses under the terms of this version of the License, the
+notice described in Exhibit B of this License must be attached.
+
+Exhibit A - Source Code Form License Notice
+-------------------------------------------
+
+ This Source Code Form is subject to the terms of the Mozilla Public
+ License, v. 2.0. If a copy of the MPL was not distributed with this
+ file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+If it is not possible or desirable to put the notice in a particular
+file, then You may include the notice in a location (such as a LICENSE
+file in a relevant directory) where a recipient would be likely to look
+for such a notice.
+
+You may add additional accurate notices of copyright ownership.
+
+Exhibit B - "Incompatible With Secondary Licenses" Notice
+---------------------------------------------------------
+
+ This Source Code Form is "Incompatible With Secondary Licenses", as
+ defined by the Mozilla Public License, v. 2.0. \ No newline at end of file
diff --git a/packages/eslint-plugin-turbo/README.md b/packages/eslint-plugin-turbo/README.md
new file mode 100644
index 0000000..83627a1
--- /dev/null
+++ b/packages/eslint-plugin-turbo/README.md
@@ -0,0 +1,53 @@
+# `eslint-plugin-turbo`
+
+Ease configuration for Turborepo
+
+## Installation
+
+1. You'll first need to install [ESLint](https://eslint.org/):
+
+```sh
+npm install eslint --save-dev
+```
+
+2. Next, install `eslint-plugin-turbo`:
+
+```sh
+npm install eslint-plugin-turbo --save-dev
+```
+
+## Usage
+
+Add `turbo` to the plugins section of your `.eslintrc` configuration file. You can omit the `eslint-plugin-` prefix:
+
+```json
+{
+ "plugins": ["turbo"]
+}
+```
+
+Then configure the rules you want to use under the rules section.
+
+```json
+{
+ "rules": {
+ "turbo/no-undeclared-env-vars": "error"
+ }
+}
+```
+
+### Example
+
+```json
+{
+ "plugins": ["turbo"],
+ "rules": {
+ "turbo/no-undeclared-env-vars": [
+ "error",
+ {
+ "allowList": ["^ENV_[A-Z]+$"]
+ }
+ ]
+ }
+}
+```
diff --git a/packages/eslint-plugin-turbo/__fixtures__/configs/single/turbo.json b/packages/eslint-plugin-turbo/__fixtures__/configs/single/turbo.json
new file mode 100644
index 0000000..22b79b5
--- /dev/null
+++ b/packages/eslint-plugin-turbo/__fixtures__/configs/single/turbo.json
@@ -0,0 +1,25 @@
+{
+ // new style, global env dependency
+ "globalEnv": ["NEW_STYLE_GLOBAL_ENV_KEY", "$NEW_STYLE_GLOBAL_ENV_KEY"],
+ // old style, global env dependency (deprecated)
+ "globalDependencies": ["$GLOBAL_ENV_KEY"],
+ "pipeline": {
+ "test": {
+ "outputs": ["coverage/**"],
+ "dependsOn": ["^build"]
+ },
+ "lint": {
+ "outputs": []
+ },
+ "dev": {
+ "cache": false
+ },
+ "build": {
+ "outputs": ["dist/**", ".next/**", "!.next/.cache/**"],
+ // task level env var deps
+ "env": ["NEW_STYLE_ENV_KEY"],
+ // old task level env var deps (deprecated)
+ "dependsOn": ["^build", "$TASK_ENV_KEY", "$ANOTHER_ENV_KEY"]
+ }
+ }
+}
diff --git a/packages/eslint-plugin-turbo/__fixtures__/workspace-configs/apps/docs/index.js b/packages/eslint-plugin-turbo/__fixtures__/workspace-configs/apps/docs/index.js
new file mode 100644
index 0000000..4de53f5
--- /dev/null
+++ b/packages/eslint-plugin-turbo/__fixtures__/workspace-configs/apps/docs/index.js
@@ -0,0 +1,6 @@
+export default function docs() {
+ if (process.env.ENV_1 === undefined) {
+ return "does not exist";
+ }
+ return "exists";
+}
diff --git a/packages/eslint-plugin-turbo/__fixtures__/workspace-configs/apps/docs/package.json b/packages/eslint-plugin-turbo/__fixtures__/workspace-configs/apps/docs/package.json
new file mode 100644
index 0000000..82f9a44
--- /dev/null
+++ b/packages/eslint-plugin-turbo/__fixtures__/workspace-configs/apps/docs/package.json
@@ -0,0 +1,4 @@
+{
+ "name": "docs",
+ "version": "1.0.0"
+}
diff --git a/packages/eslint-plugin-turbo/__fixtures__/workspace-configs/apps/docs/turbo.json b/packages/eslint-plugin-turbo/__fixtures__/workspace-configs/apps/docs/turbo.json
new file mode 100644
index 0000000..a3713ef
--- /dev/null
+++ b/packages/eslint-plugin-turbo/__fixtures__/workspace-configs/apps/docs/turbo.json
@@ -0,0 +1,9 @@
+{
+ "$schema": "https://turbo.build/schema.json",
+ "extends": ["//"],
+ "pipeline": {
+ "build": {
+ "env": ["ENV_3"]
+ }
+ }
+}
diff --git a/packages/eslint-plugin-turbo/__fixtures__/workspace-configs/apps/web/index.js b/packages/eslint-plugin-turbo/__fixtures__/workspace-configs/apps/web/index.js
new file mode 100644
index 0000000..bfd3ab8
--- /dev/null
+++ b/packages/eslint-plugin-turbo/__fixtures__/workspace-configs/apps/web/index.js
@@ -0,0 +1,6 @@
+export default function web() {
+ if (!process.env.ENV_2) {
+ return "bar";
+ }
+ return "foo";
+}
diff --git a/packages/eslint-plugin-turbo/__fixtures__/workspace-configs/apps/web/package.json b/packages/eslint-plugin-turbo/__fixtures__/workspace-configs/apps/web/package.json
new file mode 100644
index 0000000..d8a83ed
--- /dev/null
+++ b/packages/eslint-plugin-turbo/__fixtures__/workspace-configs/apps/web/package.json
@@ -0,0 +1,4 @@
+{
+ "name": "web",
+ "version": "1.0.0"
+}
diff --git a/packages/eslint-plugin-turbo/__fixtures__/workspace-configs/apps/web/turbo.json b/packages/eslint-plugin-turbo/__fixtures__/workspace-configs/apps/web/turbo.json
new file mode 100644
index 0000000..0d1b80f
--- /dev/null
+++ b/packages/eslint-plugin-turbo/__fixtures__/workspace-configs/apps/web/turbo.json
@@ -0,0 +1,9 @@
+{
+ "$schema": "https://turbo.build/schema.json",
+ "extends": ["//"],
+ "pipeline": {
+ "build": {
+ "env": ["ENV_2"]
+ }
+ }
+}
diff --git a/packages/eslint-plugin-turbo/__fixtures__/workspace-configs/package.json b/packages/eslint-plugin-turbo/__fixtures__/workspace-configs/package.json
new file mode 100644
index 0000000..c6616a6
--- /dev/null
+++ b/packages/eslint-plugin-turbo/__fixtures__/workspace-configs/package.json
@@ -0,0 +1,14 @@
+{
+ "private": true,
+ "workspaces": [
+ "apps/*",
+ "packages/*"
+ ],
+ "scripts": {
+ "build": "turbo run build"
+ },
+ "devDependencies": {
+ "turbo": "latest"
+ },
+ "packageManager": "yarn@1.22.19"
+}
diff --git a/packages/eslint-plugin-turbo/__fixtures__/workspace-configs/packages/ui/index.js b/packages/eslint-plugin-turbo/__fixtures__/workspace-configs/packages/ui/index.js
new file mode 100644
index 0000000..dee5e80
--- /dev/null
+++ b/packages/eslint-plugin-turbo/__fixtures__/workspace-configs/packages/ui/index.js
@@ -0,0 +1,6 @@
+export default function foo() {
+ if (!process.env.IS_SERVER) {
+ return "bar";
+ }
+ return "foo";
+}
diff --git a/packages/eslint-plugin-turbo/__fixtures__/workspace-configs/packages/ui/package.json b/packages/eslint-plugin-turbo/__fixtures__/workspace-configs/packages/ui/package.json
new file mode 100644
index 0000000..7cb7cf1
--- /dev/null
+++ b/packages/eslint-plugin-turbo/__fixtures__/workspace-configs/packages/ui/package.json
@@ -0,0 +1,4 @@
+{
+ "name": "ui",
+ "version": "1.0.0"
+}
diff --git a/packages/eslint-plugin-turbo/__fixtures__/workspace-configs/packages/ui/turbo.json b/packages/eslint-plugin-turbo/__fixtures__/workspace-configs/packages/ui/turbo.json
new file mode 100644
index 0000000..8bff09e
--- /dev/null
+++ b/packages/eslint-plugin-turbo/__fixtures__/workspace-configs/packages/ui/turbo.json
@@ -0,0 +1,9 @@
+{
+ "$schema": "https://turbo.build/schema.json",
+ "extends": ["//"],
+ "pipeline": {
+ "build": {
+ "env": ["IS_SERVER"]
+ }
+ }
+}
diff --git a/packages/eslint-plugin-turbo/__fixtures__/workspace-configs/turbo.json b/packages/eslint-plugin-turbo/__fixtures__/workspace-configs/turbo.json
new file mode 100644
index 0000000..cb4fb20
--- /dev/null
+++ b/packages/eslint-plugin-turbo/__fixtures__/workspace-configs/turbo.json
@@ -0,0 +1,9 @@
+{
+ "$schema": "https://turbo.build/schema.json",
+ "globalEnv": ["CI"],
+ "pipeline": {
+ "build": {
+ "env": ["ENV_1"]
+ }
+ }
+}
diff --git a/packages/eslint-plugin-turbo/__fixtures__/workspace/.eslintrc.js b/packages/eslint-plugin-turbo/__fixtures__/workspace/.eslintrc.js
new file mode 100644
index 0000000..8dc66dc
--- /dev/null
+++ b/packages/eslint-plugin-turbo/__fixtures__/workspace/.eslintrc.js
@@ -0,0 +1,4 @@
+module.exports = {
+ root: true,
+ extends: ["plugin:turbo/recommended"],
+};
diff --git a/packages/eslint-plugin-turbo/__fixtures__/workspace/child/child.js b/packages/eslint-plugin-turbo/__fixtures__/workspace/child/child.js
new file mode 100644
index 0000000..9e799a2
--- /dev/null
+++ b/packages/eslint-plugin-turbo/__fixtures__/workspace/child/child.js
@@ -0,0 +1,2 @@
+process.env.NONEXISTENT;
+process.env.CI;
diff --git a/packages/eslint-plugin-turbo/__fixtures__/workspace/package-lock.json b/packages/eslint-plugin-turbo/__fixtures__/workspace/package-lock.json
new file mode 100644
index 0000000..301f072
--- /dev/null
+++ b/packages/eslint-plugin-turbo/__fixtures__/workspace/package-lock.json
@@ -0,0 +1,58 @@
+{
+ "name": "workspace",
+ "lockfileVersion": 2,
+ "requires": true,
+ "packages": {
+ "": {
+ "dependencies": {
+ "eslint-plugin-turbo": "../../"
+ }
+ },
+ "../..": {
+ "version": "1.9.0",
+ "license": "MPL-2.0",
+ "devDependencies": {
+ "@turbo/test-utils": "workspace:*",
+ "@turbo/tsconfig": "workspace:*",
+ "@turbo/types": "workspace:*",
+ "@turbo/utils": "workspace:*",
+ "@types/eslint": "^8.4.5",
+ "@types/estree": "^1.0.0",
+ "@types/jest": "^27.4.0",
+ "@types/node": "^16.11.12",
+ "jest": "^27.4.3",
+ "json5": "^2.2.1",
+ "ts-jest": "^27.1.1",
+ "tsup": "^6.2.0",
+ "typescript": "^4.7.4"
+ },
+ "peerDependencies": {
+ "eslint": ">6.6.0"
+ }
+ },
+ "node_modules/eslint-plugin-turbo": {
+ "resolved": "../..",
+ "link": true
+ }
+ },
+ "dependencies": {
+ "eslint-plugin-turbo": {
+ "version": "file:../..",
+ "requires": {
+ "@turbo/test-utils": "workspace:*",
+ "@turbo/tsconfig": "workspace:*",
+ "@turbo/types": "workspace:*",
+ "@turbo/utils": "workspace:*",
+ "@types/eslint": "^8.4.5",
+ "@types/estree": "^1.0.0",
+ "@types/jest": "^27.4.0",
+ "@types/node": "^16.11.12",
+ "jest": "^27.4.3",
+ "json5": "^2.2.1",
+ "ts-jest": "^27.1.1",
+ "tsup": "^6.2.0",
+ "typescript": "^4.7.4"
+ }
+ }
+ }
+}
diff --git a/packages/eslint-plugin-turbo/__fixtures__/workspace/package.json b/packages/eslint-plugin-turbo/__fixtures__/workspace/package.json
new file mode 100644
index 0000000..a1b2929
--- /dev/null
+++ b/packages/eslint-plugin-turbo/__fixtures__/workspace/package.json
@@ -0,0 +1,5 @@
+{
+ "dependencies": {
+ "eslint-plugin-turbo": "../../"
+ }
+}
diff --git a/packages/eslint-plugin-turbo/__fixtures__/workspace/peer.js b/packages/eslint-plugin-turbo/__fixtures__/workspace/peer.js
new file mode 100644
index 0000000..16c8bb0
--- /dev/null
+++ b/packages/eslint-plugin-turbo/__fixtures__/workspace/peer.js
@@ -0,0 +1 @@
+process.env.CI;
diff --git a/packages/eslint-plugin-turbo/__fixtures__/workspace/turbo.json b/packages/eslint-plugin-turbo/__fixtures__/workspace/turbo.json
new file mode 100644
index 0000000..8079eb2
--- /dev/null
+++ b/packages/eslint-plugin-turbo/__fixtures__/workspace/turbo.json
@@ -0,0 +1,34 @@
+{
+ "$schema": "https://turbo.build/schema.json",
+ "globalEnv": ["UNORDERED", "CI"],
+ "pipeline": {
+ "build": {
+ // A workspace's `build` task depends on that workspace's
+ // topological dependencies' and devDependencies'
+ // `build` tasks being completed first. The `^` symbol
+ // indicates an upstream dependency.
+ "dependsOn": ["^build"]
+ },
+ "test": {
+ // A workspace's `test` task depends on that workspace's
+ // own `build` task being completed first.
+ "dependsOn": ["build"],
+ "outputs": [],
+ // A workspace's `test` task should only be rerun when
+ // either a `.tsx` or `.ts` file has changed.
+ "inputs": ["src/**/*.tsx", "src/**/*.ts", "test/**/*.ts", "test/**/*.tsx"]
+ },
+ "lint": {
+ // A workspace's `lint` task has no dependencies and
+ // can be run whenever.
+ "outputs": []
+ },
+ "deploy": {
+ // A workspace's `deploy` task depends on the `build`,
+ // `test`, and `lint` tasks of the same workspace
+ // being completed.
+ "dependsOn": ["build", "test", "lint"],
+ "outputs": []
+ }
+ }
+}
diff --git a/packages/eslint-plugin-turbo/__tests__/cwd.test.ts b/packages/eslint-plugin-turbo/__tests__/cwd.test.ts
new file mode 100644
index 0000000..15a2695
--- /dev/null
+++ b/packages/eslint-plugin-turbo/__tests__/cwd.test.ts
@@ -0,0 +1,88 @@
+import path from "path";
+import JSON5 from "json5";
+import { execSync } from "child_process";
+import { Schema } from "@turbo/types";
+import { setupTestFixtures } from "@turbo/test-utils";
+
+describe("eslint settings check", () => {
+ const { useFixture } = setupTestFixtures({
+ directory: path.join(__dirname, "../"),
+ });
+
+ it("does the right thing for peers", () => {
+ const { root: cwd } = useFixture({ fixture: "workspace" });
+ execSync(`npm install`, { cwd });
+
+ const configString = execSync(`eslint --print-config peer.js`, {
+ cwd,
+ encoding: "utf8",
+ });
+ const configJson = JSON5.parse(configString);
+
+ expect(configJson.settings).toEqual({
+ turbo: { envVars: ["CI", "UNORDERED"] },
+ });
+ });
+
+ it("does the right thing for child dirs", () => {
+ const { root } = useFixture({ fixture: "workspace" });
+ execSync(`npm install`, { cwd: root });
+
+ const cwd = path.join(root, "child");
+ const configString = execSync(`eslint --print-config child.js`, {
+ cwd,
+ encoding: "utf8",
+ });
+ const configJson = JSON5.parse(configString);
+
+ expect(configJson.settings).toEqual({
+ turbo: { envVars: ["CI", "UNORDERED"] },
+ });
+ });
+});
+
+describe("eslint cache is busted", () => {
+ const { useFixture } = setupTestFixtures({
+ directory: path.join(__dirname, "../"),
+ });
+
+ it("catches a lint error after changing config", () => {
+ expect.assertions(2);
+
+ // ensure that we populate the cache with a failure.
+ const { root, readJson, write } = useFixture({ fixture: "workspace" });
+ execSync(`npm install`, { cwd: root });
+
+ const cwd = path.join(root, "child");
+ try {
+ execSync(`eslint --format=json child.js`, { cwd, encoding: "utf8" });
+ } catch (error: any) {
+ const outputJson = JSON5.parse(error.stdout);
+ expect(outputJson).toMatchObject([
+ {
+ messages: [
+ {
+ message:
+ "NONEXISTENT is not listed as a dependency in turbo.json",
+ },
+ ],
+ },
+ ]);
+ }
+
+ // change the configuration
+ const turboJson = readJson<Schema>("turbo.json");
+ if (turboJson && "globalEnv" in turboJson) {
+ turboJson.globalEnv = ["CI", "NONEXISTENT"];
+ write("turbo.json", JSON5.stringify(turboJson, null, 2));
+ }
+
+ // test that we invalidated the eslint cache
+ const output = execSync(`eslint --format=json child.js`, {
+ cwd,
+ encoding: "utf8",
+ });
+ const outputJson = JSON5.parse(output);
+ expect(outputJson).toMatchObject([{ errorCount: 0 }]);
+ });
+});
diff --git a/packages/eslint-plugin-turbo/__tests__/lib/no-undeclared-env-vars.test.ts b/packages/eslint-plugin-turbo/__tests__/lib/no-undeclared-env-vars.test.ts
new file mode 100644
index 0000000..5c753dd
--- /dev/null
+++ b/packages/eslint-plugin-turbo/__tests__/lib/no-undeclared-env-vars.test.ts
@@ -0,0 +1,433 @@
+import { RULES } from "../../lib/constants";
+import rule from "../../lib/rules/no-undeclared-env-vars";
+import { RuleTester } from "eslint";
+import path from "path";
+
+const ruleTester = new RuleTester({
+ parserOptions: { ecmaVersion: 2020 },
+});
+
+ruleTester.run(RULES.noUndeclaredEnvVars, rule, {
+ valid: [
+ {
+ code: `
+ const { ENV_2 } = process.env;
+ `,
+ options: [
+ { cwd: path.join(__dirname, "../../__fixtures__/workspace-configs") },
+ ],
+ filename: path.join(
+ __dirname,
+ "../../__fixtures__/workspace-configs/apps/web/index.js"
+ ),
+ },
+ {
+ code: `
+ const { ENV_1 } = process.env;
+ `,
+ options: [
+ { cwd: path.join(__dirname, "../../__fixtures__/workspace-configs") },
+ ],
+ filename: path.join(
+ __dirname,
+ "../../__fixtures__/workspace-configs/apps/web/index.js"
+ ),
+ },
+ {
+ code: `
+ const { ENV_1 } = process.env;
+ `,
+ options: [{ cwd: "/some/random/path" }],
+ },
+ {
+ code: `
+ const { CI } = process.env;
+ `,
+ options: [
+ { cwd: path.join(__dirname, "../../__fixtures__/workspace-configs") },
+ ],
+ filename: path.join(
+ __dirname,
+ "../../__fixtures__/workspace-configs/apps/web/index.js"
+ ),
+ },
+ {
+ code: `
+ const { TASK_ENV_KEY, ANOTHER_ENV_KEY } = process.env;
+ `,
+ options: [
+ { cwd: path.join(__dirname, "../../__fixtures__/configs/single") },
+ ],
+ },
+ {
+ code: `
+ const { NEW_STYLE_ENV_KEY, TASK_ENV_KEY } = process.env;
+ `,
+ options: [
+ { cwd: path.join(__dirname, "../../__fixtures__/configs/single") },
+ ],
+ },
+ {
+ code: `
+ const { NEW_STYLE_GLOBAL_ENV_KEY, TASK_ENV_KEY } = process.env;
+ `,
+ options: [
+ { cwd: path.join(__dirname, "../../__fixtures__/configs/single") },
+ ],
+ },
+ {
+ code: `
+ const val = process.env["NEW_STYLE_GLOBAL_ENV_KEY"];
+ `,
+ options: [
+ { cwd: path.join(__dirname, "../../__fixtures__/configs/single") },
+ ],
+ },
+ {
+ code: `
+ const { TASK_ENV_KEY, ANOTHER_ENV_KEY } = process.env;
+ `,
+ options: [
+ { cwd: path.join(__dirname, "../../__fixtures__/configs/single") },
+ ],
+ },
+ {
+ code: `
+ const x = process.env.GLOBAL_ENV_KEY;
+ const { TASK_ENV_KEY, GLOBAL_ENV_KEY: renamedX } = process.env;
+ `,
+ options: [
+ { cwd: path.join(__dirname, "../../__fixtures__/configs/single") },
+ ],
+ },
+ {
+ code: "var x = process.env.GLOBAL_ENV_KEY;",
+ options: [
+ { cwd: path.join(__dirname, "../../__fixtures__/configs/single") },
+ ],
+ },
+ {
+ code: "let x = process.env.TASK_ENV_KEY;",
+ options: [
+ { cwd: path.join(__dirname, "../../__fixtures__/configs/single") },
+ ],
+ },
+ {
+ code: "const x = process.env.ANOTHER_KEY_VALUE;",
+ options: [
+ {
+ cwd: path.join(__dirname, "../../__fixtures__/configs/single"),
+ allowList: ["^ANOTHER_KEY_[A-Z]+$"],
+ },
+ ],
+ },
+ {
+ code: `
+ var x = process.env.ENV_VAR_ONE;
+ var y = process.env.ENV_VAR_TWO;
+ `,
+ options: [
+ {
+ cwd: path.join(__dirname, "../../__fixtures__/configs/single"),
+ allowList: ["^ENV_VAR_[A-Z]+$"],
+ },
+ ],
+ },
+ {
+ code: `
+ var x = process.env.ENV_VAR_ONE;
+ var y = process.env.ENV_VAR_TWO;
+ `,
+ options: [
+ {
+ cwd: path.join(__dirname, "../../__fixtures__/configs/single"),
+ allowList: ["^ENV_VAR_O[A-Z]+$", "ENV_VAR_TWO"],
+ },
+ ],
+ },
+ {
+ code: `
+ var globalOrTask = process.env.TASK_ENV_KEY || process.env.GLOBAL_ENV_KEY;
+ var oneOrTwo = process.env.ENV_VAR_ONE || process.env.ENV_VAR_TWO;
+ `,
+ options: [
+ {
+ cwd: path.join(__dirname, "../../__fixtures__/configs/single"),
+ allowList: ["^ENV_VAR_[A-Z]+$"],
+ },
+ ],
+ },
+ {
+ code: `
+ () => { return process.env.GLOBAL_ENV_KEY }
+ () => { return process.env.TASK_ENV_KEY }
+ () => { return process.env.ENV_VAR_ALLOWED }
+ `,
+ options: [
+ {
+ cwd: path.join(__dirname, "../../__fixtures__/configs/single"),
+ allowList: ["^ENV_VAR_[A-Z]+$"],
+ },
+ ],
+ },
+ {
+ code: `
+ var foo = process?.env.GLOBAL_ENV_KEY
+ var foo = process?.env.TASK_ENV_KEY
+ var foo = process?.env.ENV_VAR_ALLOWED
+ `,
+ options: [
+ {
+ cwd: path.join(__dirname, "../../__fixtures__/configs/single"),
+ allowList: ["^ENV_VAR_[A-Z]+$"],
+ },
+ ],
+ },
+ {
+ code: `
+ function test(arg1 = process.env.GLOBAL_ENV_KEY) {};
+ function test(arg1 = process.env.TASK_ENV_KEY) {};
+ function test(arg1 = process.env.ENV_VAR_ALLOWED) {};
+ `,
+ options: [
+ {
+ cwd: path.join(__dirname, "../../__fixtures__/configs/single"),
+ allowList: ["^ENV_VAR_[A-Z]+$"],
+ },
+ ],
+ },
+ {
+ code: `
+ (arg1 = process.env.GLOBAL_ENV_KEY) => {}
+ (arg1 = process.env.TASK_ENV_KEY) => {}
+ (arg1 = process.env.ENV_VAR_ALLOWED) => {}
+ `,
+ options: [
+ {
+ cwd: path.join(__dirname, "../../__fixtures__/configs/single"),
+ allowList: ["^ENV_VAR_[A-Z]+$"],
+ },
+ ],
+ },
+ {
+ code: "const getEnv = (key) => process.env[key];",
+ options: [
+ { cwd: path.join(__dirname, "../../__fixtures__/configs/single") },
+ ],
+ },
+ {
+ code: "function getEnv(key) { return process.env[key]; }",
+ options: [
+ { cwd: path.join(__dirname, "../../__fixtures__/configs/single") },
+ ],
+ },
+ {
+ code: "for (let x of ['ONE', 'TWO', 'THREE']) { console.log(process.env[x]); }",
+ options: [
+ { cwd: path.join(__dirname, "../../__fixtures__/configs/single") },
+ ],
+ },
+ ],
+
+ invalid: [
+ {
+ code: `
+ const { ENV_2 } = process.env;
+ `,
+ options: [
+ { cwd: path.join(__dirname, "../../__fixtures__/workspace-configs") },
+ ],
+ filename: path.join(
+ __dirname,
+ "../../__fixtures__/workspace-configs/apps/docs/index.js"
+ ),
+ errors: [
+ {
+ message:
+ "ENV_2 is not listed as a dependency in the root turbo.json or workspace (apps/docs) turbo.json",
+ },
+ ],
+ },
+ {
+ code: "let { X } = process.env;",
+ options: [
+ { cwd: path.join(__dirname, "../../__fixtures__/configs/single") },
+ ],
+ errors: [{ message: "X is not listed as a dependency in turbo.json" }],
+ },
+ {
+ code: "const { X, Y, Z } = process.env;",
+ options: [
+ { cwd: path.join(__dirname, "../../__fixtures__/configs/single") },
+ ],
+ errors: [
+ { message: "X is not listed as a dependency in turbo.json" },
+ { message: "Y is not listed as a dependency in turbo.json" },
+ { message: "Z is not listed as a dependency in turbo.json" },
+ ],
+ },
+ {
+ code: "const { X, Y: NewName, Z } = process.env;",
+ options: [
+ { cwd: path.join(__dirname, "../../__fixtures__/configs/single") },
+ ],
+ errors: [
+ { message: "X is not listed as a dependency in turbo.json" },
+ { message: "Y is not listed as a dependency in turbo.json" },
+ { message: "Z is not listed as a dependency in turbo.json" },
+ ],
+ },
+ {
+ code: "var x = process.env.NOT_THERE;",
+ options: [
+ { cwd: path.join(__dirname, "../../__fixtures__/configs/single") },
+ ],
+ errors: [
+ {
+ message: "NOT_THERE is not listed as a dependency in turbo.json",
+ },
+ ],
+ },
+ {
+ code: "var x = process.env.KEY;",
+ options: [
+ {
+ cwd: path.join(__dirname, "../../__fixtures__/configs/single"),
+ allowList: ["^ANOTHER_KEY_[A-Z]+$"],
+ },
+ ],
+ errors: [{ message: "KEY is not listed as a dependency in turbo.json" }],
+ },
+ {
+ code: `
+ var globalOrTask = process.env.TASK_ENV_KEY_NEW || process.env.GLOBAL_ENV_KEY_NEW;
+ var oneOrTwo = process.env.ENV_VAR_ONE || process.env.ENV_VAR_TWO;
+ `,
+ options: [
+ {
+ cwd: path.join(__dirname, "../../__fixtures__/configs/single"),
+ },
+ ],
+ errors: [
+ {
+ message:
+ "TASK_ENV_KEY_NEW is not listed as a dependency in turbo.json",
+ },
+ {
+ message:
+ "GLOBAL_ENV_KEY_NEW is not listed as a dependency in turbo.json",
+ },
+ {
+ message: "ENV_VAR_ONE is not listed as a dependency in turbo.json",
+ },
+ {
+ message: "ENV_VAR_TWO is not listed as a dependency in turbo.json",
+ },
+ ],
+ },
+ {
+ code: `
+ () => { return process.env.GLOBAL_ENV_KEY_NEW }
+ () => { return process.env.TASK_ENV_KEY_NEW }
+ () => { return process.env.ENV_VAR_NOT_ALLOWED }
+ `,
+ options: [
+ {
+ cwd: path.join(__dirname, "../../__fixtures__/configs/single"),
+ },
+ ],
+ errors: [
+ {
+ message:
+ "GLOBAL_ENV_KEY_NEW is not listed as a dependency in turbo.json",
+ },
+ {
+ message:
+ "TASK_ENV_KEY_NEW is not listed as a dependency in turbo.json",
+ },
+ {
+ message:
+ "ENV_VAR_NOT_ALLOWED is not listed as a dependency in turbo.json",
+ },
+ ],
+ },
+ {
+ code: `
+ var foo = process?.env.GLOBAL_ENV_KEY_NEW
+ var foo = process?.env.TASK_ENV_KEY_NEW
+ var foo = process?.env.ENV_VAR_NOT_ALLOWED
+ `,
+ options: [
+ {
+ cwd: path.join(__dirname, "../../__fixtures__/configs/single"),
+ },
+ ],
+ errors: [
+ {
+ message:
+ "GLOBAL_ENV_KEY_NEW is not listed as a dependency in turbo.json",
+ },
+ {
+ message:
+ "TASK_ENV_KEY_NEW is not listed as a dependency in turbo.json",
+ },
+ {
+ message:
+ "ENV_VAR_NOT_ALLOWED is not listed as a dependency in turbo.json",
+ },
+ ],
+ },
+ {
+ code: `
+ function test(arg1 = process.env.GLOBAL_ENV_KEY_NEW) {};
+ function test(arg1 = process.env.TASK_ENV_KEY_NEW) {};
+ function test(arg1 = process.env.ENV_VAR_NOT_ALLOWED) {};
+ `,
+ options: [
+ {
+ cwd: path.join(__dirname, "../../__fixtures__/configs/single"),
+ },
+ ],
+ errors: [
+ {
+ message:
+ "GLOBAL_ENV_KEY_NEW is not listed as a dependency in turbo.json",
+ },
+ {
+ message:
+ "TASK_ENV_KEY_NEW is not listed as a dependency in turbo.json",
+ },
+ {
+ message:
+ "ENV_VAR_NOT_ALLOWED is not listed as a dependency in turbo.json",
+ },
+ ],
+ },
+ {
+ code: `
+ (arg1 = process.env.GLOBAL_ENV_KEY_NEW) => {}
+ (arg1 = process.env.TASK_ENV_KEY_NEW) => {}
+ (arg1 = process.env.ENV_VAR_NOT_ALLOWED) => {}
+ `,
+ options: [
+ {
+ cwd: path.join(__dirname, "../../__fixtures__/configs/single"),
+ },
+ ],
+ errors: [
+ {
+ message:
+ "GLOBAL_ENV_KEY_NEW is not listed as a dependency in turbo.json",
+ },
+ {
+ message:
+ "TASK_ENV_KEY_NEW is not listed as a dependency in turbo.json",
+ },
+ {
+ message:
+ "ENV_VAR_NOT_ALLOWED is not listed as a dependency in turbo.json",
+ },
+ ],
+ },
+ ],
+});
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)
diff --git a/packages/eslint-plugin-turbo/jest.config.js b/packages/eslint-plugin-turbo/jest.config.js
new file mode 100644
index 0000000..102773e
--- /dev/null
+++ b/packages/eslint-plugin-turbo/jest.config.js
@@ -0,0 +1,12 @@
+/** @type {import('ts-jest/dist/types').InitialOptionsTsJest} */
+module.exports = {
+ roots: ["<rootDir>"],
+ transform: {
+ "^.+\\.tsx?$": "ts-jest",
+ },
+ testPathIgnorePatterns: ["/__fixtures__/"],
+ coveragePathIgnorePatterns: ["/__fixtures__/"],
+ moduleFileExtensions: ["ts", "tsx", "js", "jsx", "json", "node"],
+ modulePathIgnorePatterns: ["<rootDir>/node_modules", "<rootDir>/dist"],
+ preset: "ts-jest",
+};
diff --git a/packages/eslint-plugin-turbo/lib/configs/recommended.ts b/packages/eslint-plugin-turbo/lib/configs/recommended.ts
new file mode 100644
index 0000000..e247503
--- /dev/null
+++ b/packages/eslint-plugin-turbo/lib/configs/recommended.ts
@@ -0,0 +1,26 @@
+import { RULES } from "../constants";
+import getEnvVarDependencies from "../utils/getEnvVarDependencies";
+
+// Add the environment variables into the ESLint incremental cache key.
+const envVars = getEnvVarDependencies({
+ cwd: process.cwd(),
+});
+const settings = {
+ turbo: {
+ envVars: envVars
+ ? Object.values(envVars)
+ .flatMap((s) => Array.from(s))
+ .sort()
+ : [],
+ },
+};
+
+const config = {
+ settings,
+ plugins: ["turbo"],
+ rules: {
+ [`turbo/${RULES.noUndeclaredEnvVars}`]: "error",
+ },
+};
+
+export default config;
diff --git a/packages/eslint-plugin-turbo/lib/constants.ts b/packages/eslint-plugin-turbo/lib/constants.ts
new file mode 100644
index 0000000..5af2e6f
--- /dev/null
+++ b/packages/eslint-plugin-turbo/lib/constants.ts
@@ -0,0 +1,5 @@
+const RULES = {
+ noUndeclaredEnvVars: `no-undeclared-env-vars`,
+};
+
+export { RULES };
diff --git a/packages/eslint-plugin-turbo/lib/index.ts b/packages/eslint-plugin-turbo/lib/index.ts
new file mode 100644
index 0000000..e7f113c
--- /dev/null
+++ b/packages/eslint-plugin-turbo/lib/index.ts
@@ -0,0 +1,17 @@
+import { RULES } from "./constants";
+
+// rules
+import noUndeclaredEnvVars from "./rules/no-undeclared-env-vars";
+
+// configs
+import recommended from "./configs/recommended";
+
+const rules = {
+ [RULES.noUndeclaredEnvVars]: noUndeclaredEnvVars,
+};
+
+const configs = {
+ recommended,
+};
+
+export { rules, configs };
diff --git a/packages/eslint-plugin-turbo/lib/rules/no-undeclared-env-vars.ts b/packages/eslint-plugin-turbo/lib/rules/no-undeclared-env-vars.ts
new file mode 100644
index 0000000..372d21a
--- /dev/null
+++ b/packages/eslint-plugin-turbo/lib/rules/no-undeclared-env-vars.ts
@@ -0,0 +1,187 @@
+import type { Rule } from "eslint";
+import path from "path";
+import { Node, MemberExpression } from "estree";
+import { RULES } from "../constants";
+import getEnvVarDependencies from "../utils/getEnvVarDependencies";
+
+const meta: Rule.RuleMetaData = {
+ type: "problem",
+ docs: {
+ description:
+ "Do not allow the use of `process.env` without including the env key in any turbo.json",
+ category: "Configuration Issues",
+ recommended: true,
+ url: `https://github.com/vercel/turbo/tree/main/packages/eslint-plugin-turbo/docs/rules/${RULES.noUndeclaredEnvVars}.md`,
+ },
+ schema: [
+ {
+ type: "object",
+ default: {},
+ additionalProperties: false,
+ properties: {
+ // override cwd, primarily exposed for easier testing
+ cwd: {
+ require: false,
+ type: "string",
+ },
+ allowList: {
+ default: [],
+ type: "array",
+ items: {
+ type: "string",
+ },
+ },
+ },
+ },
+ ],
+};
+
+/**
+ * Normalize the value of the cwd
+ * Extracted from eslint
+ * SPDX-License-Identifier: MIT
+ */
+function normalizeCwd(
+ cwd: string | undefined,
+ options: Array<any>
+): string | undefined {
+ if (options?.[0]?.cwd) {
+ return options[0].cwd;
+ }
+
+ if (cwd) {
+ return cwd;
+ }
+ if (typeof process === "object") {
+ return process.cwd();
+ }
+
+ return undefined;
+}
+
+function create(context: Rule.RuleContext): Rule.RuleListener {
+ const { options, getPhysicalFilename } = context;
+ const allowList: Array<string> = options?.[0]?.allowList || [];
+ const regexAllowList: Array<RegExp> = [];
+ allowList.forEach((allowed) => {
+ try {
+ regexAllowList.push(new RegExp(allowed));
+ } catch (err) {
+ // log the error, but just move on without this allowList entry
+ console.error(`Unable to convert "${allowed}" to regex`);
+ }
+ });
+
+ const cwd = normalizeCwd(
+ context.getCwd ? context.getCwd() : undefined,
+ options
+ );
+ const filePath = getPhysicalFilename();
+ const allTurboVars = getEnvVarDependencies({
+ cwd,
+ });
+
+ // if allTurboVars is null, something went wrong reading from the turbo config
+ // (this is different from finding a config with no env vars present, which would
+ // return an empty set) - so there is no point continuing if we have nothing to check against
+ if (!allTurboVars) {
+ // return of {} bails early from a rule check
+ return {};
+ }
+
+ const globalTurboVars = allTurboVars["//"];
+ const hasWorkspaceConfigs = Object.keys(allTurboVars).length > 1;
+
+ // find any workspace configs that match the current file path
+ // find workspace config (if any) that match the current file path
+ const workspaceKey = Object.keys(allTurboVars).find(
+ (workspacePath) => filePath !== "//" && filePath.startsWith(workspacePath)
+ );
+
+ let workspaceTurboVars: Set<string> | null = null;
+ if (workspaceKey) {
+ workspaceTurboVars = allTurboVars[workspaceKey];
+ }
+
+ const checkKey = (node: Node, envKey?: string) => {
+ if (
+ envKey &&
+ !globalTurboVars.has(envKey) &&
+ !regexAllowList.some((regex) => regex.test(envKey))
+ ) {
+ // if we have a workspace config, check that too
+ if (workspaceTurboVars && workspaceTurboVars.has(envKey)) {
+ return {};
+ } else {
+ let message = `{{ envKey }} is not listed as a dependency in ${
+ hasWorkspaceConfigs ? "root turbo.json" : "turbo.json"
+ }`;
+ if (workspaceKey && workspaceTurboVars) {
+ if (cwd) {
+ // if we have a cwd, we can provide a relative path to the workspace config
+ message = `{{ envKey }} is not listed as a dependency in the root turbo.json or workspace (${path.relative(
+ cwd,
+ workspaceKey
+ )}) turbo.json`;
+ } else {
+ message = `{{ envKey }} is not listed as a dependency in the root turbo.json or workspace turbo.json`;
+ }
+ }
+
+ context.report({
+ node,
+ message,
+ data: { envKey },
+ });
+ }
+ }
+ };
+
+ const isComputed = (
+ node: MemberExpression & Rule.NodeParentExtension
+ ): boolean => {
+ if ("computed" in node.parent) {
+ return node.parent.computed;
+ }
+
+ return false;
+ };
+
+ return {
+ MemberExpression(node) {
+ // we only care about complete process env declarations and non-computed keys
+ if (
+ "name" in node.object &&
+ "name" in node.property &&
+ !isComputed(node)
+ ) {
+ const objectName = node.object.name;
+ const propertyName = node.property.name;
+
+ // we're doing something with process.env
+ if (objectName === "process" && propertyName === "env") {
+ // destructuring from process.env
+ if ("id" in node.parent && node.parent.id?.type === "ObjectPattern") {
+ const values = node.parent.id.properties.values();
+ Array.from(values).forEach((item) => {
+ if ("key" in item && "name" in item.key) {
+ checkKey(node.parent, item.key.name);
+ }
+ });
+ }
+
+ // accessing key on process.env
+ else if (
+ "property" in node.parent &&
+ "name" in node.parent.property
+ ) {
+ checkKey(node.parent, node.parent.property?.name);
+ }
+ }
+ }
+ },
+ };
+}
+
+const rule = { create, meta };
+export default rule;
diff --git a/packages/eslint-plugin-turbo/lib/utils/getEnvVarDependencies.ts b/packages/eslint-plugin-turbo/lib/utils/getEnvVarDependencies.ts
new file mode 100644
index 0000000..a57e5eb
--- /dev/null
+++ b/packages/eslint-plugin-turbo/lib/utils/getEnvVarDependencies.ts
@@ -0,0 +1,75 @@
+import { getTurboConfigs } from "@turbo/utils";
+
+function findDependsOnEnvVars({
+ dependencies,
+}: {
+ dependencies?: Array<string>;
+}) {
+ if (dependencies) {
+ return (
+ dependencies
+ // filter for dep env vars
+ .filter((dep) => dep.startsWith("$"))
+ // remove leading $
+ .map((envVar) => envVar.slice(1, envVar.length))
+ );
+ }
+
+ return [];
+}
+
+function getEnvVarDependencies({
+ cwd,
+}: {
+ cwd: string | undefined;
+}): Record<string, Set<string>> | null {
+ const turboConfigs = getTurboConfigs(cwd);
+
+ if (!turboConfigs.length) {
+ return null;
+ }
+
+ const envVars: Record<string, Set<string>> = {
+ "//": new Set(),
+ };
+
+ turboConfigs.forEach((turboConfig) => {
+ const { config, workspacePath, isRootConfig } = turboConfig;
+
+ const key = isRootConfig ? "//" : workspacePath;
+ if (!envVars[key]) {
+ envVars[key] = new Set();
+ }
+
+ // handle globals
+ if (!("extends" in config)) {
+ const { globalDependencies = [], globalEnv = [] } = config;
+
+ const keys = [
+ ...findDependsOnEnvVars({
+ dependencies: globalDependencies,
+ }),
+ ...globalEnv,
+ ];
+ keys.forEach((k) => envVars[key].add(k));
+ }
+
+ // handle pipelines
+ const { pipeline = {} } = config;
+ Object.values(pipeline).forEach(({ env, dependsOn }) => {
+ if (dependsOn) {
+ findDependsOnEnvVars({ dependencies: dependsOn }).forEach((k) =>
+ envVars[key].add(k)
+ );
+ }
+
+ if (env) {
+ env.forEach((k) => envVars[key].add(k));
+ }
+ });
+ });
+
+ return envVars;
+}
+
+export default getEnvVarDependencies;
diff --git a/packages/eslint-plugin-turbo/package.json b/packages/eslint-plugin-turbo/package.json
new file mode 100644
index 0000000..d19eef2
--- /dev/null
+++ b/packages/eslint-plugin-turbo/package.json
@@ -0,0 +1,51 @@
+{
+ "name": "eslint-plugin-turbo",
+ "version": "1.9.4-canary.2",
+ "description": "ESLint plugin for Turborepo",
+ "keywords": [
+ "turbo",
+ "eslint",
+ "turborepo",
+ "eslintplugin",
+ "eslint-plugin"
+ ],
+ "repository": {
+ "type": "git",
+ "url": "https://github.com/vercel/turbo",
+ "directory": "packages/eslint-plugin-turbo"
+ },
+ "bugs": {
+ "url": "https://github.com/vercel/turbo/issues"
+ },
+ "author": "Vercel",
+ "main": "./dist/index.js",
+ "files": [
+ "dist/**"
+ ],
+ "scripts": {
+ "release": "pnpm build && pnpm publish",
+ "test": "jest",
+ "build": "tsup",
+ "check-types": "tsc --noEmit",
+ "lint": "eslint lib/**/*.ts"
+ },
+ "devDependencies": {
+ "@types/eslint": "^8.4.5",
+ "@types/estree": "^1.0.0",
+ "@types/jest": "^27.4.0",
+ "@types/node": "^16.11.12",
+ "jest": "^27.4.3",
+ "json5": "^2.2.1",
+ "ts-jest": "^27.1.1",
+ "@turbo/tsconfig": "workspace:*",
+ "tsup": "^6.2.0",
+ "@turbo/test-utils": "workspace:*",
+ "@turbo/types": "workspace:*",
+ "@turbo/utils": "workspace:*",
+ "typescript": "^4.7.4"
+ },
+ "peerDependencies": {
+ "eslint": ">6.6.0"
+ },
+ "license": "MPL-2.0"
+}
diff --git a/packages/eslint-plugin-turbo/tsconfig.json b/packages/eslint-plugin-turbo/tsconfig.json
new file mode 100644
index 0000000..0620a3c
--- /dev/null
+++ b/packages/eslint-plugin-turbo/tsconfig.json
@@ -0,0 +1,6 @@
+{
+ "extends": "@turbo/tsconfig/library.json",
+ "compilerOptions": {
+ "rootDir": "."
+ }
+}
diff --git a/packages/eslint-plugin-turbo/tsup.config.ts b/packages/eslint-plugin-turbo/tsup.config.ts
new file mode 100644
index 0000000..bbda8cb
--- /dev/null
+++ b/packages/eslint-plugin-turbo/tsup.config.ts
@@ -0,0 +1,8 @@
+import { defineConfig, Options } from "tsup";
+
+export default defineConfig((options: Options) => ({
+ entry: ["lib/index.ts"],
+ clean: true,
+ minify: true,
+ ...options,
+}));
diff --git a/packages/eslint-plugin-turbo/turbo.json b/packages/eslint-plugin-turbo/turbo.json
new file mode 100644
index 0000000..f86a4db
--- /dev/null
+++ b/packages/eslint-plugin-turbo/turbo.json
@@ -0,0 +1,9 @@
+{
+ "$schema": "../../docs/public/schema.json",
+ "extends": ["//"],
+ "pipeline": {
+ "test": {
+ "dependsOn": ["build"]
+ }
+ }
+}