@cmssy/eslint-plugin 5.0.0

package/dist/index.cjs

@@ -0,0 +1,147 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var fs = require('fs');
+var path = require('path');
+
+// src/no-server-config-in-client.ts
+var SERVER_MODULES = [/^@cmssy\/next\/server$/];
+var SERVER_SYMBOLS = /* @__PURE__ */ new Set(["defineCmssyConfig"]);
+var EXTENSIONS = ["", ".ts", ".tsx", ".js", ".jsx", ".mjs"];
+function resolveLocal(fromFile, specifier) {
+  if (!specifier.startsWith(".")) return null;
+  const base = path.resolve(path.dirname(fromFile), specifier);
+  for (const ext of EXTENSIONS) {
+    const candidate = `${base}${ext}`;
+    if (fs.existsSync(candidate) && !candidate.endsWith("/")) return candidate;
+  }
+  for (const ext of EXTENSIONS.slice(1)) {
+    const candidate = `${base}/index${ext}`;
+    if (fs.existsSync(candidate)) return candidate;
+  }
+  return null;
+}
+function valueImports(code) {
+  const withoutTypes = code.replace(
+    /^\s*(?:import|export)\s+type\s[^;]*;/gm,
+    ""
+  );
+  return [
+    ...withoutTypes.matchAll(/(?:from|import)\s*\(?\s*["']([^"']+)["']/g)
+  ].map(([, specifier]) => specifier ?? "");
+}
+function importsServerConfig(code) {
+  if (SERVER_MODULES.some(
+    (pattern) => valueImports(code).some((s) => pattern.test(s))
+  )) {
+    return true;
+  }
+  return [...SERVER_SYMBOLS].some(
+    (symbol) => new RegExp(`\\b${symbol}\\b`).test(
+      code.replace(/^\s*(?:import|export)\s+type\s[^;]*;/gm, "")
+    )
+  );
+}
+function chainToServerConfig(file, cache2, seen = /* @__PURE__ */ new Set()) {
+  if (seen.has(file)) return null;
+  seen.add(file);
+  const cached = cache2.get(file);
+  if (cached !== void 0) return cached;
+  let code;
+  try {
+    code = fs.readFileSync(file, "utf8");
+  } catch {
+    cache2.set(file, null);
+    return null;
+  }
+  if (importsServerConfig(code)) {
+    const chain = [file];
+    cache2.set(file, chain);
+    return chain;
+  }
+  for (const specifier of valueImports(code)) {
+    const next = resolveLocal(file, specifier);
+    if (!next) continue;
+    const deeper = chainToServerConfig(next, cache2, seen);
+    if (deeper) {
+      const chain = [file, ...deeper];
+      cache2.set(file, chain);
+      return chain;
+    }
+  }
+  cache2.set(file, null);
+  return null;
+}
+function isClientFile(source) {
+  return /^\s*(?:\/\/[^\n]*\n|\/\*[\s\S]*?\*\/\s*)*["']use client["']/.test(
+    source
+  );
+}
+var cache = /* @__PURE__ */ new Map();
+var noServerConfigInClient = {
+  meta: {
+    type: "problem",
+    docs: {
+      description: "Disallow a client component from importing values that read the cmssy server config"
+    },
+    schema: [],
+    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.'
+    }
+  },
+  create(context) {
+    const filename = context.filename ?? context.getFilename();
+    if (!isClientFile(context.sourceCode.getText())) return {};
+    return {
+      ImportDeclaration(node) {
+        const typed = node;
+        const onlyTypes = typed.importKind === "type" || node.specifiers.length > 0 && node.specifiers.every(
+          (s) => s.importKind === "type"
+        );
+        if (onlyTypes) return;
+        const specifier = String(node.source.value);
+        if (SERVER_MODULES.some((pattern) => pattern.test(specifier))) {
+          context.report({
+            node,
+            messageId: "reachesConfig",
+            data: { chain: `${specifier} is server-only` }
+          });
+          return;
+        }
+        const target = resolveLocal(filename, specifier);
+        if (!target) return;
+        const chain = chainToServerConfig(target, cache);
+        if (!chain) return;
+        context.report({
+          node,
+          messageId: "reachesConfig",
+          data: {
+            chain: [filename, ...chain].map((f) => f.split("/").slice(-2).join("/")).join(" -> ")
+          }
+        });
+      }
+    };
+  }
+};
+
+// src/index.ts
+var rules = {
+  "no-server-config-in-client": noServerConfigInClient
+};
+var plugin = {
+  meta: { name: "@cmssy/eslint-plugin" },
+  rules,
+  configs: {}
+};
+plugin.configs.recommended = [
+  {
+    plugins: { cmssy: plugin },
+    rules: { "cmssy/no-server-config-in-client": "error" }
+  }
+];
+var index_default = plugin;
+
+exports.default = index_default;
+exports.noServerConfigInClient = noServerConfigInClient;
+exports.rules = rules;

package/dist/index.d.cts

@@ -0,0 +1,19 @@
+import * as eslint from 'eslint';
+import { Rule } from 'eslint';
+
+declare const noServerConfigInClient: Rule.RuleModule;
+
+declare const rules: {
+    "no-server-config-in-client": eslint.Rule.RuleModule;
+};
+declare const plugin: {
+    meta: {
+        name: string;
+    };
+    rules: {
+        "no-server-config-in-client": eslint.Rule.RuleModule;
+    };
+    configs: Record<string, unknown>;
+};
+
+export { plugin as default, noServerConfigInClient, rules };

package/dist/index.d.ts

@@ -0,0 +1,19 @@
+import * as eslint from 'eslint';
+import { Rule } from 'eslint';
+
+declare const noServerConfigInClient: Rule.RuleModule;
+
+declare const rules: {
+    "no-server-config-in-client": eslint.Rule.RuleModule;
+};
+declare const plugin: {
+    meta: {
+        name: string;
+    };
+    rules: {
+        "no-server-config-in-client": eslint.Rule.RuleModule;
+    };
+    configs: Record<string, unknown>;
+};
+
+export { plugin as default, noServerConfigInClient, rules };

package/dist/index.js

@@ -0,0 +1,141 @@
+import { existsSync, readFileSync } from 'fs';
+import { resolve, dirname } from 'path';
+
+// src/no-server-config-in-client.ts
+var SERVER_MODULES = [/^@cmssy\/next\/server$/];
+var SERVER_SYMBOLS = /* @__PURE__ */ new Set(["defineCmssyConfig"]);
+var EXTENSIONS = ["", ".ts", ".tsx", ".js", ".jsx", ".mjs"];
+function resolveLocal(fromFile, specifier) {
+  if (!specifier.startsWith(".")) return null;
+  const base = resolve(dirname(fromFile), specifier);
+  for (const ext of EXTENSIONS) {
+    const candidate = `${base}${ext}`;
+    if (existsSync(candidate) && !candidate.endsWith("/")) return candidate;
+  }
+  for (const ext of EXTENSIONS.slice(1)) {
+    const candidate = `${base}/index${ext}`;
+    if (existsSync(candidate)) return candidate;
+  }
+  return null;
+}
+function valueImports(code) {
+  const withoutTypes = code.replace(
+    /^\s*(?:import|export)\s+type\s[^;]*;/gm,
+    ""
+  );
+  return [
+    ...withoutTypes.matchAll(/(?:from|import)\s*\(?\s*["']([^"']+)["']/g)
+  ].map(([, specifier]) => specifier ?? "");
+}
+function importsServerConfig(code) {
+  if (SERVER_MODULES.some(
+    (pattern) => valueImports(code).some((s) => pattern.test(s))
+  )) {
+    return true;
+  }
+  return [...SERVER_SYMBOLS].some(
+    (symbol) => new RegExp(`\\b${symbol}\\b`).test(
+      code.replace(/^\s*(?:import|export)\s+type\s[^;]*;/gm, "")
+    )
+  );
+}
+function chainToServerConfig(file, cache2, seen = /* @__PURE__ */ new Set()) {
+  if (seen.has(file)) return null;
+  seen.add(file);
+  const cached = cache2.get(file);
+  if (cached !== void 0) return cached;
+  let code;
+  try {
+    code = readFileSync(file, "utf8");
+  } catch {
+    cache2.set(file, null);
+    return null;
+  }
+  if (importsServerConfig(code)) {
+    const chain = [file];
+    cache2.set(file, chain);
+    return chain;
+  }
+  for (const specifier of valueImports(code)) {
+    const next = resolveLocal(file, specifier);
+    if (!next) continue;
+    const deeper = chainToServerConfig(next, cache2, seen);
+    if (deeper) {
+      const chain = [file, ...deeper];
+      cache2.set(file, chain);
+      return chain;
+    }
+  }
+  cache2.set(file, null);
+  return null;
+}
+function isClientFile(source) {
+  return /^\s*(?:\/\/[^\n]*\n|\/\*[\s\S]*?\*\/\s*)*["']use client["']/.test(
+    source
+  );
+}
+var cache = /* @__PURE__ */ new Map();
+var noServerConfigInClient = {
+  meta: {
+    type: "problem",
+    docs: {
+      description: "Disallow a client component from importing values that read the cmssy server config"
+    },
+    schema: [],
+    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.'
+    }
+  },
+  create(context) {
+    const filename = context.filename ?? context.getFilename();
+    if (!isClientFile(context.sourceCode.getText())) return {};
+    return {
+      ImportDeclaration(node) {
+        const typed = node;
+        const onlyTypes = typed.importKind === "type" || node.specifiers.length > 0 && node.specifiers.every(
+          (s) => s.importKind === "type"
+        );
+        if (onlyTypes) return;
+        const specifier = String(node.source.value);
+        if (SERVER_MODULES.some((pattern) => pattern.test(specifier))) {
+          context.report({
+            node,
+            messageId: "reachesConfig",
+            data: { chain: `${specifier} is server-only` }
+          });
+          return;
+        }
+        const target = resolveLocal(filename, specifier);
+        if (!target) return;
+        const chain = chainToServerConfig(target, cache);
+        if (!chain) return;
+        context.report({
+          node,
+          messageId: "reachesConfig",
+          data: {
+            chain: [filename, ...chain].map((f) => f.split("/").slice(-2).join("/")).join(" -> ")
+          }
+        });
+      }
+    };
+  }
+};
+
+// src/index.ts
+var rules = {
+  "no-server-config-in-client": noServerConfigInClient
+};
+var plugin = {
+  meta: { name: "@cmssy/eslint-plugin" },
+  rules,
+  configs: {}
+};
+plugin.configs.recommended = [
+  {
+    plugins: { cmssy: plugin },
+    rules: { "cmssy/no-server-config-in-client": "error" }
+  }
+];
+var index_default = plugin;
+
+export { index_default as default, noServerConfigInClient, rules };

package/package.json

@@ -0,0 +1,51 @@
+{
+  "name": "@cmssy/eslint-plugin",
+  "version": "5.0.0",
+  "description": "Catches the cmssy wiring mistakes that a build cannot: server config dragged into a client bundle.",
+  "keywords": [
+    "cmssy",
+    "eslint",
+    "eslintplugin",
+    "next"
+  ],
+  "homepage": "https://cmssy.com",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/cmssy-io/cmssy-sdk.git",
+    "directory": "packages/eslint-plugin"
+  },
+  "type": "module",
+  "license": "MIT",
+  "publishConfig": {
+    "access": "public"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "devDependencies": {
+    "@types/node": "^20.0.0",
+    "@typescript-eslint/parser": "^8.0.0",
+    "eslint": "^9.0.0",
+    "tsup": "^8.3.0",
+    "typescript": "^5.6.0",
+    "vitest": "^2.1.0"
+  },
+  "peerDependencies": {
+    "eslint": ">=8"
+  },
+  "scripts": {
+    "build": "tsup",
+    "test": "vitest run",
+    "typecheck": "tsc --noEmit"
+  }
+}