@cmssy/eslint-plugin 12.12.0 → 12.14.0

package/dist/index.cjs

@@ -2,10 +2,15 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
+var tsParser = require('@typescript-eslint/parser');
 var fs = require('fs');
 var path = require('path');
 
-// src/edit-route-provider-parity.ts
+function _interopDefault (e) { return e && e.__esModule ? e : { default: e }; }
+
+var tsParser__default = /*#__PURE__*/_interopDefault(tsParser);
+
+// src/index.ts
 var LAYOUT = /\/layout\.(tsx|jsx|js|ts)$/;
 var EDIT_SEGMENT = "cmssy-edit";
 var WRAPPERS = /* @__PURE__ */ new Set([
@@ -91,6 +96,11 @@ var editRouteProviderParity = {
 };
 var SERVER_MODULES = [/^@cmssy\/next\/server$/];
 var SERVER_SYMBOLS = /* @__PURE__ */ new Set(["defineCmssyConfig"]);
+var SERVER_ENV_NAME = "CMSSY_[A-Z0-9_]+";
+var SERVER_ENV = new RegExp(`^${SERVER_ENV_NAME}$`);
+var SERVER_ENV_READ = new RegExp(
+  `\\bprocess\\s*\\.\\s*env\\s*(?:\\.\\s*${SERVER_ENV_NAME}|\\[\\s*["'\`]${SERVER_ENV_NAME}["'\`]\\s*\\])`
+);
 var EXTENSIONS = ["", ".ts", ".tsx", ".js", ".jsx", ".mjs"];
 var aliasCache = /* @__PURE__ */ new Map();
 function stripJsonComments(text) {
@@ -218,7 +228,25 @@ function valueImports(code) {
     ...withoutTypes.matchAll(/(?:from|import)\s*["']([^"']+)["']/g)
   ].map(([, specifier]) => specifier ?? "");
 }
+function readsServerEnv(code) {
+  return SERVER_ENV_READ.test(code);
+}
+function serverEnvName(node) {
+  const member = node;
+  const env = member.object;
+  if (env?.type !== "MemberExpression" || env.computed) return null;
+  if (env.object?.type !== "Identifier" || env.object.name !== "process") {
+    return null;
+  }
+  if (env.property?.type !== "Identifier" || env.property.name !== "env") {
+    return null;
+  }
+  const property = member.property;
+  const name = member.computed ? typeof property?.value === "string" ? property.value : null : property?.type === "Identifier" ? property.name ?? null : null;
+  return name && SERVER_ENV.test(name) ? name : null;
+}
 function importsServerConfig(code) {
+  if (readsServerEnv(code)) return true;
   if (SERVER_MODULES.some(
     (pattern) => valueImports(code).some((s) => pattern.test(s))
   )) {
@@ -285,7 +313,7 @@ var noServerConfigInClient = {
   meta: {
     type: "problem",
     docs: {
-      description: "Disallow a client component from importing values that read the cmssy server config"
+      description: "Disallow a client component from importing values that read the cmssy server config, or reading a CMSSY_* variable itself"
     },
     schema: [
       {
@@ -300,8 +328,9 @@ var noServerConfigInClient = {
       }
     ],
     messages: {
-      reachesConfig: 'This client component pulls the cmssy config into the browser bundle, where server env does not exist - the page will fail at runtime with "missing required configuration".\n  {{chain}}\nImport the type instead (types are erased), or move the value into a module that does not touch the config.',
-      reachesConfigFromEntry: "This module is loaded in the browser, so it pulls the cmssy config there, where server env does not exist.\n  {{chain}}\nImport the type instead (types are erased), or load the value with a dynamic import inside the function that needs it."
+      reachesConfig: 'This client component pulls the cmssy config into the browser bundle, where server env does not exist - the page fails at runtime with "missing required configuration", or reads whatever the config falls back to, which is usually "".\n  {{chain}}\nImport the type instead (types are erased), or move the value into a module that does not touch the config.',
+      reachesConfigFromEntry: "This module is loaded in the browser, so it pulls the cmssy config there, where server env does not exist.\n  {{chain}}\nImport the type instead (types are erased), or load the value with a dynamic import inside the function that needs it.",
+      readsServerEnv: "{{name}} is read here and this module runs in the browser, where it is undefined - the bundler only inlines NEXT_PUBLIC_* names, and a draft secret must never be one.\nRead it in a server component and pass the value down as a prop."
     }
   },
   create(context) {
@@ -313,6 +342,11 @@ var noServerConfigInClient = {
     if (!client && !entry) return {};
     const messageId = client ? "reachesConfig" : "reachesConfigFromEntry";
     return {
+      MemberExpression(node) {
+        const name = serverEnvName(node);
+        if (!name) return;
+        context.report({ node, messageId: "readsServerEnv", data: { name } });
+      },
       ImportDeclaration(node) {
         const typed = node;
         const onlyTypes = typed.importKind === "type" || node.specifiers.length > 0 && node.specifiers.every(
@@ -363,6 +397,29 @@ plugin.configs.recommended = [
     }
   }
 ];
+plugin.configs.standalone = [
+  {
+    ignores: [
+      "**/.next/**",
+      "**/.astro/**",
+      "**/.react-router/**",
+      "**/.vercel/**",
+      "**/build/**",
+      "**/coverage/**",
+      "**/dist/**",
+      "**/out/**"
+    ]
+  },
+  {
+    files: ["**/*.{js,jsx,mjs,cjs,ts,tsx,mts,cts}"],
+    languageOptions: {
+      parser: tsParser__default.default,
+      sourceType: "module",
+      parserOptions: { ecmaFeatures: { jsx: true } }
+    }
+  },
+  ...plugin.configs.recommended
+];
 var index_default = plugin;
 
 exports.default = index_default;

package/dist/index.js

@@ -1,7 +1,8 @@
+import tsParser from '@typescript-eslint/parser';
 import { readFileSync, existsSync } from 'fs';
 import { isAbsolute, resolve, dirname, sep } from 'path';
 
-// src/edit-route-provider-parity.ts
+// src/index.ts
 var LAYOUT = /\/layout\.(tsx|jsx|js|ts)$/;
 var EDIT_SEGMENT = "cmssy-edit";
 var WRAPPERS = /* @__PURE__ */ new Set([
@@ -87,6 +88,11 @@ var editRouteProviderParity = {
 };
 var SERVER_MODULES = [/^@cmssy\/next\/server$/];
 var SERVER_SYMBOLS = /* @__PURE__ */ new Set(["defineCmssyConfig"]);
+var SERVER_ENV_NAME = "CMSSY_[A-Z0-9_]+";
+var SERVER_ENV = new RegExp(`^${SERVER_ENV_NAME}$`);
+var SERVER_ENV_READ = new RegExp(
+  `\\bprocess\\s*\\.\\s*env\\s*(?:\\.\\s*${SERVER_ENV_NAME}|\\[\\s*["'\`]${SERVER_ENV_NAME}["'\`]\\s*\\])`
+);
 var EXTENSIONS = ["", ".ts", ".tsx", ".js", ".jsx", ".mjs"];
 var aliasCache = /* @__PURE__ */ new Map();
 function stripJsonComments(text) {
@@ -214,7 +220,25 @@ function valueImports(code) {
     ...withoutTypes.matchAll(/(?:from|import)\s*["']([^"']+)["']/g)
   ].map(([, specifier]) => specifier ?? "");
 }
+function readsServerEnv(code) {
+  return SERVER_ENV_READ.test(code);
+}
+function serverEnvName(node) {
+  const member = node;
+  const env = member.object;
+  if (env?.type !== "MemberExpression" || env.computed) return null;
+  if (env.object?.type !== "Identifier" || env.object.name !== "process") {
+    return null;
+  }
+  if (env.property?.type !== "Identifier" || env.property.name !== "env") {
+    return null;
+  }
+  const property = member.property;
+  const name = member.computed ? typeof property?.value === "string" ? property.value : null : property?.type === "Identifier" ? property.name ?? null : null;
+  return name && SERVER_ENV.test(name) ? name : null;
+}
 function importsServerConfig(code) {
+  if (readsServerEnv(code)) return true;
   if (SERVER_MODULES.some(
     (pattern) => valueImports(code).some((s) => pattern.test(s))
   )) {
@@ -281,7 +305,7 @@ var noServerConfigInClient = {
   meta: {
     type: "problem",
     docs: {
-      description: "Disallow a client component from importing values that read the cmssy server config"
+      description: "Disallow a client component from importing values that read the cmssy server config, or reading a CMSSY_* variable itself"
     },
     schema: [
       {
@@ -296,8 +320,9 @@ var noServerConfigInClient = {
       }
     ],
     messages: {
-      reachesConfig: 'This client component pulls the cmssy config into the browser bundle, where server env does not exist - the page will fail at runtime with "missing required configuration".\n  {{chain}}\nImport the type instead (types are erased), or move the value into a module that does not touch the config.',
-      reachesConfigFromEntry: "This module is loaded in the browser, so it pulls the cmssy config there, where server env does not exist.\n  {{chain}}\nImport the type instead (types are erased), or load the value with a dynamic import inside the function that needs it."
+      reachesConfig: 'This client component pulls the cmssy config into the browser bundle, where server env does not exist - the page fails at runtime with "missing required configuration", or reads whatever the config falls back to, which is usually "".\n  {{chain}}\nImport the type instead (types are erased), or move the value into a module that does not touch the config.',
+      reachesConfigFromEntry: "This module is loaded in the browser, so it pulls the cmssy config there, where server env does not exist.\n  {{chain}}\nImport the type instead (types are erased), or load the value with a dynamic import inside the function that needs it.",
+      readsServerEnv: "{{name}} is read here and this module runs in the browser, where it is undefined - the bundler only inlines NEXT_PUBLIC_* names, and a draft secret must never be one.\nRead it in a server component and pass the value down as a prop."
     }
   },
   create(context) {
@@ -309,6 +334,11 @@ var noServerConfigInClient = {
     if (!client && !entry) return {};
     const messageId = client ? "reachesConfig" : "reachesConfigFromEntry";
     return {
+      MemberExpression(node) {
+        const name = serverEnvName(node);
+        if (!name) return;
+        context.report({ node, messageId: "readsServerEnv", data: { name } });
+      },
       ImportDeclaration(node) {
         const typed = node;
         const onlyTypes = typed.importKind === "type" || node.specifiers.length > 0 && node.specifiers.every(
@@ -359,6 +389,29 @@ plugin.configs.recommended = [
     }
   }
 ];
+plugin.configs.standalone = [
+  {
+    ignores: [
+      "**/.next/**",
+      "**/.astro/**",
+      "**/.react-router/**",
+      "**/.vercel/**",
+      "**/build/**",
+      "**/coverage/**",
+      "**/dist/**",
+      "**/out/**"
+    ]
+  },
+  {
+    files: ["**/*.{js,jsx,mjs,cjs,ts,tsx,mts,cts}"],
+    languageOptions: {
+      parser: tsParser,
+      sourceType: "module",
+      parserOptions: { ecmaFeatures: { jsx: true } }
+    }
+  },
+  ...plugin.configs.recommended
+];
 var index_default = plugin;
 
 export { index_default as default, editRouteProviderParity, noServerConfigInClient, rules };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cmssy/eslint-plugin",
-  "version": "12.12.0",
+  "version": "12.14.0",
   "description": "Catches the cmssy wiring mistakes that a build cannot: server config dragged into a client bundle, a provider the editor route never gets.",
   "keywords": [
     "cmssy",
@@ -37,9 +37,11 @@
   "files": [
     "dist"
   ],
+  "dependencies": {
+    "@typescript-eslint/parser": "^8.0.0"
+  },
   "devDependencies": {
     "@types/node": "^20.0.0",
-    "@typescript-eslint/parser": "^8.0.0",
     "eslint": "^9.0.0",
     "tsup": "^8.3.0",
     "typescript": "^5.6.0",