intor-cli 0.0.2 → 0.0.3

package/README.md

@@ -1,46 +1,54 @@
-### Design Guarantees
+<h1 align="center">intor-cli</h1>
 
-- Message types are inferred from the **_default locale_** only.
-- All locales are assumed to share the same message shape.
-- Locale is treated as a runtime dimension, not a structural one.
-- Generated types are intentionally conservative and do not validate locale completeness.
+<div align="center">
+  
+CLI tool for intor.
 
-### NOTE
+</div>
 
-```
-(Core Modules)
-├── collect-messages
-├── extract-usages
-├── find-configs
-├── generate-types
-├── infer-schema
-├── validation
-```
+<div align="center">
 
-- pipeline: Collect messages
+[![NPM version](https://img.shields.io/npm/v/intor-cli?style=flat&colorA=000000&colorB=000000)](https://www.npmjs.com/package/intor-cli)
+[![TypeScript](https://img.shields.io/badge/TypeScript-%E2%9C%94-blue?style=flat&colorA=000000&colorB=000000)](https://www.typescriptlang.org/)
+[![License](https://img.shields.io/npm/l/intor-cli?style=flat&colorA=000000&colorB=000000)](LICENSE)
 
-```
-input: none (Detect from environment)
-|-> find-configs -> collect-messages
-```
+<table>
+  <tr>
+    <td align="center">
+      <img src="generate-demo.gif" />
+    </td>
+    <td align="center">
+      <img src="check-demo.gif" />
+    </td>
+  </tr>
+</table>
+</div>
 
-- pipeline: Generate intor schema
+## Usage
 
-```
-intput: collected messages
-|-> infer-schema (write file)
+#### generate
+
+```bash
+npx intor-cli generate
 ```
 
-- pipeline: Generate intor types
+- Generates TypeScript types and schema artifacts
+- Designed to be safe, deterministic, and non-intrusive
+- Displays runtime message override details during generation
 
-```
-intput: intor schema
-|-> generate-types (write file)
+#### check
+
+```bash
+npx intor-cli check
 ```
 
-- pipeline: Validation
+- Statically extracts translator usages from your codebase
+- Validates preKey, message keys, replacements, and rich tags
+- Reports diagnostics with precise source locations
 
-```
-intput: intor schema
-|-> extract-usages -> validation
-```
+## Design Guarantees
+
+- Message types are inferred from the **_default locale_** only.
+- All locales are assumed to share the same message shape.
+- Locale is treated as a runtime dimension, not a structural one.
+- Generated types are intentionally conservative and do not validate locale completeness.

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "intor-cli",
-  "version": "0.0.2",
-  "description": "Intor CLI",
+  "version": "0.0.3",
+  "description": "📟 CLI tool for intor",
   "author": "Yiming Liao",
   "homepage": "https://github.com/yiming-liao/intor-cli#readme",
   "repository": {
@@ -12,7 +12,9 @@
     "url": "https://github.com/yiming-liao/intor-cli/issues"
   },
   "keywords": [
-    "i18n"
+    "intor",
+    "i18n",
+    "cli"
   ],
   "license": "MIT",
   "type": "module",
@@ -41,7 +43,7 @@
     "@intor/reader-yaml": "0.1.0",
     "cac": "6.7.14",
     "fast-glob": "3.3.3",
-    "intor": "2.3.17",
+    "intor": "2.3.19",
     "logry": "2.1.6",
     "ora": "9.0.0",
     "picocolors": "1.1.1",

package/src/core/collect-messages/collect-runtime-messages.ts

@@ -1,3 +1,4 @@
+import type { CollectRuntimeMessagesResult, MergeOverrides } from "./types";
 import type { ExtraExt } from "../../core";
 import {
   mergeMessages,
@@ -20,7 +21,7 @@ export async function collectRuntimeMessages(
   locale: string,
   exts: Array<ExtraExt> = [],
   customReaders?: Record<string, string>, // {ext, customReaderFilePath}
-): Promise<LocaleMessages> {
+): Promise<CollectRuntimeMessagesResult> {
   // ----------------------------------------------------------------------
   // Resolve readers
   // ----------------------------------------------------------------------
@@ -37,6 +38,7 @@ export async function collectRuntimeMessages(
   // ----------------------------------------------------------------------
   let serverMessages: LocaleMessages | undefined;
   let clientMessages: LocaleMessages | undefined;
+  const overrides: MergeOverrides[] = [];
 
   // Load server-side runtime messages
   if (config.loader || config.server?.loader) {
@@ -69,8 +71,29 @@ export async function collectRuntimeMessages(
   const runtimeMessages = mergeMessages(serverMessages, clientMessages, {
     config,
     locale,
+    onEvent: (event) => {
+      overrides.push({
+        ...event,
+        layer: "client_over_server",
+        locale,
+        configId: config.id,
+      });
+    },
   });
 
   // runtime messages > static messages
-  return mergeMessages(config.messages, runtimeMessages, { config, locale });
+  const messages = mergeMessages(config.messages, runtimeMessages, {
+    config,
+    locale,
+    onEvent: (event) => {
+      overrides.push({
+        ...event,
+        layer: "runtime_over_static",
+        locale,
+        configId: config.id,
+      });
+    },
+  });
+
+  return { messages, overrides };
 }

package/src/core/collect-messages/types.ts

@@ -0,0 +1,12 @@
+import type { DeepMergeOverrideEvent, LocaleMessages } from "intor";
+
+export interface CollectRuntimeMessagesResult {
+  messages: LocaleMessages;
+  overrides: MergeOverrides[];
+}
+
+export interface MergeOverrides extends DeepMergeOverrideEvent {
+  layer: "client_over_server" | "runtime_over_static";
+  locale: string;
+  configId: string;
+}

package/src/features/generate/generate.ts

@@ -10,6 +10,7 @@ import {
 import { printTitle } from "../print-title";
 import { spinner } from "../spinner";
 import { printConfigs } from "./print-configs";
+import { printOverrides } from "./print-overrides";
 import { printSummary } from "./print-summary";
 
 export interface GenerateOptions {
@@ -44,16 +45,17 @@ export async function generate({
 
     // Runtime mode - Per-config processing
     for (const { config, filePath } of configEntries) {
-      const { id, supportedLocales } = config;
+      const { id, supportedLocales: locales } = config;
       printConfigs(id, filePath);
-      const messages = await collectRuntimeMessages(
+      const { messages, overrides } = await collectRuntimeMessages(
         config,
         config.defaultLocale,
         exts,
         customReaders,
       );
+      printOverrides(overrides);
       const schemas = inferSchemas(messages[config.defaultLocale]);
-      buildInputs.push({ id, locales: supportedLocales, schemas });
+      buildInputs.push({ id, locales, schemas });
     }
 
     // -----------------------------------------------------------------------
@@ -66,8 +68,7 @@ export async function generate({
     const { outDir } = await writeGeneratedFiles({ types, schema });
 
     spinner.stop();
-    const duration = performance.now() - start;
-    printSummary(outDir, duration);
+    printSummary(outDir, performance.now() - start);
   } catch (error) {
     spinner.stop();
     console.error(error instanceof Error ? error.message : String(error));

package/src/features/generate/print-overrides.ts

@@ -0,0 +1,36 @@
+import type { MergeOverrides } from "../../core/collect-messages/types";
+import pc from "picocolors";
+import { spinner } from "../spinner";
+
+export function printOverrides(overrides: MergeOverrides[]) {
+  if (overrides.length === 0) return;
+  spinner.stop();
+
+  console.log(pc.dim("   ↳ Overrides"));
+
+  // Print deduplicated override entries
+  for (const { layer, path, prev, next } of overrides) {
+    console.log(
+      pc.dim("     - ") + pc.dim(`(${formatLayer(layer)}) `) + pc.gray(path),
+      formatDiff(prev, next),
+    );
+  }
+
+  console.log();
+  spinner.start();
+}
+
+function formatLayer(layer: "client_over_server" | "runtime_over_static") {
+  if (layer === "client_over_server") return "client > server";
+  return "runtime > static";
+}
+
+function formatDiff(prev: unknown, next: unknown): string | undefined {
+  if (typeof prev !== "string" && typeof next !== "string") return;
+  return (
+    pc.dim("| Prev: ") +
+    pc.gray(typeof prev === "string" ? prev : "") +
+    pc.dim(", Next: ") +
+    pc.gray(typeof next === "string" ? next : "")
+  );
+}

package/src/features/generate/print-summary.ts

@@ -1,9 +1,8 @@
 import pc from "picocolors";
 
-export function printSummary(outDir: string, ms: number) {
-  const labelWidth = 18;
-  const label = (text: string) => pc.dim(text.padEnd(labelWidth));
+const label = (text: string) => pc.dim(text.padEnd(18));
 
+export function printSummary(outDir: string, ms: number) {
   console.log();
   console.log(pc.green(pc.bold("✔ intor generate completed")));
   console.log();