@redmix/eslint-plugin 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Redmix
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,13 @@
+# ESLint Plugin
+
+Custom ESLint plugins used for standalone RedwoodJS ESLint lint rules.
+These rules are ment to be consumed via the larger
+[`@redwoodjs/eslint-config`](https://github.com/redwoodjs/redwood/tree/main/packages/eslint-config).
+
+## Contributing
+
+This package doesn't depend on other Redwood Framework packages.
+To contribute, you should be familiar with the ESLint package.
+Keep in mind that any rules added should not conflict with code formatting
+tools (e.g.
+[Prettier](https://prettier.io/docs/en/integrating-with-linters.html)).

package/dist/index.d.ts

@@ -0,0 +1,23 @@
+import type { ESLintUtils } from '@typescript-eslint/utils';
+export declare const meta: {
+    name: string;
+    version: any;
+};
+export declare const rules: {
+    'process-env-computed': ESLintUtils.RuleModule<"unexpected", [], unknown, ESLintUtils.RuleListener>;
+    'service-type-annotations': ESLintUtils.RuleModule<"needsType", [], unknown, ESLintUtils.RuleListener>;
+    'unsupported-route-components': ESLintUtils.RuleModule<"unexpected", [], unknown, ESLintUtils.RuleListener>;
+};
+declare const plugin: {
+    meta: {
+        name: string;
+        version: any;
+    };
+    rules: {
+        'process-env-computed': ESLintUtils.RuleModule<"unexpected", [], unknown, ESLintUtils.RuleListener>;
+        'service-type-annotations': ESLintUtils.RuleModule<"needsType", [], unknown, ESLintUtils.RuleListener>;
+        'unsupported-route-components': ESLintUtils.RuleModule<"unexpected", [], unknown, ESLintUtils.RuleListener>;
+    };
+};
+export default plugin;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAA;AAM3D,eAAO,MAAM,IAAI;;;CAGhB,CAAA;AAED,eAAO,MAAM,KAAK;;;;CAIwC,CAAA;AAE1D,QAAA,MAAM,MAAM;;;;;;;;;;CAAkB,CAAA;AAE9B,eAAe,MAAM,CAAA"}

package/dist/index.js

@@ -0,0 +1,44 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var index_exports = {};
+__export(index_exports, {
+  default: () => index_default,
+  meta: () => meta,
+  rules: () => rules
+});
+module.exports = __toCommonJS(index_exports);
+var import_process_env_computed = require("./process-env-computed.js");
+var import_service_type_annotations = require("./service-type-annotations.js");
+var import_unsupported_route_components = require("./unsupported-route-components.js");
+const meta = {
+  name: "@redmix/eslint-plugin",
+  version: require("../package.json").version
+};
+const rules = {
+  "process-env-computed": import_process_env_computed.processEnvComputedRule,
+  "service-type-annotations": import_service_type_annotations.serviceTypeAnnotations,
+  "unsupported-route-components": import_unsupported_route_components.unsupportedRouteComponents
+};
+const plugin = { meta, rules };
+var index_default = plugin;
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  meta,
+  rules
+});

package/dist/process-env-computed.d.ts

@@ -0,0 +1,3 @@
+import { ESLintUtils } from '@typescript-eslint/utils';
+export declare const processEnvComputedRule: ESLintUtils.RuleModule<"unexpected", [], unknown, ESLintUtils.RuleListener>;
+//# sourceMappingURL=process-env-computed.d.ts.map

package/dist/process-env-computed.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"process-env-computed.d.ts","sourceRoot":"","sources":["../src/process-env-computed.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAkB,MAAM,0BAA0B,CAAA;AAoCtE,eAAO,MAAM,sBAAsB,6EA8BjC,CAAA"}

package/dist/process-env-computed.js

@@ -0,0 +1,65 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var process_env_computed_exports = {};
+__export(process_env_computed_exports, {
+  processEnvComputedRule: () => processEnvComputedRule
+});
+module.exports = __toCommonJS(process_env_computed_exports);
+var import_utils = require("@typescript-eslint/utils");
+const createRule = import_utils.ESLintUtils.RuleCreator.withoutDocs;
+function isProcessEnv(node) {
+  return node.type === import_utils.AST_NODE_TYPES.MemberExpression && hasName(node.object, "process") && hasName(node.property, "env");
+}
+function hasName(node, name) {
+  return node.type === import_utils.AST_NODE_TYPES.Identifier && node.name === name;
+}
+function isTestFile(filename) {
+  return filename.endsWith(".test.ts") || filename.endsWith(".test.js") || filename.endsWith(".test.tsx") || filename.endsWith(".test.jsx") || filename.endsWith(".test.mts") || filename.endsWith(".test.mjs") || filename.endsWith(".test.cjs") || filename.endsWith(".spec.ts") || filename.endsWith(".spec.js") || filename.endsWith(".spec.tsx") || filename.endsWith(".spec.jsx") || filename.endsWith(".spec.mts") || filename.endsWith(".spec.mjs") || filename.endsWith(".spec.cjs") || filename.includes("/__tests__/");
+}
+const processEnvComputedRule = createRule({
+  meta: {
+    type: "problem",
+    docs: {
+      description: "Find computed member access on process.env"
+    },
+    messages: {
+      unexpected: "Accessing process.env via array syntax will break in production. Use dot notation e.g. process.env.MY_ENV_VAR instead"
+    },
+    schema: []
+    // No additional configuration needed
+  },
+  defaultOptions: [],
+  create(context) {
+    return {
+      MemberExpression: function(node) {
+        const matches = isProcessEnv(node.object) && node.computed && !isTestFile(context.filename);
+        if (matches) {
+          context.report({
+            messageId: "unexpected",
+            node
+          });
+        }
+      }
+    };
+  }
+});
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  processEnvComputedRule
+});

package/dist/service-type-annotations.d.ts

@@ -0,0 +1,3 @@
+import { ESLintUtils } from '@typescript-eslint/utils';
+export declare const serviceTypeAnnotations: ESLintUtils.RuleModule<"needsType", [], unknown, ESLintUtils.RuleListener>;
+//# sourceMappingURL=service-type-annotations.d.ts.map

package/dist/service-type-annotations.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"service-type-annotations.d.ts","sourceRoot":"","sources":["../src/service-type-annotations.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,WAAW,EAAkB,MAAM,0BAA0B,CAAA;AAOtE,eAAO,MAAM,sBAAsB,4EA0JjC,CAAA"}

package/dist/service-type-annotations.js

@@ -0,0 +1,140 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var service_type_annotations_exports = {};
+__export(service_type_annotations_exports, {
+  serviceTypeAnnotations: () => serviceTypeAnnotations
+});
+module.exports = __toCommonJS(service_type_annotations_exports);
+var import_node_path = require("node:path");
+var import_utils = require("@typescript-eslint/utils");
+const createRule = import_utils.ESLintUtils.RuleCreator.withoutDocs;
+const capitalizeFirstLetter = (str) => str.charAt(0).toUpperCase() + str.slice(1);
+const serviceTypeAnnotations = createRule({
+  meta: {
+    docs: {
+      description: "Sets the types on a query/mutation resolver function to the correct type"
+    },
+    messages: {
+      needsType: "The query/mutation function ({{name}}) needs a type annotation of {{typeName}}."
+    },
+    fixable: "code",
+    type: "suggestion",
+    schema: []
+  },
+  defaultOptions: [],
+  create(context) {
+    const thisFilename = (0, import_node_path.basename)(context.filename);
+    const sansTS = thisFilename.replace(".ts", "");
+    const thisFileCorrespondingImport = `types/${sansTS}`;
+    let importForThisFile = null;
+    return {
+      // Make sure we have a reference to the import for the relative file
+      // which includes definitions for this service
+      ImportDeclaration(node) {
+        importForThisFile ||= node.source.value === thisFileCorrespondingImport ? node : null;
+      },
+      // Then start looking at every exported fn/const
+      ExportNamedDeclaration(node) {
+        if (!node.declaration || node.declaration.type !== import_utils.AST_NODE_TYPES.VariableDeclaration) {
+          return;
+        }
+        node.declaration.declarations.forEach((vd) => {
+          if (vd.type === import_utils.AST_NODE_TYPES.VariableDeclarator && vd.id.type === import_utils.AST_NODE_TYPES.Identifier) {
+            if (vd.id.name.startsWith("_")) {
+              return;
+            }
+            const isGlobalOrMutationResolver = /^[a-z]/.test(vd.id.name);
+            const suffix = isGlobalOrMutationResolver ? "Resolver" : "TypeResolvers";
+            const typeName = capitalizeFirstLetter(vd.id.name) + suffix;
+            if (isGlobalOrMutationResolver && vd.init?.type !== import_utils.AST_NODE_TYPES.ArrowFunctionExpression) {
+              return;
+            }
+            const tsID = vd.id;
+            if (!tsID.typeAnnotation) {
+              context.report({
+                messageId: "needsType",
+                node: vd.id,
+                data: {
+                  name: vd.id.name,
+                  typeName
+                },
+                *fix(fixer) {
+                  yield fixer.insertTextAfter(vd.id, `: ${typeName}`);
+                  if (!importForThisFile) {
+                    yield fixer.insertTextBeforeRange(
+                      [0, 0],
+                      `import type { ${typeName} } from "${thisFileCorrespondingImport}"
+`
+                    );
+                  } else {
+                    const lastImportSpecifier = importForThisFile.specifiers[importForThisFile.specifiers.length - 1];
+                    yield fixer.insertTextAfter(
+                      lastImportSpecifier,
+                      `, ${typeName}`
+                    );
+                  }
+                }
+              });
+              return;
+            }
+            if (tsID.typeAnnotation.typeAnnotation) {
+              const type = tsID.typeAnnotation.typeAnnotation;
+              if (!("typeName" in type)) {
+                return;
+              }
+              const isCorrectType = type.typeName?.type === import_utils.AST_NODE_TYPES.Identifier && type.typeName?.name === typeName;
+              if (isCorrectType) {
+                return;
+              }
+              context.report({
+                messageId: "needsType",
+                node: vd.id,
+                data: {
+                  name: vd.id.name,
+                  typeName
+                },
+                *fix(fixer) {
+                  yield fixer.removeRange([type.range[0] - 2, type.range[1]]);
+                  yield fixer.insertTextAfter(vd.id, `: ${typeName}`);
+                  if (!importForThisFile) {
+                    yield fixer.insertTextBeforeRange(
+                      [0, 0],
+                      `import type { ${typeName} } from "${thisFileCorrespondingImport}"
+`
+                    );
+                  } else {
+                    const lastImportSpecifier = importForThisFile.specifiers[importForThisFile.specifiers.length - 1];
+                    yield fixer.insertTextAfter(
+                      lastImportSpecifier,
+                      `, ${typeName}`
+                    );
+                  }
+                }
+              });
+            }
+          }
+        });
+      }
+    };
+  }
+});
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  serviceTypeAnnotations
+});

package/dist/unsupported-route-components.d.ts

@@ -0,0 +1,3 @@
+import { ESLintUtils } from '@typescript-eslint/utils';
+export declare const unsupportedRouteComponents: ESLintUtils.RuleModule<"unexpected", [], unknown, ESLintUtils.RuleListener>;
+//# sourceMappingURL=unsupported-route-components.d.ts.map

package/dist/unsupported-route-components.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"unsupported-route-components.d.ts","sourceRoot":"","sources":["../src/unsupported-route-components.ts"],"names":[],"mappings":"AACA,OAAO,EAAkB,WAAW,EAAE,MAAM,0BAA0B,CAAA;AAiCtE,eAAO,MAAM,0BAA0B,6EA8CrC,CAAA"}

package/dist/unsupported-route-components.js

@@ -0,0 +1,83 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var unsupported_route_components_exports = {};
+__export(unsupported_route_components_exports, {
+  unsupportedRouteComponents: () => unsupportedRouteComponents
+});
+module.exports = __toCommonJS(unsupported_route_components_exports);
+var import_utils = require("@typescript-eslint/utils");
+const createRule = import_utils.ESLintUtils.RuleCreator.withoutDocs;
+function isAllowedElement(name) {
+  const allowedElements = ["Router", "Route", "Set", "PrivateSet", "Private"];
+  return allowedElements.includes(name);
+}
+function checkNodes(nodesToCheck, context) {
+  if (nodesToCheck.type === import_utils.AST_NODE_TYPES.JSXElement) {
+    const name = nodesToCheck.openingElement.name.type === import_utils.AST_NODE_TYPES.JSXIdentifier ? nodesToCheck.openingElement.name.name : null;
+    if (name && !isAllowedElement(name)) {
+      context.report({
+        node: nodesToCheck,
+        messageId: "unexpected",
+        data: { name }
+      });
+    }
+    if (nodesToCheck.children) {
+      nodesToCheck.children.forEach((node) => checkNodes(node, context));
+    }
+  }
+}
+const unsupportedRouteComponents = createRule({
+  meta: {
+    type: "problem",
+    docs: {
+      description: "Find unsupported route components"
+    },
+    messages: {
+      unexpected: "Unexpected JSX element <{{name}}>. Only <Router>, <Route>, <Set>, <PrivateSet> and <Private> are allowed in the Routes component."
+    },
+    schema: []
+  },
+  defaultOptions: [],
+  create(context) {
+    return {
+      VariableDeclaration(node) {
+        if (isRoutesRenderBlock(node.declarations[0])) {
+          const routesDeclaration = node.declarations[0].init;
+          if (routesDeclaration?.type === import_utils.AST_NODE_TYPES.ArrowFunctionExpression) {
+            if (routesDeclaration.body.type === import_utils.AST_NODE_TYPES.JSXElement) {
+              checkNodes(routesDeclaration.body, context);
+            } else if (routesDeclaration.body.type === import_utils.AST_NODE_TYPES.BlockStatement) {
+              if (routesDeclaration.body.body[0].type === import_utils.AST_NODE_TYPES.ReturnStatement && routesDeclaration.body.body[0].argument?.type === import_utils.AST_NODE_TYPES.JSXElement) {
+                const routesReturnStatement = routesDeclaration.body.body[0].argument;
+                checkNodes(routesReturnStatement, context);
+              }
+            }
+          }
+        }
+      }
+    };
+  }
+});
+function isRoutesRenderBlock(node) {
+  return node?.type === import_utils.AST_NODE_TYPES.VariableDeclarator && node?.id.type === import_utils.AST_NODE_TYPES.Identifier && node?.id.name === "Routes";
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  unsupportedRouteComponents
+});

package/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "@redmix/eslint-plugin",
+  "version": "0.0.1",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/redmix-run/redmix.git",
+    "directory": "packages/eslint-plugin"
+  },
+  "license": "MIT",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsx ./build.mts && yarn build:types",
+    "build:pack": "yarn pack -o redmix-eslint-plugin.tgz",
+    "build:types": "tsc --build --verbose",
+    "build:watch": "nodemon --watch src --ext \"js,jsx,ts,tsx\" --ignore dist --exec \"yarn build\"",
+    "prepublishOnly": "NODE_ENV=production yarn build",
+    "test": "vitest run",
+    "test:watch": "vitest watch"
+  },
+  "dependencies": {
+    "@typescript-eslint/utils": "8.19.1",
+    "eslint": "8.57.1"
+  },
+  "devDependencies": {
+    "@redmix/framework-tools": "0.0.1",
+    "@types/eslint": "8.56.12",
+    "@types/estree": "1.0.6",
+    "@typescript-eslint/parser": "8.19.1",
+    "@typescript-eslint/rule-tester": "8.19.1",
+    "tsx": "4.19.3",
+    "typescript": "5.6.2",
+    "vitest": "2.1.9"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "gitHead": "688027c97502c500ebbede9cdc7cc51545a8dcf3"
+}