@dialexjs/cli 0.7.1 → 0.9.1

package/README.md

@@ -32,7 +32,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.
+- **Automatic Framework Detection**: Identifies Next.js, React Router, React/Vite, Preact, Solid, Svelte, SvelteKit, Vue, Nuxt, Qwik, Lit, React Native, Astro, Hono, Express, Fastify, Koa, NestJS, Elysia, Hapi, AdonisJS and tRPC from `package.json`.
 - **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.
 
@@ -70,6 +70,15 @@ dialex import translations/tr.xlf
 
 Fills missing (or `[TODO]`) strings with a provider you configure in `dialex.config.ts`. Built-in providers for Claude, OpenAI (ChatGPT), Gemini and DeepL are exported from `@dialexjs/cli/translate`. `--dry-run` lists what would be sent without calling anything.
 
+### `dialex lock`
+
+Records the translations you have as up to date with their current source text (`dialex.lock.json`), so a later edit of the source is noticed. `dialex translate` and `dialex import` record what they write; `dialex check` warns about translations whose source changed, and `--fail-on-stale` makes that an error.
+
+```bash
+dialex lock
+dialex lock --all   # also accept translations that are already out of date
+```
+
 ### `dialex check` (alias: `lint`)
 
 CI verification command:
@@ -86,6 +95,16 @@ dialex check
 
 ---
 
+## Exit codes
+
+`0` on success; `1` when the command fails. `dialex check` exits with `1` when it finds errors (warnings never fail it). `dialex import` exits with `0` even when it rejected values; read `success` in its `--json` output. Every command except `init` accepts `--json`.
+
+## Documentation
+
+[Commands and options](https://dialex.awaiden.com/cli/) and the [diagnostics reference](https://dialex.awaiden.com/guide/diagnostics.html).
+
+---
+
 ## 📝 Changelog
 
 See what changed in each release in the [changelog](https://github.com/awaiden/dialex/blob/main/CHANGELOG.md), or on [GitHub Releases](https://github.com/awaiden/dialex/releases).

package/dist/api.d.mts

@@ -1,5 +1,5 @@
 import { loadFile } from "magicast";
-import { DialexConfig } from "dialexjs";
+import { DialexConfig, LintRuleSetting } from "dialexjs";
 //#region src/utils/dictionary-edit.d.ts
 /**
  * AST-level helpers for reading and editing `.content.ts` dictionary files.
@@ -121,7 +121,14 @@ interface AnalysisConfig {
   locales?: string[];
   include?: string | string[];
   exclude?: string[];
+  /** `lint.rules` of the config: `"off"` drops an issue, `"warn"` and `"error"` set its level. */
+  lint?: {
+    rules?: Record<string, LintSetting>;
+  };
 }
+type LintLevel = "off" | "warn" | "error";
+/** A rule as written in the config: `"warn"` or `["warn", { ...options }]`. */
+type LintSetting = LintLevel | readonly [LintLevel, unknown?];
 /**
  * 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
@@ -149,6 +156,8 @@ interface SourceScan {
     ref: Reference;
     range: SourceRange;
   }[];
+  /** Dictionary names registered inline with `dictionaries: { name: ... }`. */
+  inline: string[];
 }
 interface AnalysisOptions {
   root: string;
@@ -165,6 +174,8 @@ interface AnalysisOptions {
   lock?: boolean;
   /** Reuse work between calls. Ignored when `runtime` is set, because that evaluates code. */
   cache?: AnalysisCache;
+  /** Unsaved text of files, by absolute path, used instead of reading them from disk. */
+  contents?: ReadonlyMap<string, string>;
 }
 interface LeafInfo {
   kind: "string" | "function" | "other";
@@ -189,6 +200,8 @@ interface AnalysisResult {
   /** Absolute paths of every dictionary file that matched. */
   files: string[];
   sourceFilesScanned: number;
+  /** Dictionary names registered in code with `dictionaries: { name: ... }`. Empty without `src`. */
+  inlineDictionaries: string[];
 }
 export declare const DEFAULT_SOURCE_GLOB = "**/*.{ts,tsx,js,jsx,mjs,cjs,vue,svelte,astro,mdx}";
 interface Reference {
@@ -199,7 +212,15 @@ interface Reference {
   start: number;
   end: number;
 }
-/** Finds `getDictionary("x")`-style and `t("x.y.z")` references in source text. */
+/** References and inline dictionary names found in one source file. */
+export declare function scanText(text: string): {
+  references: Reference[];
+  inline: string[];
+};
+/**
+ * Finds `getDictionary("x")`-style and `t("x.y.z")` references in source text. References inside
+ * comments, and on lines a `dialex-ignore` comment covers, are skipped.
+ */
 export declare function scanReferences(text: string): Reference[];
 interface DictionaryData {
   name: string;
@@ -216,7 +237,13 @@ type Loaded = {
   code: IssueCode;
   message: string;
 };
+/** Analyzes a project. With `runtime: true`, dictionaries the syntax tree cannot describe are imported. */
 export declare function analyzeProject(options: AnalysisOptions): Promise<AnalysisResult>;
+/**
+ * `analyzeProject` for callers that cannot await, such as lint rules. Reads dictionaries from the
+ * syntax tree only: `runtime` is ignored, so project code is never executed.
+ */
+export declare function analyzeProjectSync(options: AnalysisOptions): AnalysisResult;
 /** Project root-relative path with forward slashes, for display. */
 export declare function relativeFile(root: string, file: string): string;
 //#endregion
@@ -287,9 +314,15 @@ interface StaticConfig {
   locales: string[];
   include: string | string[];
   exclude: string[];
+  /** Where the generated file goes, when the config sets it. */
+  output?: string;
   fallbacks: Record<string, string[]>;
   prefixDefault: boolean;
   lazy: boolean | "locale";
+  /** Severity and options of each check, by diagnostic code. */
+  lint: {
+    rules: Record<string, LintRuleSetting>;
+  };
 }
 interface StaticConfigResult {
   config: StaticConfig;
@@ -297,6 +330,11 @@ interface StaticConfigResult {
   file?: string;
   /** Things that could not be read statically, for example `locales: getLocales()`. */
   notes: string[];
+  /**
+   * The config object has a spread or a computed key, so it may set things this reader cannot
+   * see. Only running the file gives a trustworthy answer.
+   */
+  opaque: boolean;
 }
 export declare const DEFAULT_STATIC_CONFIG: StaticConfig;
 /** Reads a config file's source text. Exposed for tests and for unsaved buffers. */

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/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"}
+{"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":";;;;;;;;;;;;;;;KAwBK;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;;;;;;wBAmGc,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;;;;;;;;;;;KC5VU;KAEA;UAgBK;;EAEf;EACA,OAAO;EACP,MAAM;EACN;;EAEA,QAAQ;;EAER;EACA;;EAEA;;EAEA;;UAGe;EACf;EACA;EACA;EACA;;EAEA;IAAS,QAAQ,eAAe;;;KAG7B;;KAGO,cAAc,sBAAsB;;;;;;UAY/B;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;;;EAE/B;;UAGe;EACf;EACA,QAAQ;;EAER;;EAEA;;EAEA;;EAEA;;EAEA;;EAEA,QAAQ;;EAER,WAAW;;UAGI;EACf;EACA;;UAGe;EACf;;EAEA;;EAEA;;EAEA,QAAQ,YAAY,YAAY;;EAEhC;;EAEA,KAAK;;UAGU;EACf,QAAQ;EACR,cAAc;;EAEd;EACA;;EAEA;;qBAGW;UAQI;;EAEf;EACA;;EAEA;EACA;;;wBA0Gc,SAAS;EAAiB,YAAY;EAAa;;;;;;wBA8BnD,eAAe,eAAe;UAqBpC;EACR;EACA;EACA,QAAQ,YAAY,YAAY;EAChC,KAAK;;KAGF;EACC;EAAU,MAAM;;EAChB;EAAW,OAAO;EAAY,MAAM;EAAW;;;wBA8c/B,eAAe,SAAS,kBAAkB,QAAQ;;;;;wBAkBxD,mBAAmB,SAAS,kBAAkB;;wBAe9C,aAAa,cAAc;;;;qBC3zB9B;;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;;;;;;;;UCpEpD;EACf;EACA;EACA;EACA;;EAEA;EACA,WAAW;EACX;EACA;;EAEA;IAAQ,OAAO,eAAe;;;UAGf;EACf,QAAQ;;EAER;;EAEA;;;;;EAKA;;qBA8BW,uBAAuB;;wBA2HpB,kBAAkB,cAAc,gBAA4B;;wBA4C5D,iBAAiB,cAAc,sBAAsB;;;UCjOpD;;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;wBAqK9D,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 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 };
+import { A as SOURCE_BUILTIN_IGNORE, B as listLocales, C as isStale, E as readLock, F as dictionaryLocation, G as saveDictionaryFile, H as locationOf, I as getLeafSource, K as setString, L as getString, M as scanFiles, N as TODO_PREFIX, O as writeLock, P as copyLeaf, R as hasPath, S as hashSource, U as parseDictionaryText, V as loadDictionaryFile, W as renderDictionaryFile, _ as createAnalysisCache, a as renderGenerated, b as scanText, c as DEFAULT_STATIC_CONFIG, g as clearGitignore, h as analyzeProjectSync, i as generateDictionaries, j as createGitignoreFilter, k as BUILTIN_IGNORE, 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 relativeFile, x as LOCK_FILE, y as scanReferences, z as listLeaves } from "./project-B27699T2.mjs";
+export { BUILTIN_IGNORE, DEFAULT_SOURCE_GLOB, DEFAULT_STATIC_CONFIG, LOCK_FILE, SOURCE_BUILTIN_IGNORE, TODO_PREFIX, analyzeProject, analyzeProjectSync, 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, scanText, setString, startGenerateWatcher, toKey, writeLock };