@cmssy/eslint-plugin 12.4.0 → 12.6.0

package/dist/index.cjs

@@ -9,9 +9,81 @@ var path = require('path');
 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);
+var aliasCache = /* @__PURE__ */ new Map();
+function stripJsonComments(text) {
+  let out = "";
+  let inString = false;
+  let escaped = false;
+  for (let i = 0; i < text.length; i += 1) {
+    const char = text[i];
+    if (inString) {
+      out += char;
+      if (escaped) escaped = false;
+      else if (char === "\\") escaped = true;
+      else if (char === '"') inString = false;
+      continue;
+    }
+    if (char === '"') {
+      inString = true;
+      out += char;
+      continue;
+    }
+    if (char === "/" && text[i + 1] === "/") {
+      while (i < text.length && text[i] !== "\n") i += 1;
+      out += "\n";
+      continue;
+    }
+    if (char === "/" && text[i + 1] === "*") {
+      i += 2;
+      while (i < text.length && !(text[i] === "*" && text[i + 1] === "/")) {
+        i += 1;
+      }
+      i += 1;
+      continue;
+    }
+    out += char;
+  }
+  return out.replace(/,(\s*[}\]])/g, "$1");
+}
+function readTsconfig(file) {
+  try {
+    return JSON.parse(
+      stripJsonComments(fs.readFileSync(file, "utf8"))
+    );
+  } catch {
+    return null;
+  }
+}
+function aliasConfigFor(fromFile) {
+  let dir = path.dirname(fromFile);
+  const visited = [];
+  for (let up = 0; up < 12; up += 1) {
+    const cached = aliasCache.get(dir);
+    if (cached !== void 0) {
+      for (const seen of visited) aliasCache.set(seen, cached);
+      return cached;
+    }
+    visited.push(dir);
+    const candidate = path.resolve(dir, "tsconfig.json");
+    if (fs.existsSync(candidate)) {
+      const config = readTsconfig(candidate);
+      const options = config?.compilerOptions ?? {};
+      const paths = options.paths;
+      if (paths && Object.keys(paths).length > 0) {
+        const baseUrl = typeof options.baseUrl === "string" ? path.resolve(dir, options.baseUrl) : dir;
+        const found = { baseUrl, paths };
+        for (const seen of visited) aliasCache.set(seen, found);
+        return found;
+      }
+    }
+    const parent = path.dirname(dir);
+    if (parent === dir) break;
+    dir = parent;
+  }
+  for (const seen of visited) aliasCache.set(seen, null);
+  return null;
+}
+function withExtension(base) {
   for (const ext of EXTENSIONS) {
     const candidate = `${base}${ext}`;
     if (fs.existsSync(candidate) && !candidate.endsWith("/")) return candidate;
@@ -22,13 +94,45 @@ function resolveLocal(fromFile, specifier) {
   }
   return null;
 }
+function resolveAlias(fromFile, specifier) {
+  const config = aliasConfigFor(fromFile);
+  if (!config) return null;
+  for (const [pattern, targets] of Object.entries(config.paths)) {
+    const star = pattern.indexOf("*");
+    if (star === -1) {
+      if (pattern !== specifier) continue;
+      for (const target of targets) {
+        const hit = withExtension(path.resolve(config.baseUrl, target));
+        if (hit) return hit;
+      }
+      continue;
+    }
+    const prefix = pattern.slice(0, star);
+    const suffix = pattern.slice(star + 1);
+    if (!specifier.startsWith(prefix) || !specifier.endsWith(suffix)) continue;
+    const middle = specifier.slice(
+      prefix.length,
+      specifier.length - suffix.length
+    );
+    for (const target of targets) {
+      const hit = withExtension(
+        path.resolve(config.baseUrl, target.replace("*", middle))
+      );
+      if (hit) return hit;
+    }
+  }
+  return null;
+}
+function resolveLocal(fromFile, specifier) {
+  if (specifier.startsWith(".")) {
+    return withExtension(path.resolve(path.dirname(fromFile), specifier));
+  }
+  return resolveAlias(fromFile, specifier);
+}
 function valueImports(code) {
-  const withoutTypes = code.replace(
-    /^\s*(?:import|export)\s+type\s[^;]*;/gm,
-    ""
-  );
+  const withoutTypes = code.replace(/^\s*(?:import|export)\s+type\s[^;]*;/gm, "").replace(/\bimport\s*\([^)]*\)/g, "");
   return [
-    ...withoutTypes.matchAll(/(?:from|import)\s*\(?\s*["']([^"']+)["']/g)
+    ...withoutTypes.matchAll(/(?:from|import)\s*["']([^"']+)["']/g)
   ].map(([, specifier]) => specifier ?? "");
 }
 function importsServerConfig(code) {
@@ -43,6 +147,11 @@ function importsServerConfig(code) {
     )
   );
 }
+function hasDirective(source, directive) {
+  return new RegExp(
+    `^\\s*(?:\\/\\/[^\\n]*\\n|\\/\\*[\\s\\S]*?\\*\\/\\s*)*["']${directive}["']`
+  ).test(source);
+}
 function chainToServerConfig(file, cache2, seen = /* @__PURE__ */ new Set()) {
   if (seen.has(file)) return null;
   seen.add(file);
@@ -55,6 +164,10 @@ function chainToServerConfig(file, cache2, seen = /* @__PURE__ */ new Set()) {
     cache2.set(file, null);
     return null;
   }
+  if (hasDirective(code, "use server")) {
+    cache2.set(file, null);
+    return null;
+  }
   if (importsServerConfig(code)) {
     const chain = [file];
     cache2.set(file, chain);
@@ -73,10 +186,16 @@ function chainToServerConfig(file, cache2, seen = /* @__PURE__ */ new Set()) {
   cache2.set(file, null);
   return null;
 }
-function isClientFile(source) {
-  return /^\s*(?:\/\/[^\n]*\n|\/\*[\s\S]*?\*\/\s*)*["']use client["']/.test(
-    source
-  );
+function normalize(path$1) {
+  return path$1.split(path.sep).join("/");
+}
+function isClientEntry(filename, entries) {
+  const file = normalize(filename);
+  return entries.some((entry) => {
+    const wanted = normalize(entry);
+    if (path.isAbsolute(wanted)) return file === wanted;
+    return file === wanted || file.endsWith(`/${wanted}`);
+  });
 }
 var cache = /* @__PURE__ */ new Map();
 var noServerConfigInClient = {
@@ -85,14 +204,31 @@ var noServerConfigInClient = {
     docs: {
       description: "Disallow a client component from importing values that read the cmssy server config"
     },
-    schema: [],
+    schema: [
+      {
+        type: "object",
+        properties: {
+          clientEntries: {
+            type: "array",
+            items: { type: "string" }
+          }
+        },
+        additionalProperties: false
+      }
+    ],
     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.'
+      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."
     }
   },
   create(context) {
     const filename = context.filename ?? context.getFilename();
-    if (!isClientFile(context.sourceCode.getText())) return {};
+    const options = context.options[0] ?? {};
+    const entries = options.clientEntries ?? [];
+    const client = hasDirective(context.sourceCode.getText(), "use client");
+    const entry = isClientEntry(filename, entries);
+    if (!client && !entry) return {};
+    const messageId = client ? "reachesConfig" : "reachesConfigFromEntry";
     return {
       ImportDeclaration(node) {
         const typed = node;
@@ -104,7 +240,7 @@ var noServerConfigInClient = {
         if (SERVER_MODULES.some((pattern) => pattern.test(specifier))) {
           context.report({
             node,
-            messageId: "reachesConfig",
+            messageId,
             data: { chain: `${specifier} is server-only` }
           });
           return;
@@ -115,7 +251,7 @@ var noServerConfigInClient = {
         if (!chain) return;
         context.report({
           node,
-          messageId: "reachesConfig",
+          messageId,
           data: {
             chain: [filename, ...chain].map((f) => f.split("/").slice(-2).join("/")).join(" -> ")
           }

package/dist/index.js

@@ -1,13 +1,85 @@
-import { existsSync, readFileSync } from 'fs';
-import { resolve, dirname } from 'path';
+import { readFileSync, existsSync } from 'fs';
+import { isAbsolute, resolve, dirname, sep } 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);
+var aliasCache = /* @__PURE__ */ new Map();
+function stripJsonComments(text) {
+  let out = "";
+  let inString = false;
+  let escaped = false;
+  for (let i = 0; i < text.length; i += 1) {
+    const char = text[i];
+    if (inString) {
+      out += char;
+      if (escaped) escaped = false;
+      else if (char === "\\") escaped = true;
+      else if (char === '"') inString = false;
+      continue;
+    }
+    if (char === '"') {
+      inString = true;
+      out += char;
+      continue;
+    }
+    if (char === "/" && text[i + 1] === "/") {
+      while (i < text.length && text[i] !== "\n") i += 1;
+      out += "\n";
+      continue;
+    }
+    if (char === "/" && text[i + 1] === "*") {
+      i += 2;
+      while (i < text.length && !(text[i] === "*" && text[i + 1] === "/")) {
+        i += 1;
+      }
+      i += 1;
+      continue;
+    }
+    out += char;
+  }
+  return out.replace(/,(\s*[}\]])/g, "$1");
+}
+function readTsconfig(file) {
+  try {
+    return JSON.parse(
+      stripJsonComments(readFileSync(file, "utf8"))
+    );
+  } catch {
+    return null;
+  }
+}
+function aliasConfigFor(fromFile) {
+  let dir = dirname(fromFile);
+  const visited = [];
+  for (let up = 0; up < 12; up += 1) {
+    const cached = aliasCache.get(dir);
+    if (cached !== void 0) {
+      for (const seen of visited) aliasCache.set(seen, cached);
+      return cached;
+    }
+    visited.push(dir);
+    const candidate = resolve(dir, "tsconfig.json");
+    if (existsSync(candidate)) {
+      const config = readTsconfig(candidate);
+      const options = config?.compilerOptions ?? {};
+      const paths = options.paths;
+      if (paths && Object.keys(paths).length > 0) {
+        const baseUrl = typeof options.baseUrl === "string" ? resolve(dir, options.baseUrl) : dir;
+        const found = { baseUrl, paths };
+        for (const seen of visited) aliasCache.set(seen, found);
+        return found;
+      }
+    }
+    const parent = dirname(dir);
+    if (parent === dir) break;
+    dir = parent;
+  }
+  for (const seen of visited) aliasCache.set(seen, null);
+  return null;
+}
+function withExtension(base) {
   for (const ext of EXTENSIONS) {
     const candidate = `${base}${ext}`;
     if (existsSync(candidate) && !candidate.endsWith("/")) return candidate;
@@ -18,13 +90,45 @@ function resolveLocal(fromFile, specifier) {
   }
   return null;
 }
+function resolveAlias(fromFile, specifier) {
+  const config = aliasConfigFor(fromFile);
+  if (!config) return null;
+  for (const [pattern, targets] of Object.entries(config.paths)) {
+    const star = pattern.indexOf("*");
+    if (star === -1) {
+      if (pattern !== specifier) continue;
+      for (const target of targets) {
+        const hit = withExtension(resolve(config.baseUrl, target));
+        if (hit) return hit;
+      }
+      continue;
+    }
+    const prefix = pattern.slice(0, star);
+    const suffix = pattern.slice(star + 1);
+    if (!specifier.startsWith(prefix) || !specifier.endsWith(suffix)) continue;
+    const middle = specifier.slice(
+      prefix.length,
+      specifier.length - suffix.length
+    );
+    for (const target of targets) {
+      const hit = withExtension(
+        resolve(config.baseUrl, target.replace("*", middle))
+      );
+      if (hit) return hit;
+    }
+  }
+  return null;
+}
+function resolveLocal(fromFile, specifier) {
+  if (specifier.startsWith(".")) {
+    return withExtension(resolve(dirname(fromFile), specifier));
+  }
+  return resolveAlias(fromFile, specifier);
+}
 function valueImports(code) {
-  const withoutTypes = code.replace(
-    /^\s*(?:import|export)\s+type\s[^;]*;/gm,
-    ""
-  );
+  const withoutTypes = code.replace(/^\s*(?:import|export)\s+type\s[^;]*;/gm, "").replace(/\bimport\s*\([^)]*\)/g, "");
   return [
-    ...withoutTypes.matchAll(/(?:from|import)\s*\(?\s*["']([^"']+)["']/g)
+    ...withoutTypes.matchAll(/(?:from|import)\s*["']([^"']+)["']/g)
   ].map(([, specifier]) => specifier ?? "");
 }
 function importsServerConfig(code) {
@@ -39,6 +143,11 @@ function importsServerConfig(code) {
     )
   );
 }
+function hasDirective(source, directive) {
+  return new RegExp(
+    `^\\s*(?:\\/\\/[^\\n]*\\n|\\/\\*[\\s\\S]*?\\*\\/\\s*)*["']${directive}["']`
+  ).test(source);
+}
 function chainToServerConfig(file, cache2, seen = /* @__PURE__ */ new Set()) {
   if (seen.has(file)) return null;
   seen.add(file);
@@ -51,6 +160,10 @@ function chainToServerConfig(file, cache2, seen = /* @__PURE__ */ new Set()) {
     cache2.set(file, null);
     return null;
   }
+  if (hasDirective(code, "use server")) {
+    cache2.set(file, null);
+    return null;
+  }
   if (importsServerConfig(code)) {
     const chain = [file];
     cache2.set(file, chain);
@@ -69,10 +182,16 @@ function chainToServerConfig(file, cache2, seen = /* @__PURE__ */ new Set()) {
   cache2.set(file, null);
   return null;
 }
-function isClientFile(source) {
-  return /^\s*(?:\/\/[^\n]*\n|\/\*[\s\S]*?\*\/\s*)*["']use client["']/.test(
-    source
-  );
+function normalize(path) {
+  return path.split(sep).join("/");
+}
+function isClientEntry(filename, entries) {
+  const file = normalize(filename);
+  return entries.some((entry) => {
+    const wanted = normalize(entry);
+    if (isAbsolute(wanted)) return file === wanted;
+    return file === wanted || file.endsWith(`/${wanted}`);
+  });
 }
 var cache = /* @__PURE__ */ new Map();
 var noServerConfigInClient = {
@@ -81,14 +200,31 @@ var noServerConfigInClient = {
     docs: {
       description: "Disallow a client component from importing values that read the cmssy server config"
     },
-    schema: [],
+    schema: [
+      {
+        type: "object",
+        properties: {
+          clientEntries: {
+            type: "array",
+            items: { type: "string" }
+          }
+        },
+        additionalProperties: false
+      }
+    ],
     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.'
+      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."
     }
   },
   create(context) {
     const filename = context.filename ?? context.getFilename();
-    if (!isClientFile(context.sourceCode.getText())) return {};
+    const options = context.options[0] ?? {};
+    const entries = options.clientEntries ?? [];
+    const client = hasDirective(context.sourceCode.getText(), "use client");
+    const entry = isClientEntry(filename, entries);
+    if (!client && !entry) return {};
+    const messageId = client ? "reachesConfig" : "reachesConfigFromEntry";
     return {
       ImportDeclaration(node) {
         const typed = node;
@@ -100,7 +236,7 @@ var noServerConfigInClient = {
         if (SERVER_MODULES.some((pattern) => pattern.test(specifier))) {
           context.report({
             node,
-            messageId: "reachesConfig",
+            messageId,
             data: { chain: `${specifier} is server-only` }
           });
           return;
@@ -111,7 +247,7 @@ var noServerConfigInClient = {
         if (!chain) return;
         context.report({
           node,
-          messageId: "reachesConfig",
+          messageId,
           data: {
             chain: [filename, ...chain].map((f) => f.split("/").slice(-2).join("/")).join(" -> ")
           }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cmssy/eslint-plugin",
-  "version": "12.4.0",
+  "version": "12.6.0",
   "description": "Catches the cmssy wiring mistakes that a build cannot: server config dragged into a client bundle.",
   "keywords": [
     "cmssy",