aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/packages/eslint-plugin-turbo/lib/rules
diff options
context:
space:
mode:
author简律纯 <i@jyunko.cn>2023-11-03 21:25:40 +0800
committer简律纯 <i@jyunko.cn>2023-11-03 21:25:40 +0800
commit9029588590bea8b10451575c5142dcde77ecd1b5 (patch)
tree04cf8aee56c23fd225ff19d340f7cee621d874ef /packages/eslint-plugin-turbo/lib/rules
parent94071d7ce16c56641d67d488e2bac6be84ffe731 (diff)
downloadHydroRoll-9029588590bea8b10451575c5142dcde77ecd1b5.tar.gz
HydroRoll-9029588590bea8b10451575c5142dcde77ecd1b5.zip
chore: delete useless files
Diffstat (limited to 'packages/eslint-plugin-turbo/lib/rules')
-rw-r--r--packages/eslint-plugin-turbo/lib/rules/no-undeclared-env-vars.ts187
1 files changed, 0 insertions, 187 deletions
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
deleted file mode 100644
index 372d21a..0000000
--- a/packages/eslint-plugin-turbo/lib/rules/no-undeclared-env-vars.ts
+++ /dev/null
@@ -1,187 +0,0 @@
-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;