@saidksi/localizer-core 0.1.0

package/dist/scanner/filters.js

@@ -0,0 +1,133 @@
+// ─── Constants ────────────────────────────────────────────────────────────────
+const MIN_LENGTH = 2;
+const URL_RE = /^(https?:\/\/|ftp:\/\/|mailto:|\/\/)/i;
+const NUMERIC_RE = /^\d+(\.\d+)?(%|px|em|rem|vh|vw)?$/;
+const RELATIVE_PATH_RE = /^\.\.?\//;
+// Bare module specifier: "react", "@scope/pkg", "@scope/pkg/sub"
+// Must start with lowercase or @ — avoids filtering user-facing words like "Password", "Settings"
+const MODULE_SPECIFIER_RE = /^(@[\w-]+\/[\w.-]+|[a-z][\w-]*)(\/[\w./-]+)?$/;
+// A single CSS utility token: "flex", "text-sm", "bg-gray-100", "sm:flex", "w-[100px]", "!important"
+const CSS_TOKEN_RE = /^-?!?[a-z][a-z0-9]*([:-][a-z0-9]+)*(\[.+\])?(%)?$/;
+/**
+ * JSX attribute names whose string values are never user-facing text.
+ * Strings in these attributes are silently skipped by the scanner.
+ */
+export const NON_TRANSLATABLE_ATTRS = new Set([
+    "className",
+    "class",
+    "style",
+    "href",
+    "src",
+    "srcSet",
+    "srcset",
+    "action",
+    "method",
+    "type",
+    "id",
+    "name",
+    "key",
+    "ref",
+    "tabIndex",
+    "tabindex",
+    "htmlFor",
+    "for",
+    "target",
+    "rel",
+    "download",
+    "accept",
+    "pattern",
+    "autoComplete",
+    "autocomplete",
+    "encType",
+    "enctype",
+    "role",
+    "value",
+    "data-testid",
+    "data-cy",
+    "data-test",
+    "xmlns",
+    "fill",
+    "stroke",
+    "viewBox",
+    "d", // SVG path
+]);
+/** Translation function names — strings inside these calls are already translated. */
+export const TRANSLATION_FNS = new Set([
+    "t",
+    "formatMessage",
+    "$t",
+    "i18n",
+]);
+/**
+ * Functions that take default/placeholder values as arguments (not UI text to translate).
+ * E.g., useState("John Doe") — "John Doe" is a default, should not be translated.
+ */
+export const STATE_INITIALIZATION_FNS = new Set([
+    "useState",
+    "useRef",
+    "useReducer",
+]);
+// ─── Individual filter predicates (exported for unit testing) ─────────────────
+export function isTooShort(value) {
+    return value.trim().length < MIN_LENGTH;
+}
+export function isPurelyNumeric(value) {
+    return NUMERIC_RE.test(value.trim());
+}
+export function isUrl(value) {
+    return URL_RE.test(value.trim());
+}
+export function isRelativePath(value) {
+    return RELATIVE_PATH_RE.test(value.trim());
+}
+export function isModuleSpecifier(value) {
+    return MODULE_SPECIFIER_RE.test(value.trim());
+}
+/**
+ * Returns true if the string looks like a multi-token CSS class string,
+ * e.g. "flex items-center bg-gray-100 p-4".
+ * Single tokens are NOT flagged — "Settings" and "flex" both match the token
+ * pattern but only a space-separated list of tokens is conclusively CSS.
+ * Additionally, at least one token must contain a CSS indicator (hyphen, colon,
+ * or bracket) to avoid filtering plain English phrases like "pending tasks".
+ */
+export function isCssClassString(value) {
+    const trimmed = value.trim();
+    if (!trimmed)
+        return false;
+    const tokens = trimmed.split(/\s+/);
+    if (tokens.length <= 1)
+        return false;
+    const hasCssIndicator = tokens.some((tok) => /[-:[\]]/.test(tok));
+    return hasCssIndicator && tokens.every((tok) => CSS_TOKEN_RE.test(tok));
+}
+export function matchesIgnorePattern(value, patterns) {
+    return patterns.some((pattern) => {
+        try {
+            return new RegExp(pattern).test(value);
+        }
+        catch {
+            return false;
+        }
+    });
+}
+// ─── Composite filter ────────────────────────────────────────────────────────
+/**
+ * Returns true if this string value should be discarded (not a translatable string).
+ * Applied after AST-level checks (translation call, console call, attr name).
+ *
+ * @param value The string to check
+ * @param config The localization config
+ * @param isJSX If true, skip MODULE_SPECIFIER_RE filter (for strings already inside JSX)
+ */
+export function shouldFilter(value, config, isJSX = false) {
+    const trimmed = value.trim();
+    return (isTooShort(trimmed) ||
+        isPurelyNumeric(trimmed) ||
+        isUrl(trimmed) ||
+        isRelativePath(trimmed) ||
+        (!isJSX && isModuleSpecifier(trimmed)) ||
+        isCssClassString(trimmed) ||
+        matchesIgnorePattern(trimmed, config.ignorePatterns ?? []));
+}
+//# sourceMappingURL=filters.js.map

package/dist/scanner/filters.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"filters.js","sourceRoot":"","sources":["../../src/scanner/filters.ts"],"names":[],"mappings":"AAEA,iFAAiF;AAEjF,MAAM,UAAU,GAAG,CAAC,CAAC;AAErB,MAAM,MAAM,GAAG,uCAAuC,CAAC;AACvD,MAAM,UAAU,GAAG,mCAAmC,CAAC;AACvD,MAAM,gBAAgB,GAAG,UAAU,CAAC;AACpC,iEAAiE;AACjE,kGAAkG;AAClG,MAAM,mBAAmB,GAAG,+CAA+C,CAAC;AAC5E,qGAAqG;AACrG,MAAM,YAAY,GAAG,mDAAmD,CAAC;AAEzE;;;GAGG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG,IAAI,GAAG,CAAC;IAC5C,WAAW;IACX,OAAO;IACP,OAAO;IACP,MAAM;IACN,KAAK;IACL,QAAQ;IACR,QAAQ;IACR,QAAQ;IACR,QAAQ;IACR,MAAM;IACN,IAAI;IACJ,MAAM;IACN,KAAK;IACL,KAAK;IACL,UAAU;IACV,UAAU;IACV,SAAS;IACT,KAAK;IACL,QAAQ;IACR,KAAK;IACL,UAAU;IACV,QAAQ;IACR,SAAS;IACT,cAAc;IACd,cAAc;IACd,SAAS;IACT,SAAS;IACT,MAAM;IACN,OAAO;IACP,aAAa;IACb,SAAS;IACT,WAAW;IACX,OAAO;IACP,MAAM;IACN,QAAQ;IACR,SAAS;IACT,GAAG,EAAE,WAAW;CACjB,CAAC,CAAC;AAEH,sFAAsF;AACtF,MAAM,CAAC,MAAM,eAAe,GAAG,IAAI,GAAG,CAAC;IACrC,GAAG;IACH,eAAe;IACf,IAAI;IACJ,MAAM;CACP,CAAC,CAAC;AAEH;;;GAGG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAG,IAAI,GAAG,CAAC;IAC9C,UAAU;IACV,QAAQ;IACR,YAAY;CACb,CAAC,CAAC;AAEH,iFAAiF;AAEjF,MAAM,UAAU,UAAU,CAAC,KAAa;IACtC,OAAO,KAAK,CAAC,IAAI,EAAE,CAAC,MAAM,GAAG,UAAU,CAAC;AAC1C,CAAC;AAED,MAAM,UAAU,eAAe,CAAC,KAAa;IAC3C,OAAO,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC;AACvC,CAAC;AAED,MAAM,UAAU,KAAK,CAAC,KAAa;IACjC,OAAO,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC;AACnC,CAAC;AAED,MAAM,UAAU,cAAc,CAAC,KAAa;IAC1C,OAAO,gBAAgB,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC;AAC7C,CAAC;AAED,MAAM,UAAU,iBAAiB,CAAC,KAAa;IAC7C,OAAO,mBAAmB,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC;AAChD,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,gBAAgB,CAAC,KAAa;IAC5C,MAAM,OAAO,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC;IAC7B,IAAI,CAAC,OAAO;QAAE,OAAO,KAAK,CAAC;IAC3B,MAAM,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IACpC,IAAI,MAAM,CAAC,MAAM,IAAI,CAAC;QAAE,OAAO,KAAK,CAAC;IACrC,MAAM,eAAe,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;IAClE,OAAO,eAAe,IAAI,MAAM,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;AAC1E,CAAC;AAED,MAAM,UAAU,oBAAoB,CAClC,KAAa,EACb,QAAkB;IAElB,OAAO,QAAQ,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE;QAC/B,IAAI,CAAC;YACH,OAAO,IAAI,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACzC,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,KAAK,CAAC;QACf,CAAC;IACH,CAAC,CAAC,CAAC;AACL,CAAC;AAED,gFAAgF;AAEhF;;;;;;;GAOG;AACH,MAAM,UAAU,YAAY,CAC1B,KAAa,EACb,MAA8C,EAC9C,QAAiB,KAAK;IAEtB,MAAM,OAAO,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC;IAC7B,OAAO,CACL,UAAU,CAAC,OAAO,CAAC;QACnB,eAAe,CAAC,OAAO,CAAC;QACxB,KAAK,CAAC,OAAO,CAAC;QACd,cAAc,CAAC,OAAO,CAAC;QACvB,CAAC,CAAC,KAAK,IAAI,iBAAiB,CAAC,OAAO,CAAC,CAAC;QACtC,gBAAgB,CAAC,OAAO,CAAC;QACzB,oBAAoB,CAAC,OAAO,EAAE,MAAM,CAAC,cAAc,IAAI,EAAE,CAAC,CAC3D,CAAC;AACJ,CAAC"}

package/dist/scanner/index.d.ts

@@ -0,0 +1,22 @@
+import type { ScanResult, ScanReport, LocalizeConfig } from "../types.js";
+/**
+ * Scan a single file for hardcoded strings.
+ * Returns an empty array if the file extension is not supported.
+ */
+export declare function scanFile(filePath: string, config: LocalizeConfig): Promise<ScanResult[]>;
+/**
+ * Scan a list of files and return all results, flattened.
+ */
+export declare function scanFiles(filePaths: string[], config: LocalizeConfig): Promise<ScanResult[]>;
+/**
+ * Scan all supported files inside a directory, respecting config.exclude patterns.
+ */
+export declare function scanDirectory(dir: string, config: LocalizeConfig): Promise<ScanResult[]>;
+/**
+ * Build a structured ScanReport from a file or directory scan.
+ */
+export declare function buildScanReport(options: {
+    file?: string;
+    dir?: string;
+}, config: LocalizeConfig): Promise<ScanReport>;
+//# sourceMappingURL=index.d.ts.map

package/dist/scanner/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/scanner/index.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,UAAU,EAAE,UAAU,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AA2B1E;;;GAGG;AACH,wBAAsB,QAAQ,CAC5B,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE,cAAc,GACrB,OAAO,CAAC,UAAU,EAAE,CAAC,CAMvB;AAED;;GAEG;AACH,wBAAsB,SAAS,CAC7B,SAAS,EAAE,MAAM,EAAE,EACnB,MAAM,EAAE,cAAc,GACrB,OAAO,CAAC,UAAU,EAAE,CAAC,CAKvB;AAED;;GAEG;AACH,wBAAsB,aAAa,CACjC,GAAG,EAAE,MAAM,EACX,MAAM,EAAE,cAAc,GACrB,OAAO,CAAC,UAAU,EAAE,CAAC,CAoBvB;AAED;;GAEG;AACH,wBAAsB,eAAe,CACnC,OAAO,EAAE;IAAE,IAAI,CAAC,EAAE,MAAM,CAAC;IAAC,GAAG,CAAC,EAAE,MAAM,CAAA;CAAE,EACxC,MAAM,EAAE,cAAc,GACrB,OAAO,CAAC,UAAU,CAAC,CAkBrB"}

package/dist/scanner/index.js

@@ -0,0 +1,82 @@
+import { readFile } from "fs/promises";
+import { resolve, extname } from "path";
+import fg from "fast-glob";
+import { scanWithBabel } from "./babel.js";
+import { scanWithTypeScript } from "./typescript.js";
+// ─── Extension routing ───────────────────────────────────────────────────────
+const BABEL_EXTS = new Set([".js", ".jsx"]);
+const TS_EXTS = new Set([".ts", ".tsx"]);
+function isSupportedFile(filePath) {
+    const ext = extname(filePath).toLowerCase();
+    return BABEL_EXTS.has(ext) || TS_EXTS.has(ext);
+}
+function routeFile(filePath, source, config) {
+    const ext = extname(filePath).toLowerCase();
+    if (BABEL_EXTS.has(ext))
+        return scanWithBabel(filePath, source, config);
+    if (TS_EXTS.has(ext))
+        return scanWithTypeScript(filePath, source, config);
+    return [];
+}
+// ─── Public API ──────────────────────────────────────────────────────────────
+/**
+ * Scan a single file for hardcoded strings.
+ * Returns an empty array if the file extension is not supported.
+ */
+export async function scanFile(filePath, config) {
+    const absolute = resolve(filePath);
+    if (!isSupportedFile(absolute))
+        return [];
+    const source = await readFile(absolute, "utf-8");
+    return routeFile(absolute, source, config);
+}
+/**
+ * Scan a list of files and return all results, flattened.
+ */
+export async function scanFiles(filePaths, config) {
+    const results = await Promise.all(filePaths.map((f) => scanFile(f, config)));
+    return results.flat();
+}
+/**
+ * Scan all supported files inside a directory, respecting config.exclude patterns.
+ */
+export async function scanDirectory(dir, config) {
+    const patterns = [
+        `${dir}/**/*.{js,jsx,ts,tsx}`,
+    ];
+    const ignorePatterns = [
+        "**/node_modules/**",
+        "**/dist/**",
+        "**/build/**",
+        "**/.next/**",
+        ...config.exclude,
+    ];
+    const files = await fg(patterns, {
+        ignore: ignorePatterns,
+        absolute: true,
+        onlyFiles: true,
+    });
+    return scanFiles(files, config);
+}
+/**
+ * Build a structured ScanReport from a file or directory scan.
+ */
+export async function buildScanReport(options, config) {
+    let results = [];
+    if (options.file) {
+        results = await scanFile(options.file, config);
+    }
+    else if (options.dir) {
+        results = await scanDirectory(options.dir, config);
+    }
+    const report = {
+        generatedAt: new Date().toISOString(),
+        results,
+    };
+    if (options.file)
+        report.file = options.file;
+    if (options.dir)
+        report.dir = options.dir;
+    return report;
+}
+//# sourceMappingURL=index.js.map

package/dist/scanner/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/scanner/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AACvC,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,MAAM,CAAC;AACxC,OAAO,EAAE,MAAM,WAAW,CAAC;AAE3B,OAAO,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAC3C,OAAO,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AAErD,gFAAgF;AAEhF,MAAM,UAAU,GAAG,IAAI,GAAG,CAAC,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC;AAC5C,MAAM,OAAO,GAAG,IAAI,GAAG,CAAC,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC;AAEzC,SAAS,eAAe,CAAC,QAAgB;IACvC,MAAM,GAAG,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC,WAAW,EAAE,CAAC;IAC5C,OAAO,UAAU,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;AACjD,CAAC;AAED,SAAS,SAAS,CAChB,QAAgB,EAChB,MAAc,EACd,MAAsB;IAEtB,MAAM,GAAG,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC,WAAW,EAAE,CAAC;IAC5C,IAAI,UAAU,CAAC,GAAG,CAAC,GAAG,CAAC;QAAE,OAAO,aAAa,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;IACxE,IAAI,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC;QAAE,OAAO,kBAAkB,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;IAC1E,OAAO,EAAE,CAAC;AACZ,CAAC;AAED,gFAAgF;AAEhF;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,QAAQ,CAC5B,QAAgB,EAChB,MAAsB;IAEtB,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;IACnC,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC;QAAE,OAAO,EAAE,CAAC;IAE1C,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;IACjD,OAAO,SAAS,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;AAC7C,CAAC;AAED;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,SAAS,CAC7B,SAAmB,EACnB,MAAsB;IAEtB,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,GAAG,CAC/B,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,QAAQ,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAC1C,CAAC;IACF,OAAO,OAAO,CAAC,IAAI,EAAE,CAAC;AACxB,CAAC;AAED;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,aAAa,CACjC,GAAW,EACX,MAAsB;IAEtB,MAAM,QAAQ,GAAG;QACf,GAAG,GAAG,uBAAuB;KAC9B,CAAC;IAEF,MAAM,cAAc,GAAG;QACrB,oBAAoB;QACpB,YAAY;QACZ,aAAa;QACb,aAAa;QACb,GAAG,MAAM,CAAC,OAAO;KAClB,CAAC;IAEF,MAAM,KAAK,GAAG,MAAM,EAAE,CAAC,QAAQ,EAAE;QAC/B,MAAM,EAAE,cAAc;QACtB,QAAQ,EAAE,IAAI;QACd,SAAS,EAAE,IAAI;KAChB,CAAC,CAAC;IAEH,OAAO,SAAS,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;AAClC,CAAC;AAED;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,eAAe,CACnC,OAAwC,EACxC,MAAsB;IAEtB,IAAI,OAAO,GAAiB,EAAE,CAAC;IAE/B,IAAI,OAAO,CAAC,IAAI,EAAE,CAAC;QACjB,OAAO,GAAG,MAAM,QAAQ,CAAC,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IACjD,CAAC;SAAM,IAAI,OAAO,CAAC,GAAG,EAAE,CAAC;QACvB,OAAO,GAAG,MAAM,aAAa,CAAC,OAAO,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;IACrD,CAAC;IAED,MAAM,MAAM,GAAe;QACzB,WAAW,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;QACrC,OAAO;KACR,CAAC;IAEF,IAAI,OAAO,CAAC,IAAI;QAAE,MAAM,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IAC7C,IAAI,OAAO,CAAC,GAAG;QAAE,MAAM,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC;IAE1C,OAAO,MAAM,CAAC;AAChB,CAAC"}

package/dist/scanner/typescript.d.ts

@@ -0,0 +1,3 @@
+import type { ScanResult, LocalizeConfig } from "../types.js";
+export declare function scanWithTypeScript(filePath: string, source: string, config: LocalizeConfig): ScanResult[];
+//# sourceMappingURL=typescript.d.ts.map

package/dist/scanner/typescript.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"typescript.d.ts","sourceRoot":"","sources":["../../src/scanner/typescript.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,UAAU,EAAY,cAAc,EAAoB,MAAM,aAAa,CAAC;AAia1F,wBAAgB,kBAAkB,CAChC,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,cAAc,GACrB,UAAU,EAAE,CAoSd"}