solid-translate 1.4.1 → 1.4.2

package/README.md

@@ -350,9 +350,29 @@ solidTranslate({
   batchSize: 50,                 // Keys per API call (default: 50)
   autoExtract: true,             // Auto-extract <T> and msg() strings (default: false)
   include: ["src/**/*.tsx"],     // Files to scan for extraction
+  extractImportSources: ["@/i18n"], // Extra module specifiers whose msg/<T> imports count as markers (optional)
 })
 ```
 
+### What extraction considers a marker
+
+Extraction only honors `msg()` calls and `<T>`/`<Plural>` elements whose
+identifier actually refers to solid-translate:
+
+- Imported bindings must come from `"solid-translate"` or an accepted
+  re-export wrapper. By default any specifier whose final path segment is
+  `solid-translate` or `i18n` (e.g. `@/i18n`, `../lib/i18n`) is accepted;
+  set `extractImportSources` (plugin config) / `"extractImportSources"`
+  (CLI config) to an explicit list to override the `i18n` heuristic
+  (`"solid-translate"` itself is always accepted).
+- Aliased imports work: `import { msg as m } from "solid-translate"`
+  extracts `m("...")`.
+- Locally bound identifiers are never extracted — a callback parameter
+  named `msg`, a local `const msg = ...`, or a local component named `T`
+  will not pollute the catalog or emit warnings.
+- Identifiers with no binding at all are still treated as markers by name,
+  so snippet-style sources keep working.
+
 ## CLI
 
 For translating locale files, JSON, Markdown, and MDX outside of the Vite build.

package/dist/cli.js

@@ -14599,7 +14599,7 @@ function hashContent(content) {
 
 // src/extract.ts
 var import_parser = __toESM(require_lib(), 1);
-function extractStringsFromSource(code, filePath, warnings) {
+function extractStringsFromSource(code, filePath, warnings, options) {
   const results = [];
   const seen = /* @__PURE__ */ new Set();
   const warn = (line, message) => {
@@ -14621,26 +14621,158 @@ function extractStringsFromSource(code, filePath, warnings) {
     seen.add(entry.key);
     results.push(entry);
   };
+  const bindings = collectModuleBindings(ast);
+  const shadowStack = [];
+  const resolveMarker = (localName) => {
+    for (let i = shadowStack.length - 1; i >= 0; i--) {
+      if (shadowStack[i].has(localName)) return null;
+    }
+    const imported = bindings.imports.get(localName);
+    if (imported) {
+      if (!isAcceptedImportSource(imported.source, options?.importSources)) {
+        return null;
+      }
+      return MARKER_NAMES.has(imported.imported) ? imported.imported : null;
+    }
+    if (bindings.moduleLocals.has(localName)) return null;
+    return MARKER_NAMES.has(localName) ? localName : null;
+  };
   const visit = (node) => {
+    const scopeBindings = collectScopeBindings(node);
+    if (scopeBindings) shadowStack.push(scopeBindings);
     if (node.type === "JSXElement") {
       const name = jsxName(node);
-      if (name === "T") {
+      const marker = name ? resolveMarker(name) : null;
+      if (marker === "T") {
         const entry = processT(node, filePath, warn);
         if (entry) push(entry);
-      } else if (name === "Plural") {
+      } else if (marker === "Plural") {
         for (const entry of processPlural(node, filePath, warn)) {
           push(entry);
         }
       }
-    } else if (node.type === "CallExpression" && node.callee?.type === "Identifier" && node.callee.name === "msg") {
+    } else if (node.type === "CallExpression" && node.callee?.type === "Identifier" && resolveMarker(node.callee.name) === "msg") {
       const entry = processMsg(node, filePath, warn);
       if (entry) push(entry);
     }
     walkChildren(node, visit);
+    if (scopeBindings) shadowStack.pop();
   };
   visit(ast);
   return results;
 }
+var MARKER_NAMES = /* @__PURE__ */ new Set([
+  "msg",
+  "T",
+  "Var",
+  "Num",
+  "Currency",
+  "DateTime",
+  "Plural"
+]);
+var DEFAULT_IMPORT_SOURCE_RE = /(^|\/)(solid-translate|i18n)(\.[cm]?[jt]sx?)?$/;
+function isAcceptedImportSource(source, importSources) {
+  if (source === "solid-translate") return true;
+  if (importSources) return importSources.includes(source);
+  return DEFAULT_IMPORT_SOURCE_RE.test(source);
+}
+function collectModuleBindings(ast) {
+  const imports = /* @__PURE__ */ new Map();
+  const moduleLocals = /* @__PURE__ */ new Set();
+  const body = ast.program?.body ?? [];
+  for (const stmt of body) {
+    if (stmt.type === "ImportDeclaration") {
+      const source = String(stmt.source?.value ?? "");
+      for (const spec of stmt.specifiers ?? []) {
+        const local = spec.local?.name;
+        if (typeof local !== "string") continue;
+        if (spec.type === "ImportSpecifier") {
+          const imported = spec.imported?.type === "Identifier" ? spec.imported.name : String(spec.imported?.value ?? "");
+          imports.set(local, { imported, source });
+        } else {
+          imports.set(local, { imported: "*", source });
+        }
+      }
+    } else {
+      collectDeclaredNames(stmt, moduleLocals);
+    }
+  }
+  return { imports, moduleLocals };
+}
+function collectDeclaredNames(stmt, into) {
+  if (stmt.type === "ExportNamedDeclaration" || stmt.type === "ExportDefaultDeclaration") {
+    if (stmt.declaration) collectDeclaredNames(stmt.declaration, into);
+    return;
+  }
+  if (stmt.type === "VariableDeclaration") {
+    for (const decl of stmt.declarations ?? []) {
+      if (decl.id) collectPatternNames(decl.id, into);
+    }
+    return;
+  }
+  if ((stmt.type === "FunctionDeclaration" || stmt.type === "ClassDeclaration" || stmt.type === "TSEnumDeclaration") && stmt.id?.type === "Identifier") {
+    addMarkerName(stmt.id.name, into);
+  }
+}
+function collectPatternNames(pattern, into) {
+  switch (pattern.type) {
+    case "Identifier":
+      addMarkerName(pattern.name, into);
+      break;
+    case "AssignmentPattern":
+      collectPatternNames(pattern.left, into);
+      break;
+    case "RestElement":
+      collectPatternNames(pattern.argument, into);
+      break;
+    case "ObjectPattern":
+      for (const prop of pattern.properties ?? []) {
+        if (prop.type === "ObjectProperty") {
+          collectPatternNames(prop.value, into);
+        } else if (prop.type === "RestElement") {
+          collectPatternNames(prop.argument, into);
+        }
+      }
+      break;
+    case "ArrayPattern":
+      for (const el of pattern.elements ?? []) {
+        if (el) collectPatternNames(el, into);
+      }
+      break;
+  }
+}
+function addMarkerName(name, into) {
+  if (typeof name === "string" && MARKER_NAMES.has(name)) into.add(name);
+}
+var FUNCTION_TYPES = /* @__PURE__ */ new Set([
+  "ArrowFunctionExpression",
+  "FunctionExpression",
+  "FunctionDeclaration",
+  "ObjectMethod",
+  "ClassMethod",
+  "ClassPrivateMethod"
+]);
+function collectScopeBindings(node) {
+  const bound = /* @__PURE__ */ new Set();
+  if (FUNCTION_TYPES.has(node.type)) {
+    if (node.id?.type === "Identifier") addMarkerName(node.id.name, bound);
+    for (const param of node.params ?? []) {
+      collectPatternNames(param, bound);
+    }
+  } else if (node.type === "CatchClause" && node.param) {
+    collectPatternNames(node.param, bound);
+  } else if (node.type === "BlockStatement") {
+    for (const stmt of node.body ?? []) {
+      collectDeclaredNames(stmt, bound);
+    }
+  } else if (node.type === "ForStatement" || node.type === "ForOfStatement" || node.type === "ForInStatement") {
+    const init = node.init ?? node.left;
+    if (init?.type === "VariableDeclaration") {
+      collectDeclaredNames(init, bound);
+    }
+  }
+  return bound.size > 0 ? bound : null;
+}
 function walkChildren(node, visit) {
   for (const key of Object.keys(node)) {
     if (key === "loc" || key === "leadingComments" || key === "trailingComments" || key === "innerComments") {
@@ -15229,7 +15361,8 @@ async function runExtract() {
         const extracted = extractStringsFromSource(
           code,
           relative(root, file),
-          warnings
+          warnings,
+          { importSources: config.extractImportSources }
         );
         for (const entry of extracted) {
           strings[entry.key] = entry.source;
@@ -15286,7 +15419,9 @@ async function runCheck(jsonOutput) {
         const code = readFileSync2(file, "utf-8");
         const entries = extractStringsFromSource(
           code,
-          relative(root, file)
+          relative(root, file),
+          void 0,
+          { importSources: config.extractImportSources }
         );
         for (const entry of entries) {
           extracted[entry.key] = entry.source;

package/dist/index.d.ts

@@ -36,6 +36,13 @@ interface SolidTranslatePluginConfig {
      * Default: `["src/**\/*.tsx", "src/**\/*.ts", "src/**\/*.jsx"]`
      */
     include?: string[];
+    /**
+     * Module specifiers accepted as sources of the extraction markers
+     * (`msg`, `<T>`, `<Plural>`, ...). `"solid-translate"` is always
+     * accepted. When omitted, any specifier whose final path segment is
+     * `solid-translate` or `i18n` (e.g. `"@/i18n"`) is accepted.
+     */
+    extractImportSources?: string[];
 }
 /** A flat dictionary mapping keys to translated strings */
 type TranslationDictionary = Record<string, string>;

package/dist/vite.d.ts

@@ -36,6 +36,13 @@ interface SolidTranslatePluginConfig {
      * Default: `["src/**\/*.tsx", "src/**\/*.ts", "src/**\/*.jsx"]`
      */
     include?: string[];
+    /**
+     * Module specifiers accepted as sources of the extraction markers
+     * (`msg`, `<T>`, `<Plural>`, ...). `"solid-translate"` is always
+     * accepted. When omitted, any specifier whose final path segment is
+     * `solid-translate` or `i18n` (e.g. `"@/i18n"`) is accepted.
+     */
+    extractImportSources?: string[];
 }
 
 /**

package/dist/vite.js

@@ -14665,7 +14665,7 @@ async function translateBatch(model, entries, targetLocale, sourceLocale, system
 
 // src/extract.ts
 var import_parser = __toESM(require_lib(), 1);
-function extractStringsFromSource(code, filePath, warnings) {
+function extractStringsFromSource(code, filePath, warnings, options) {
   const results = [];
   const seen = /* @__PURE__ */ new Set();
   const warn = (line, message) => {
@@ -14687,26 +14687,158 @@ function extractStringsFromSource(code, filePath, warnings) {
     seen.add(entry.key);
     results.push(entry);
   };
+  const bindings = collectModuleBindings(ast);
+  const shadowStack = [];
+  const resolveMarker = (localName) => {
+    for (let i = shadowStack.length - 1; i >= 0; i--) {
+      if (shadowStack[i].has(localName)) return null;
+    }
+    const imported = bindings.imports.get(localName);
+    if (imported) {
+      if (!isAcceptedImportSource(imported.source, options?.importSources)) {
+        return null;
+      }
+      return MARKER_NAMES.has(imported.imported) ? imported.imported : null;
+    }
+    if (bindings.moduleLocals.has(localName)) return null;
+    return MARKER_NAMES.has(localName) ? localName : null;
+  };
   const visit = (node) => {
+    const scopeBindings = collectScopeBindings(node);
+    if (scopeBindings) shadowStack.push(scopeBindings);
     if (node.type === "JSXElement") {
       const name = jsxName(node);
-      if (name === "T") {
+      const marker = name ? resolveMarker(name) : null;
+      if (marker === "T") {
         const entry = processT(node, filePath, warn);
         if (entry) push(entry);
-      } else if (name === "Plural") {
+      } else if (marker === "Plural") {
         for (const entry of processPlural(node, filePath, warn)) {
           push(entry);
         }
       }
-    } else if (node.type === "CallExpression" && node.callee?.type === "Identifier" && node.callee.name === "msg") {
+    } else if (node.type === "CallExpression" && node.callee?.type === "Identifier" && resolveMarker(node.callee.name) === "msg") {
       const entry = processMsg(node, filePath, warn);
       if (entry) push(entry);
     }
     walkChildren(node, visit);
+    if (scopeBindings) shadowStack.pop();
   };
   visit(ast);
   return results;
 }
+var MARKER_NAMES = /* @__PURE__ */ new Set([
+  "msg",
+  "T",
+  "Var",
+  "Num",
+  "Currency",
+  "DateTime",
+  "Plural"
+]);
+var DEFAULT_IMPORT_SOURCE_RE = /(^|\/)(solid-translate|i18n)(\.[cm]?[jt]sx?)?$/;
+function isAcceptedImportSource(source, importSources) {
+  if (source === "solid-translate") return true;
+  if (importSources) return importSources.includes(source);
+  return DEFAULT_IMPORT_SOURCE_RE.test(source);
+}
+function collectModuleBindings(ast) {
+  const imports = /* @__PURE__ */ new Map();
+  const moduleLocals = /* @__PURE__ */ new Set();
+  const body = ast.program?.body ?? [];
+  for (const stmt of body) {
+    if (stmt.type === "ImportDeclaration") {
+      const source = String(stmt.source?.value ?? "");
+      for (const spec of stmt.specifiers ?? []) {
+        const local = spec.local?.name;
+        if (typeof local !== "string") continue;
+        if (spec.type === "ImportSpecifier") {
+          const imported = spec.imported?.type === "Identifier" ? spec.imported.name : String(spec.imported?.value ?? "");
+          imports.set(local, { imported, source });
+        } else {
+          imports.set(local, { imported: "*", source });
+        }
+      }
+    } else {
+      collectDeclaredNames(stmt, moduleLocals);
+    }
+  }
+  return { imports, moduleLocals };
+}
+function collectDeclaredNames(stmt, into) {
+  if (stmt.type === "ExportNamedDeclaration" || stmt.type === "ExportDefaultDeclaration") {
+    if (stmt.declaration) collectDeclaredNames(stmt.declaration, into);
+    return;
+  }
+  if (stmt.type === "VariableDeclaration") {
+    for (const decl of stmt.declarations ?? []) {
+      if (decl.id) collectPatternNames(decl.id, into);
+    }
+    return;
+  }
+  if ((stmt.type === "FunctionDeclaration" || stmt.type === "ClassDeclaration" || stmt.type === "TSEnumDeclaration") && stmt.id?.type === "Identifier") {
+    addMarkerName(stmt.id.name, into);
+  }
+}
+function collectPatternNames(pattern, into) {
+  switch (pattern.type) {
+    case "Identifier":
+      addMarkerName(pattern.name, into);
+      break;
+    case "AssignmentPattern":
+      collectPatternNames(pattern.left, into);
+      break;
+    case "RestElement":
+      collectPatternNames(pattern.argument, into);
+      break;
+    case "ObjectPattern":
+      for (const prop of pattern.properties ?? []) {
+        if (prop.type === "ObjectProperty") {
+          collectPatternNames(prop.value, into);
+        } else if (prop.type === "RestElement") {
+          collectPatternNames(prop.argument, into);
+        }
+      }
+      break;
+    case "ArrayPattern":
+      for (const el of pattern.elements ?? []) {
+        if (el) collectPatternNames(el, into);
+      }
+      break;
+  }
+}
+function addMarkerName(name, into) {
+  if (typeof name === "string" && MARKER_NAMES.has(name)) into.add(name);
+}
+var FUNCTION_TYPES = /* @__PURE__ */ new Set([
+  "ArrowFunctionExpression",
+  "FunctionExpression",
+  "FunctionDeclaration",
+  "ObjectMethod",
+  "ClassMethod",
+  "ClassPrivateMethod"
+]);
+function collectScopeBindings(node) {
+  const bound = /* @__PURE__ */ new Set();
+  if (FUNCTION_TYPES.has(node.type)) {
+    if (node.id?.type === "Identifier") addMarkerName(node.id.name, bound);
+    for (const param of node.params ?? []) {
+      collectPatternNames(param, bound);
+    }
+  } else if (node.type === "CatchClause" && node.param) {
+    collectPatternNames(node.param, bound);
+  } else if (node.type === "BlockStatement") {
+    for (const stmt of node.body ?? []) {
+      collectDeclaredNames(stmt, bound);
+    }
+  } else if (node.type === "ForStatement" || node.type === "ForOfStatement" || node.type === "ForInStatement") {
+    const init = node.init ?? node.left;
+    if (init?.type === "VariableDeclaration") {
+      collectDeclaredNames(init, bound);
+    }
+  }
+  return bound.size > 0 ? bound : null;
+}
 function walkChildren(node, visit) {
   for (const key of Object.keys(node)) {
     if (key === "loc" || key === "leadingComments" || key === "trailingComments" || key === "innerComments") {
@@ -15152,7 +15284,8 @@ function solidTranslate(config) {
     batchSize = 50,
     translate = true,
     autoExtract = false,
-    include = ["src/**/*.tsx", "src/**/*.ts", "src/**/*.jsx"]
+    include = ["src/**/*.tsx", "src/**/*.ts", "src/**/*.jsx"],
+    extractImportSources
   } = config;
   let root;
   let resolvedLocalesDir;
@@ -15180,7 +15313,11 @@ function solidTranslate(config) {
       );
       let contexts = {};
       if (autoExtract) {
-        const extracted = await autoExtractStrings(root, include);
+        const extracted = await autoExtractStrings(
+          root,
+          include,
+          extractImportSources
+        );
         contexts = extracted.contexts;
         let existingSource = {};
         if (existsSync2(sourceFilePath)) {
@@ -15343,7 +15480,7 @@ function solidTranslate(config) {
   };
 }
 var vite_default = solidTranslate;
-async function autoExtractStrings(root, patterns) {
+async function autoExtractStrings(root, patterns, importSources) {
   const strings = {};
   const contexts = {};
   const warnings = [];
@@ -15356,7 +15493,8 @@ async function autoExtractStrings(root, patterns) {
         const extracted = extractStringsFromSource(
           code,
           relative(root, file),
-          warnings
+          warnings,
+          { importSources }
         );
         for (const entry of extracted) {
           strings[entry.key] = entry.source;