@dialexjs/cli 0.6.0 → 0.7.1

package/dist/api.d.mts

@@ -120,6 +120,35 @@ interface AnalysisConfig {
   defaultLocale?: string;
   locales?: string[];
   include?: string | string[];
+  exclude?: string[];
+}
+/**
+ * Remembers parsed dictionaries and scanned source files between `analyzeProject` calls, keyed by
+ * modification time and size, so a long-lived caller (the editor extension) only re-reads what
+ * changed. Create one with {@link createAnalysisCache}; one-shot callers do not need it.
+ */
+interface AnalysisCache {
+  dictionaries: Map<string, {
+    stamp: string;
+    loaded: Loaded;
+  }>;
+  sources: Map<string, {
+    stamp: string;
+    scan: SourceScan;
+  }>;
+  /** The `.gitignore` filter, reused until {@link clearGitignore} is called. */
+  gitignore: Map<string, (absolutePath: string) => boolean>;
+}
+export declare function createAnalysisCache(): AnalysisCache;
+/** Forget the cached `.gitignore` rules, for example after a `.gitignore` file changed. */
+export declare function clearGitignore(cache: AnalysisCache): void;
+interface SourceScan {
+  /** Distinct word-like tokens, for the unused-key heuristic. */
+  tokens: string[];
+  refs: {
+    ref: Reference;
+    range: SourceRange;
+  }[];
 }
 interface AnalysisOptions {
   root: string;
@@ -134,6 +163,8 @@ interface AnalysisOptions {
   unused?: boolean;
   /** Report translations whose source text changed since `dialex.lock.json` recorded them. @default true */
   lock?: boolean;
+  /** Reuse work between calls. Ignored when `runtime` is set, because that evaluates code. */
+  cache?: AnalysisCache;
 }
 interface LeafInfo {
   kind: "string" | "function" | "other";
@@ -170,10 +201,51 @@ interface Reference {
 }
 /** Finds `getDictionary("x")`-style and `t("x.y.z")` references in source text. */
 export declare function scanReferences(text: string): Reference[];
+interface DictionaryData {
+  name: string;
+  locales: string[];
+  leaves: Map<string, Map<string, LeafInfo>>;
+  df?: DictionaryFile;
+}
+type Loaded = {
+  ok: true;
+  data: DictionaryData;
+} | {
+  ok: false;
+  level: IssueLevel;
+  code: IssueCode;
+  message: string;
+};
 export declare function analyzeProject(options: AnalysisOptions): Promise<AnalysisResult>;
 /** Project root-relative path with forward slashes, for display. */
 export declare function relativeFile(root: string, file: string): string;
 //#endregion
+//#region src/utils/files.d.ts
+/** Folders that never hold project dictionaries or sources, in every scanner. */
+export declare const BUILTIN_IGNORE: string[];
+/** What the source scan skips on top: other tools' output, declarations, generated and config files. */
+export declare const SOURCE_BUILTIN_IGNORE: string[];
+/**
+ * A function that says whether an absolute path is ignored by Git. It reads the `.gitignore`
+ * files of the project folder, of every folder above it up to the repository root (monorepo
+ * packages inherit the root's rules), and of nested folders.
+ */
+export declare function createGitignoreFilter(root: string): (absolutePath: string) => boolean;
+interface ScanOptions {
+  /** Which built-in ignore list applies. @default "dictionary" */
+  kind?: "dictionary" | "source";
+  /** `exclude` from the config: extra globs, relative to `root`. */
+  exclude?: string[];
+  /** More ignore globs, relative to `root` (nested projects, for example). */
+  ignore?: string[];
+  /** Skip what `.gitignore` files ignore. @default true */
+  gitignore?: boolean;
+  /** A filter from {@link createGitignoreFilter} to reuse instead of reading `.gitignore` again. */
+  gitignoreFilter?: (absolutePath: string) => boolean;
+}
+/** Finds files under `root`, skipping build output, configured excludes and Git-ignored paths. */
+export declare function scanFiles(root: string, patterns: string | string[], options?: ScanOptions): string[];
+//#endregion
 //#region src/utils/lockfile.d.ts
 export declare const LOCK_FILE = "dialex.lock.json";
 /**
@@ -214,6 +286,7 @@ interface StaticConfig {
   defaultLocale: string;
   locales: string[];
   include: string | string[];
+  exclude: string[];
   fallbacks: Record<string, string[]>;
   prefixDefault: boolean;
   lazy: boolean | "locale";
@@ -307,6 +380,14 @@ export declare function generateDictionaries(root: string, options?: GenerateOpt
   configFile?: string;
   notes: string[];
 };
+/**
+ * Regenerates when a dictionary or config file is added, edited or removed. chokidar 4+ no longer
+ * understands globs, so this watches the project directory and decides for itself which events
+ * matter, using the same `include` glob as `generate`.
+ */
+export declare function startGenerateWatcher(root: string, options: GenerateOptions, regenerate: () => void, delay?: number,
+/** Where to report what triggered a regeneration. Defaults to the CLI logger (stdout). */
+log?: (message: string) => void): import("chokidar").FSWatcher;
 //#endregion
-export type { AnalysisConfig, AnalysisIssue, AnalysisOptions, AnalysisResult, AnalyzedDictionary, DictionaryFile, GenerateOptions, IssueCode, IssueLevel, Leaf, LeafInfo, LeafKind, Lockfile, Project, ProjectDictionary, Reference, RenderedGenerate, SourceRange, StaticConfig, StaticConfigResult };
+export type { AnalysisCache, AnalysisConfig, AnalysisIssue, AnalysisOptions, AnalysisResult, AnalyzedDictionary, DictionaryFile, GenerateOptions, IssueCode, IssueLevel, Leaf, LeafInfo, LeafKind, Lockfile, Project, ProjectDictionary, Reference, RenderedGenerate, ScanOptions, SourceRange, StaticConfig, StaticConfigResult };
 //# sourceMappingURL=api.d.mts.map

package/dist/api.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"api.d.mts","names":[],"sources":["../src/utils/dictionary-edit.ts","../src/analysis.ts","../src/utils/lockfile.ts","../src/utils/static-config.ts","../src/utils/project.ts","../src/commands/generate.ts"],"mappings":";;;;;;;;;;;;;;;KAiBK;EAAS;GAAe;;qBAEhB;UAII;EACf;;EAEA;EACA,KAAK,QAAQ,kBAAkB;;EAE/B,YAAY;;EAEZ;;;;;;EAMA;;;UAIe;EACf;IAAS;IAAc;;EACvB;IAAO;IAAc;;;KAGX;UAEK;EACf;EACA,MAAM;;EAEN;;;;;;wBAgIc,oBAAoB,cAAc,eAAe;;wBAoB3C,mBAAmB,eAAe,QAAQ;;wBAKhD,qBAAqB,IAAI;wBAKnB,mBAAmB,IAAI,iBAAiB;wBAQ9C,YAAY,IAAI;;wBAahB,WAAW,IAAI,gBAAgB,iBAAiB;wBAoChD,QAAQ,IAAI,gBAAgB,gBAAgB;wBAI5C,UAAU,IAAI,gBAAgB,gBAAgB;KA+BlD;;;;;wBAMI,UACd,IAAI,gBACJ,gBACA,gBACA,gBACC;;;;;;wBAsBa,SACd,IAAI,gBACJ,oBACA,kBACA,gBACA,aAAa;;;;;wBAwCC,WACd,IAAI,gBACJ,gBACA,kBACC;;wBAMa,mBAAmB,IAAI,iBAAiB;;wBAKxC,cACd,IAAI,gBACJ,gBACA;;;;;;;;;;;KCjXU;KAEA;UAgBK;;EAEf;EACA,OAAO;EACP,MAAM;EACN;;EAEA,QAAQ;;EAER;EACA;;EAEA;;EAEA;;UAGe;EACf;EACA;EACA;;UAGe;EACf;EACA,QAAQ;;EAER;;EAEA;;EAEA;;EAEA;;EAEA;;UAGe;EACf;EACA;;UAGe;EACf;;EAEA;;EAEA;;EAEA,QAAQ,YAAY,YAAY;;EAEhC;;EAEA,KAAK;;UAGU;EACf,QAAQ;EACR,cAAc;;EAEd;EACA;;qBAUW;UAqBI;;EAEf;EACA;;EAEA;EACA;;;wBAIc,eAAe,eAAe;wBA4IxB,eAAe,SAAS,kBAAkB,QAAQ;;wBAwPxD,aAAa,cAAc;;;qBCthB9B;;;;;;;;;;;;UAaI;EACf;EACA;EACA,SAAS,eAAe;;;wBAYV,WAAW;;wBAKX,SAAS,eAAe;;wBAiBxB,UAAU,cAAc,MAAM;;;;;wBA2B9B,QAAQ,MAAM,UAAU,gBAAgB,aAAa;;;;;;;;UC/DpD;EACf;EACA;EACA;EACA,WAAW;EACX;EACA;;UAGe;EACf,QAAQ;;EAER;;EAEA;;qBAMW,uBAAuB;;wBAiFpB,kBAAkB,cAAc,gBAA4B;;wBA8C5D,iBAAiB,cAAc,sBAAsB;;;UC5JpD;;EAEf;EACA;EACA,IAAI;;UAGW;EACf;EACA,QAAQ;EACR,cAAc;;EAEd;;EAEA;;;;;;wBAgCoB,YAAY,cAAc,sBAAsB,QAAQ;;;;;wBASxD,kBAAkB,cAAc,sBAAsB,QAAQ;;qBAMvE,QAAK,oBAAsB;;;UCvDvB;EACf;EACA;EACA;EACA;EACA;;;;;EAKA;;UAUe;;EAEf;;EAEA;EACA;;EAEA;EACA;;EAEA;;EAEA;IAAc;IAAc;;;EAE5B;;;;;;;;;wBAcc,gBAAgB,cAAc,UAAS,kBAAuB;wBA8J9D,qBACd,cACA,UAAS;EAET;EACA;EACA;EACA;EACA"}
+{"version":3,"file":"api.d.mts","names":[],"sources":["../src/utils/dictionary-edit.ts","../src/analysis.ts","../src/utils/files.ts","../src/utils/lockfile.ts","../src/utils/static-config.ts","../src/utils/project.ts","../src/commands/generate.ts"],"mappings":";;;;;;;;;;;;;;;KAiBK;EAAS;GAAe;;qBAEhB;UAII;EACf;;EAEA;EACA,KAAK,QAAQ,kBAAkB;;EAE/B,YAAY;;EAEZ;;;;;;EAMA;;;UAIe;EACf;IAAS;IAAc;;EACvB;IAAO;IAAc;;;KAGX;UAEK;EACf;EACA,MAAM;;EAEN;;;;;;wBAgIc,oBAAoB,cAAc,eAAe;;wBAoB3C,mBAAmB,eAAe,QAAQ;;wBAKhD,qBAAqB,IAAI;wBAKnB,mBAAmB,IAAI,iBAAiB;wBAQ9C,YAAY,IAAI;;wBAahB,WAAW,IAAI,gBAAgB,iBAAiB;wBAoChD,QAAQ,IAAI,gBAAgB,gBAAgB;wBAI5C,UAAU,IAAI,gBAAgB,gBAAgB;KA+BlD;;;;;wBAMI,UACd,IAAI,gBACJ,gBACA,gBACA,gBACC;;;;;;wBAsBa,SACd,IAAI,gBACJ,oBACA,kBACA,gBACA,aAAa;;;;;wBAwCC,WACd,IAAI,gBACJ,gBACA,kBACC;;wBAMa,mBAAmB,IAAI,iBAAiB;;wBAKxC,cACd,IAAI,gBACJ,gBACA;;;;;;;;;;;KClXU;KAEA;UAgBK;;EAEf;EACA,OAAO;EACP,MAAM;EACN;;EAEA,QAAQ;;EAER;EACA;;EAEA;;EAEA;;UAGe;EACf;EACA;EACA;EACA;;;;;;;UAQe;EACf,cAAc;IAAc;IAAe,QAAQ;;EACnD,SAAS;IAAc;IAAe,MAAM;;;EAE5C,WAAW,aAAa;;wBAGV,uBAAuB;;wBAKvB,eAAe,OAAO;UAI5B;;EAER;EACA;IAAQ,KAAK;IAAW,OAAO;;;UAGhB;EACf;EACA,QAAQ;;EAER;;EAEA;;EAEA;;EAEA;;EAEA;;EAEA,QAAQ;;UAGO;EACf;EACA;;UAGe;EACf;;EAEA;;EAEA;;EAEA,QAAQ,YAAY,YAAY;;EAEhC;;EAEA,KAAK;;UAGU;EACf,QAAQ;EACR,cAAc;;EAEd;EACA;;qBAGW;UAQI;;EAEf;EACA;;EAEA;EACA;;;wBAIc,eAAe,eAAe;UA8BpC;EACR;EACA;EACA,QAAQ,YAAY,YAAY;EAChC,KAAK;;KAGF;EACC;EAAU,MAAM;;EAChB;EAAW,OAAO;EAAY,MAAM;EAAW;;wBAwI/B,eAAe,SAAS,kBAAkB,QAAQ;;wBAqQxD,aAAa,cAAc;;;;qBC5kB9B;;qBAQA;;;;;;wBA2CG,sBAAsB,gBAAgB;UAoCrC;;EAEf;;EAEA;;EAEA;;EAEA;;EAEA,mBAAmB;;;wBAIL,UACd,cACA,6BACA,UAAS;;;qBC3GE;;;;;;;;;;;;UAaI;EACf;EACA;EACA,SAAS,eAAe;;;wBAYV,WAAW;;wBAKX,SAAS,eAAe;;wBAiBxB,UAAU,cAAc,MAAM;;;;;wBA2B9B,QAAQ,MAAM,UAAU,gBAAgB,aAAa;;;;;;;;UC/DpD;EACf;EACA;EACA;EACA;EACA,WAAW;EACX;EACA;;UAGe;EACf,QAAQ;;EAER;;EAEA;;qBAMW,uBAAuB;;wBAmFpB,kBAAkB,cAAc,gBAA4B;;wBA+C5D,iBAAiB,cAAc,sBAAsB;;;UChKpD;;EAEf;EACA;EACA,IAAI;;UAGW;EACf;EACA,QAAQ;EACR,cAAc;;EAEd;;EAEA;;;;;;wBA4BoB,YAAY,cAAc,sBAAsB,QAAQ;;;;;wBASxD,kBAAkB,cAAc,sBAAsB,QAAQ;;qBAMvE,QAAK,oBAAsB;;;UCnDvB;EACf;EACA;EACA;EACA;EACA;;;;;EAKA;;UAGe;;EAEf;;EAEA;EACA;;EAEA;EACA;;EAEA;;EAEA;IAAc;IAAc;;;EAE5B;;;;;;;;;wBAcc,gBAAgB,cAAc,UAAS,kBAAuB;wBA8J9D,qBACd,cACA,UAAS;EAET;EACA;EACA;EACA;EACA;;;;;;;wBAmGc,qBACd,cACA,SAAS,iBACT,wBACA,gBAEA;;AAAA,OAAM,8CAA4D"}

package/dist/api.mjs

@@ -1,2 +1,2 @@
-import { A as listLeaves, C as writeLock, D as getLeafSource, E as dictionaryLocation, F as renderDictionaryFile, I as saveDictionaryFile, L as setString, M as loadDictionaryFile, N as locationOf, O as getString, P as parseDictionaryText, T as copyLeaf, _ as hashSource, a as renderGenerated, c as parseStaticConfig, f as DEFAULT_SOURCE_GLOB, g as LOCK_FILE, h as scanReferences, i as generateDictionaries, j as listLocales, k as hasPath, l as readStaticConfig, m as relativeFile, n as loadStaticProject, p as analyzeProject, r as toKey, s as DEFAULT_STATIC_CONFIG, t as loadProject, v as isStale, w as TODO_PREFIX, x as readLock } from "./project-DquSNdz8.mjs";
-export { DEFAULT_SOURCE_GLOB, DEFAULT_STATIC_CONFIG, LOCK_FILE, TODO_PREFIX, analyzeProject, copyLeaf, dictionaryLocation, generateDictionaries, getLeafSource, getString, hasPath, hashSource, isStale, listLeaves, listLocales, loadDictionaryFile, loadProject, loadStaticProject, locationOf, parseDictionaryText, parseStaticConfig, readLock, readStaticConfig, relativeFile, renderDictionaryFile, renderGenerated, saveDictionaryFile, scanReferences, setString, toKey, writeLock };
+import { A as scanFiles, B as locationOf, D as BUILTIN_IGNORE, E as writeLock, F as getString, H as renderDictionaryFile, I as hasPath, L as listLeaves, M as copyLeaf, N as dictionaryLocation, O as SOURCE_BUILTIN_IGNORE, P as getLeafSource, R as listLocales, U as saveDictionaryFile, V as parseDictionaryText, W as setString, _ as relativeFile, a as renderGenerated, b as hashSource, c as DEFAULT_STATIC_CONFIG, g as createAnalysisCache, h as clearGitignore, i as generateDictionaries, j as TODO_PREFIX, k as createGitignoreFilter, l as parseStaticConfig, m as analyzeProject, n as loadStaticProject, p as DEFAULT_SOURCE_GLOB, r as toKey, s as startGenerateWatcher, t as loadProject, u as readStaticConfig, v as scanReferences, w as readLock, x as isStale, y as LOCK_FILE, z as loadDictionaryFile } from "./project-Dz0FbydQ.mjs";
+export { BUILTIN_IGNORE, DEFAULT_SOURCE_GLOB, DEFAULT_STATIC_CONFIG, LOCK_FILE, SOURCE_BUILTIN_IGNORE, TODO_PREFIX, analyzeProject, clearGitignore, copyLeaf, createAnalysisCache, createGitignoreFilter, dictionaryLocation, generateDictionaries, getLeafSource, getString, hasPath, hashSource, isStale, listLeaves, listLocales, loadDictionaryFile, loadProject, loadStaticProject, locationOf, parseDictionaryText, parseStaticConfig, readLock, readStaticConfig, relativeFile, renderDictionaryFile, renderGenerated, saveDictionaryFile, scanFiles, scanReferences, setString, startGenerateWatcher, toKey, writeLock };

package/dist/index.mjs

@@ -1,9 +1,8 @@
 #!/usr/bin/env node
-import { A as listLeaves, C as writeLock, I as saveDictionaryFile, L as setString, M as loadDictionaryFile, O as getString, S as record, T as copyLeaf, a as renderGenerated, b as lockPath, d as logger, g as LOCK_FILE, i as generateDictionaries, j as listLocales, k as hasPath, o as runGenerate, p as analyzeProject, r as toKey, t as loadProject, u as resolveDialexConfig, v as isStale, w as TODO_PREFIX, x as readLock, y as lockFor } from "./project-DquSNdz8.mjs";
+import { A as scanFiles, C as lockPath, E as writeLock, F as getString, I as hasPath, L as listLeaves, M as copyLeaf, R as listLocales, S as lockFor, T as record, U as saveDictionaryFile, W as setString, a as renderGenerated, d as resolveDialexConfig, f as logger, i as generateDictionaries, j as TODO_PREFIX, m as analyzeProject, o as runGenerate, r as toKey, t as loadProject, w as readLock, x as isStale, y as LOCK_FILE, z as loadDictionaryFile } from "./project-Dz0FbydQ.mjs";
 import { Command } from "commander";
 import fs from "node:fs";
 import path from "node:path";
-import fg from "fast-glob";
 import pc from "picocolors";
 import { fileURLToPath } from "node:url";
 import { loadFile, parseModule, writeFile } from "magicast";
@@ -11,15 +10,9 @@ import { argumentSignature, getArguments, isIcuStructured, parseMessage } from "
 import * as p from "@clack/prompts";
 import { addNuxtModule } from "magicast/helpers";
 //#region package.json
-var version = "0.6.0";
+var version = "0.7.1";
 //#endregion
 //#region src/commands/check.ts
-const DICTIONARY_IGNORE = [
-	"**/node_modules/**",
-	"**/dist/**",
-	"**/.next/**",
-	"**/dialex.locales/**"
-];
 function addIssue(diag, issue) {
 	const level = issue.level === "error" ? "error" : "warning";
 	(level === "error" ? diag.errors : diag.warnings).push(issue.message);
@@ -123,11 +116,7 @@ async function runCheck(options = {}) {
 	const include = config.include || "**/*.content.ts";
 	const configuredLocales = config.locales || [];
 	const defaultLocale = config.defaultLocale || "en";
-	const files = fg.sync(include, {
-		cwd: root,
-		absolute: true,
-		ignore: DICTIONARY_IGNORE
-	});
+	const files = scanFiles(root, include, { exclude: config.exclude });
 	if (files.length === 0) {
 		if (!quiet) {
 			const patternStr = Array.isArray(include) ? include.join(", ") : include;