@dialexjs/cli 0.3.0 → 0.5.0

package/README.md

@@ -29,7 +29,7 @@ Binaries installed: `dialex` and the shorter alias `dx` (handy in package.json s
 Initialize or configure Dialex in any project:
 
 - **Automatic Framework Detection**: Identifies Next.js, Fastify, Koa, Hono, Express, NestJS, Elysia, SvelteKit, Astro, Vue, Nuxt, and React/Vite.
-- **Magicast AST Injection**: Manipulates `dialex.config.ts` and injects Vite plugins into `vite.config.ts` (React, Vue) and the module into `nuxt.config.ts` (Nuxt) cleanly.
+- **Magicast AST Injection**: Manipulates `dialex.config.ts` and registers the module in `nuxt.config.ts` (Nuxt) cleanly.
 - **Starter Dictionaries**: Emits typed starter dictionary and TypeScript declaration file.
 
 ```bash

package/dist/api.d.mts

@@ -99,7 +99,7 @@ export declare function getLeafSource(df: DictionaryFile, locale: string, path:
  * evaluated module (the CLI does this; editors must not).
  */
 type IssueLevel = "error" | "warning" | "info";
-type IssueCode = "invalid-dictionary" | "unanalyzable" | "missing-locale" | "missing-key" | "invalid-locale" | "todo-placeholder" | "invalid-icu" | "icu-args-mismatch" | "icu-plural-categories" | "unknown-dictionary" | "unknown-path" | "unused-key" | "unused-dictionary";
+type IssueCode = "invalid-dictionary" | "unanalyzable" | "missing-locale" | "missing-key" | "invalid-locale" | "todo-placeholder" | "stale-translation" | "invalid-icu" | "icu-args-mismatch" | "icu-plural-categories" | "unknown-dictionary" | "unknown-path" | "unused-key" | "unused-dictionary";
 interface AnalysisIssue {
   /** Absolute path of the file the issue is in. */
   file: string;
@@ -132,6 +132,8 @@ interface AnalysisOptions {
   ignore?: string[];
   /** Report possibly unused keys and dictionaries. @default true */
   unused?: boolean;
+  /** Report translations whose source text changed since `dialex.lock.json` recorded them. @default true */
+  lock?: boolean;
 }
 interface LeafInfo {
   kind: "string" | "function" | "other";
@@ -172,6 +174,36 @@ export declare function analyzeProject(options: AnalysisOptions): Promise<Analys
 /** Project root-relative path with forward slashes, for display. */
 export declare function relativeFile(root: string, file: string): string;
 //#endregion
+//#region src/utils/lockfile.d.ts
+export declare const LOCK_FILE = "dialex.lock.json";
+/**
+ * Records which version of the source text each translation was made from, so a later edit of the
+ * source can be noticed. A translation whose source changed afterwards is *stale*.
+ *
+ * ```json
+ * { "version": 1, "sourceLocale": "en", "locales": { "tr": { "home.title": "a1b2c3d4" } } }
+ * ```
+ *
+ * The value is a short hash of the source locale's text at the time. Translations without a
+ * record are untracked (for example hand-written ones) and are never reported as stale.
+ */
+interface Lockfile {
+  version: 1;
+  sourceLocale?: string;
+  locales: Record<string, Record<string, string>>;
+}
+/** A short, stable fingerprint of a source string. */
+export declare function hashSource(text: string): string;
+/** The lock file, or `undefined` when there is none (or it cannot be read). */
+export declare function readLock(root: string): Lockfile | undefined;
+/** Writes the lock with sorted keys, so it produces small, stable diffs. */
+export declare function writeLock(root: string, lock: Lockfile): void;
+/**
+ * True when `key` was recorded for `locale` from different source text than `sourceText`. A key
+ * with no record is not stale.
+ */
+export declare function isStale(lock: Lockfile, locale: string, key: string, sourceText: string): boolean;
+//#endregion
 //#region src/utils/static-config.d.ts
 /**
  * The parts of `dialex.config` that tooling needs, read **without running the file**. Editors must
@@ -184,7 +216,7 @@ interface StaticConfig {
   include: string | string[];
   fallbacks: Record<string, string[]>;
   prefixDefault: boolean;
-  lazy: boolean;
+  lazy: boolean | "locale";
 }
 interface StaticConfigResult {
   config: StaticConfig;
@@ -235,12 +267,46 @@ interface GenerateOptions {
   output?: string;
   config?: string;
   json?: boolean;
+  /**
+   * Read `dialex.config.*` from its syntax tree instead of running it, so no project code
+   * executes (used by the editor extension). Settings that are not literals fall back to defaults.
+   */
+  static?: boolean;
+}
+interface RenderedGenerate {
+  /** Absolute paths of the dictionary files, sorted. */
+  files: string[];
+  /** Where `dialex.generated.ts` goes, and what it should contain. */
+  outputPath: string;
+  content: string;
+  /** Where `dialex-env.d.ts` goes, and what it should contain (absent without dictionaries). */
+  dtsPath: string;
+  dtsContent?: string;
+  /** The config file that was read, if there is one. Without it every default applies. */
+  configFile?: string;
+  /** Per-locale modules for `lazy: "locale"`, written next to the generated file. */
+  extraFiles: {
+    path: string;
+    content: string;
+  }[];
+  /** Things worth telling the user, such as a dictionary that could not be split by locale. */
+  notes: string[];
 }
+/**
+ * Works out `dialex.generated.ts` and `dialex-env.d.ts` for a project without writing anything,
+ * so `check` can tell whether they are up to date.
+ *
+ * Settings come from `dialex.config.*` and fall back to {@link DEFAULT_CONFIG}; `locales` falls
+ * back to the locales the dictionaries define.
+ */
+export declare function renderGenerated(root: string, options?: GenerateOptions): RenderedGenerate;
 export declare function generateDictionaries(root: string, options?: GenerateOptions): {
   files: string[];
   outputPath: string;
   dtsPath: string;
+  configFile?: string;
+  notes: string[];
 };
 //#endregion
-export type { AnalysisConfig, AnalysisIssue, AnalysisOptions, AnalysisResult, AnalyzedDictionary, DictionaryFile, GenerateOptions, IssueCode, IssueLevel, Leaf, LeafInfo, LeafKind, Project, ProjectDictionary, Reference, SourceRange, StaticConfig, StaticConfigResult };
+export type { AnalysisConfig, AnalysisIssue, AnalysisOptions, AnalysisResult, AnalyzedDictionary, DictionaryFile, GenerateOptions, IssueCode, IssueLevel, Leaf, LeafInfo, LeafKind, Lockfile, Project, ProjectDictionary, Reference, RenderedGenerate, 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/static-config.ts","../src/utils/project.ts","../src/commands/generate.ts"],"mappings":";;;;;;;;;;;;;;;KAgBK;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;;;;;;;;;;;KCnXU;KAEA;UAeK;;EAEf;EACA,OAAO;EACP,MAAM;EACN;;EAEA,QAAQ;;EAER;EACA;;EAEA;;EAEA;;UAGe;EACf;EACA;EACA;;UAGe;EACf;EACA,QAAQ;;EAER;;EAEA;;EAEA;;EAEA;;UAGe;EACf;EACA;;UAGe;EACf;;EAEA;;EAEA;;EAEA,QAAQ,YAAY,YAAY;;EAEhC;;EAEA,KAAK;;UAGU;EACf,QAAQ;EACR,cAAc;;EAEd;EACA;;qBAKW;UAqBI;;EAEf;EACA;;EAEA;EACA;;;wBAIc,eAAe,eAAe;wBA4IxB,eAAe,SAAS,kBAAkB,QAAQ;;wBA+NxD,aAAa,cAAc;;;;;;;;UCte1B;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;;;UC7DvB;EACf;EACA;EACA;EACA;EACA;;wBAGc,qBACd,cACA,UAAS;EAET;EACA;EACA"}
+{"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"}

package/dist/api.mjs

@@ -1,2 +1,2 @@
-import { C as saveDictionaryFile, S as renderDictionaryFile, T as generateDictionaries, _ as listLeaves, a as parseStaticConfig, b as locationOf, c as analyzeProject, d as TODO_PREFIX, f as copyLeaf, g as hasPath, h as getString, i as DEFAULT_STATIC_CONFIG, l as relativeFile, m as getLeafSource, n as loadStaticProject, o as readStaticConfig, p as dictionaryLocation, r as toKey, s as DEFAULT_SOURCE_GLOB, t as loadProject, u as scanReferences, v as listLocales, w as setString, x as parseDictionaryText, y as loadDictionaryFile } from "./project-ClQxaIMc.mjs";
-export { DEFAULT_SOURCE_GLOB, DEFAULT_STATIC_CONFIG, TODO_PREFIX, analyzeProject, copyLeaf, dictionaryLocation, generateDictionaries, getLeafSource, getString, hasPath, listLeaves, listLocales, loadDictionaryFile, loadProject, loadStaticProject, locationOf, parseDictionaryText, parseStaticConfig, readStaticConfig, relativeFile, renderDictionaryFile, saveDictionaryFile, scanReferences, setString, toKey };
+import { A as listLocales, C as TODO_PREFIX, D as getString, E as getLeafSource, F as saveDictionaryFile, I as setString, M as locationOf, N as parseDictionaryText, O as hasPath, P as renderDictionaryFile, S as writeLock, T as dictionaryLocation, _ as isStale, a as renderGenerated, b as readLock, c as parseStaticConfig, d as DEFAULT_SOURCE_GLOB, f as analyzeProject, g as hashSource, h as LOCK_FILE, i as generateDictionaries, j as loadDictionaryFile, k as listLeaves, l as readStaticConfig, m as scanReferences, n as loadStaticProject, p as relativeFile, r as toKey, s as DEFAULT_STATIC_CONFIG, t as loadProject, w as copyLeaf } from "./project-BJYmnKiU.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 };