intor-cli 0.0.15 → 0.0.17

package/README.md

@@ -6,59 +6,56 @@
 [![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)
 
-<table>
-  <tr>
-    <td align="center">
-      <img src="generate-demo.gif" />
-    </td>
-    <td align="center">
-      <img src="check-demo.gif" />
-    </td>
-  </tr>
-</table>
 </div>
 
 ## Overview
 
-- **generate** — message schema & types
-- **check** — usage analysis
+- **discover** — config discovery
+- **generate** — schema and type generation
+- **check** — static usage analysis
 - **validate** — locale completeness
 
+<img src='demo.gif' />
+
 ## Commands
 
-#### generate
+Running `intor-cli` without a command launches the interactive menu.
+
+### Discover
+
+```bash
+npx intor-cli discover
+```
+
+Discovers Intor configs in the current workspace.
+
+### Generate
 
 ```bash
 npx intor-cli generate
 ```
 
-- Generates TypeScript types and schema artifacts
-- Uses the default locale as the single source of truth
-- Reports message override behavior during generation
+Generates schemas and TypeScript types from the default locale.
 
-#### check
+### Check
 
 ```bash
 npx intor-cli check
 ```
 
-- Statistically analyzes translator usage in your codebase
-- Detects incorrect keys, replacements, and rich tag usage
-- Reports diagnostics with precise source locations
+Analyzes translator usage and reports diagnostics.
 
-#### validate
+### Validate
 
 ```bash
 npx intor-cli validate
 ```
 
-- Validates locale message completeness against schemas
-- Checks missing keys, replacements, and rich tags
-- Reports issues grouped by config and locale
+Validates locale messages against generated schemas.
+
+---
 
 ## Design Guarantees
 
-- Message types are inferred from the **_default locale_** only.
+- Schemas and types are inferred **only from the default locale**.
 - All locales are expected to share the same message shape.
-- Locale is treated strictly as a runtime dimension, not a structural one.
-- Generated types are intentionally conservative and do not enforce locale completeness.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "intor-cli",
-  "version": "0.0.15",
+  "version": "0.0.17",
   "description": "The Intor CLI",
   "author": "Yiming Liao",
   "homepage": "https://github.com/yiming-liao/intor-cli#readme",
@@ -46,7 +46,7 @@
     "@intor/reader-yaml": "^0.1.1",
     "cac": "6.7.14",
     "fast-glob": "3.3.3",
-    "intor": "2.3.26",
+    "intor": "^2.3.35",
     "logry": "2.1.6",
     "ora": "9.0.0",
     "picocolors": "1.1.1",
@@ -65,8 +65,6 @@
     "eslint-plugin-unused-imports": "4.3.0",
     "knip": "5.79.0",
     "prettier": "3.7.4",
-    "remark": "15.0.1",
-    "remark-gfm": "4.0.1",
     "typescript": "5.9.3",
     "typescript-eslint": "8.51.0",
     "vitest": "4.0.16"

package/src/cli/commands/check.ts

@@ -1,33 +1,39 @@
-import type { ExtractUsagesOptions } from "../../core/extract-usages/extract-usages";
+import type { CliOption } from "./options";
 import type { CAC } from "cac";
+import { features } from "../../constants";
 import { check } from "../../features";
+import { options } from "./options";
 
 export function registerCheckCommand(cli: CAC) {
   cli
     // -----------------------------------------------------------------------
     // Command
     // -----------------------------------------------------------------------
-    .command("check", "Validate intor translation usage")
+    .command(features.check.name, features.check.title)
 
     // -----------------------------------------------------------------------
-    // Option
+    // Options
     // -----------------------------------------------------------------------
-    .option(
-      "--tsconfig <path>",
-      "Path to tsconfig.json (default: tsconfig.json)",
-    )
-    .option("--debug", "Enable debug logging")
+    .option(...options.debug)
+    .option(...options.tsconfig)
+    .option(...options.format)
+    .option(...options.output)
 
     // -----------------------------------------------------------------------
     // Action
     // -----------------------------------------------------------------------
-    .action(async (options: ExtractUsagesOptions) => {
-      const { tsconfigPath, debug } = options;
-      try {
-        await check({ tsconfigPath, debug });
-      } catch (error) {
-        console.error(error);
-        process.exitCode = 1;
-      }
-    });
+    .action(
+      async (
+        options: Pick<CliOption, "debug" | "tsconfig" | "format" | "output">,
+      ) => {
+        const { debug, tsconfig, format, output } = options;
+
+        try {
+          await check({ debug, tsconfigPath: tsconfig, format, output });
+        } catch (error) {
+          console.error(error instanceof Error ? error.message : error);
+          process.exitCode = 1;
+        }
+      },
+    );
 }

package/src/cli/commands/discover.ts

@@ -0,0 +1,32 @@
+import type { CliOption } from "./options";
+import type { CAC } from "cac";
+import { features } from "../../constants";
+import { discover } from "../../features";
+import { options } from "./options";
+
+export function registerDiscoverCommand(cli: CAC) {
+  cli
+    // -----------------------------------------------------------------------
+    // Command
+    // -----------------------------------------------------------------------
+    .command(features.discover.name, features.discover.title)
+
+    // -----------------------------------------------------------------------
+    // Options
+    // -----------------------------------------------------------------------
+    .option(...options.debug)
+
+    // -----------------------------------------------------------------------
+    // Action
+    // -----------------------------------------------------------------------
+    .action(async (options: Pick<CliOption, "debug">) => {
+      const { debug } = options;
+
+      try {
+        await discover({ debug });
+      } catch (error) {
+        console.error(error instanceof Error ? error.message : error);
+        process.exitCode = 1;
+      }
+    });
+}

package/src/cli/commands/generate.ts

@@ -1,6 +1,10 @@
-import type { ExtraExt } from "../../core";
+import type { CliOption } from "./options";
 import type { CAC } from "cac";
+import { features } from "../../constants";
 import { generate } from "../../features";
+import { version } from "../version";
+import { options } from "./options";
+import { normalizeMessageFiles } from "./utils/normalize-message-files";
 import { normalizeReaderOptions } from "./utils/normalize-reader-options";
 
 export function registerGenerateCommand(cli: CAC) {
@@ -8,53 +12,44 @@ export function registerGenerateCommand(cli: CAC) {
     // -----------------------------------------------------------------------
     // Command
     // -----------------------------------------------------------------------
-    .command("generate", "Generate intor types and schemas")
+    .command(features.generate.name, features.generate.title)
 
     // -----------------------------------------------------------------------
     // Option
     // -----------------------------------------------------------------------
-    .option(
-      "--messages <path>",
-      "Explicit messages file for schema generation (bypass runtime loader)",
-    )
-    .option(
-      "--ext <ext>",
-      "Enable extra messages file extension (repeatable)",
-      { default: [] },
-    )
-    .option(
-      "--reader <mapping>",
-      "Custom reader mapping in the form <ext=path> (repeatable)",
-      { default: [] },
-    )
-    .option(
-      "--debug",
-      "Print debug information during config discovery and generation",
-    )
+    .option(...options.debug)
+    .option(...options.messageFile)
+    .option(...options.messageFiles)
+    .option(...options.ext)
+    .option(...options.reader)
 
     // -----------------------------------------------------------------------
     // Action
     // -----------------------------------------------------------------------
-    .action(async (options) => {
-      const { messages, ext, reader, debug } = options as {
-        messages?: string;
-        ext?: Array<ExtraExt>;
-        reader?: string[];
-        debug?: boolean;
-      };
+    .action(
+      async (
+        options: Pick<
+          CliOption,
+          "debug" | "messageFile" | "messageFiles" | "ext" | "reader"
+        >,
+      ) => {
+        const { debug, messageFile, messageFiles, ...readerOptions } = options;
 
-      const { exts, customReaders } = normalizeReaderOptions({ ext, reader });
+        const result = normalizeMessageFiles(messageFile, messageFiles);
+        const { exts, customReaders } = normalizeReaderOptions(readerOptions);
 
-      try {
-        await generate({
-          messageFilePath: messages,
-          exts,
-          customReaders,
-          debug,
-        });
-      } catch (error) {
-        console.error(error);
-        process.exitCode = 1;
-      }
-    });
+        try {
+          await generate({
+            debug,
+            messageSource: result,
+            exts,
+            customReaders,
+            toolVersion: version,
+          });
+        } catch (error) {
+          console.error(error instanceof Error ? error.message : error);
+          process.exitCode = 1;
+        }
+      },
+    );
 }

package/src/cli/commands/index.ts

@@ -0,0 +1,4 @@
+export { registerDiscoverCommand } from "./discover";
+export { registerGenerateCommand } from "./generate";
+export { registerCheckCommand } from "./check";
+export { registerValidateCommand } from "./validate";

package/src/cli/commands/options/index.ts

@@ -0,0 +1 @@
+export { options, type CliOptions as CliOption } from "./options";

package/src/cli/commands/options/options.ts

@@ -0,0 +1,55 @@
+import type { CAC } from "cac";
+
+export const options = {
+  debug: ["--debug", "Enable debug logging", { default: false }],
+
+  tsconfig: [
+    "--tsconfig <path>",
+    "Path to tsconfig.json (default: tsconfig.json)",
+  ],
+
+  messageFile: [
+    "--message-file <file>",
+    "Explicit message file for single-config projects",
+  ],
+
+  messageFiles: [
+    "--message-files <mapping...>",
+    "Explicit message file mapping in the form <configId=path> (repeatable)",
+    { default: [] },
+  ],
+
+  ext: [
+    "--ext <ext>",
+    "Enable extra messages file extension (repeatable)",
+    { default: [] },
+  ],
+
+  reader: [
+    "--reader <mapping>",
+    "Custom reader mapping in the form <ext=path> (repeatable)",
+    { default: [] },
+  ],
+
+  format: [
+    "--format <format>",
+    "Output format: human | json",
+    { default: "human" },
+  ],
+
+  output: [
+    "--output <file>",
+    "Write output to file (only applies to json format)",
+  ],
+} as const satisfies Record<string, Parameters<CAC["option"]>>;
+
+export interface CliOptions {
+  debug?: boolean;
+  tsconfig?: string;
+  messageFile?: string;
+  messageFiles?: string[];
+  ext?: string[];
+  reader?: string[];
+  format?: "human" | "json";
+  output?: string;
+}

package/src/cli/commands/utils/normalize-message-files.ts

@@ -0,0 +1,49 @@
+import type { MessageSource } from "../../../features";
+
+/**
+ * Normalize message file CLI options into a MessageSource.
+ */
+export function normalizeMessageFiles(
+  messageFile?: string,
+  messageFiles: string[] = [],
+): MessageSource {
+  if (messageFile && messageFiles.length > 0) {
+    throw new Error(
+      "Cannot use --message-file and --message-files at the same time.",
+    );
+  }
+
+  // --------------------------------------------------
+  // single mode
+  // --------------------------------------------------
+  if (messageFile) {
+    return {
+      mode: "single",
+      file: messageFile,
+    };
+  }
+
+  // --------------------------------------------------
+  // mapping mode
+  // --------------------------------------------------
+  if (messageFiles.length > 0) {
+    const files: Record<string, string> = {};
+
+    for (const messageFile of messageFiles) {
+      const [id, path] = messageFile.split("=", 2);
+      if (!id || !path) {
+        throw new Error(
+          `Invalid --message-files entry: "${messageFile}". Each entry must be in the form: <configId=path>`,
+        );
+      }
+      files[id] = path;
+    }
+
+    return {
+      mode: "mapping",
+      files,
+    };
+  }
+
+  return { mode: "none" };
+}

package/src/cli/commands/utils/normalize-reader-options.ts

@@ -1,46 +1,33 @@
-import type { ExtraExt } from "../../../core";
-
-export interface NormalizedReaderOptions {
-  exts: ExtraExt[];
-  customReaders?: Record<string, string>;
-}
-
-export interface RawReaderOptions {
-  ext?: string | string[];
-  reader?: string[];
-}
+import type { ReaderOptions, ExtraExt } from "../../../core";
+import type { CliOptions } from "../options/options";
 
 /**
- * Normalize CLI reader-related options:
- * - ext: string | string[] → string[]
- * - reader: ["md=./reader.ts"] → { md: "./reader.ts" }
+ * Normalize CLI reader-related options
  */
-export function normalizeReaderOptions(
-  options: RawReaderOptions,
-): NormalizedReaderOptions {
-  // Normalize exts
-  const exts = options.ext
-    ? Array.isArray(options.ext)
-      ? options.ext
-      : [options.ext]
-    : [];
-
+export function normalizeReaderOptions({
+  ext = [],
+  reader = [],
+}: Pick<CliOptions, "ext" | "reader">): ReaderOptions {
   // Normalize custom readers
   let customReaders: Record<string, string> | undefined;
 
-  if (options.reader && options.reader.length > 0) {
+  if (reader && reader.length > 0) {
     customReaders = {};
 
-    for (const item of options.reader) {
+    for (const item of reader) {
       const [key, value] = item.split("=", 2);
-      if (!key || !value) continue;
+      if (!key || !value) {
+        throw new Error(
+          `Invalid --reader entry: "${item}". Each entry must be in the form: <ext=path>`,
+        );
+      }
 
       customReaders[key] = value;
     }
   }
 
   return {
-    exts: exts as ExtraExt[],
+    exts: ext as ExtraExt[],
     customReaders,
   };
 }

package/src/cli/commands/validate.ts

@@ -1,6 +1,8 @@
-import type { ExtraExt } from "../../core";
+import type { CliOptions } from "./options/options";
 import type { CAC } from "cac";
+import { features } from "../../constants";
 import { validate } from "../../features";
+import { options } from "./options";
 import { normalizeReaderOptions } from "./utils/normalize-reader-options";
 
 export function registerValidateCommand(cli: CAC) {
@@ -8,43 +10,37 @@ export function registerValidateCommand(cli: CAC) {
     // -----------------------------------------------------------------------
     // Command
     // -----------------------------------------------------------------------
-    .command("validate", "Validate intor locale translations")
+    .command(features.validate.name, features.validate.title)
 
     // -----------------------------------------------------------------------
     // Option
     // -----------------------------------------------------------------------
-    .option(
-      "--ext <ext>",
-      "Enable extra messages file extension (repeatable)",
-      { default: [] },
-    )
-    .option(
-      "--reader <mapping>",
-      "Custom reader mapping in the form <ext=path> (repeatable)",
-      { default: [] },
-    )
-    .option(
-      "--debug",
-      "Print debug information during config discovery and generation",
-    )
+    .option(...options.debug)
+    .option(...options.ext)
+    .option(...options.reader)
+    .option(...options.format)
+    .option(...options.output)
 
     // -----------------------------------------------------------------------
     // Action
     // -----------------------------------------------------------------------
-    .action(async (options) => {
-      const { ext, reader, debug } = options as {
-        ext?: Array<ExtraExt>;
-        reader?: string[];
-        debug?: boolean;
-      };
+    .action(
+      async (
+        options: Pick<
+          CliOptions,
+          "debug" | "ext" | "reader" | "format" | "output"
+        >,
+      ) => {
+        const { debug, format, output, ...readerOptions } = options;
 
-      const { exts, customReaders } = normalizeReaderOptions({ ext, reader });
+        const { exts, customReaders } = normalizeReaderOptions(readerOptions);
 
-      try {
-        await validate({ exts, customReaders, debug });
-      } catch (error) {
-        console.error(error);
-        process.exitCode = 1;
-      }
-    });
+        try {
+          await validate({ debug, format, output, exts, customReaders });
+        } catch (error) {
+          console.error(error instanceof Error ? error.message : error);
+          process.exitCode = 1;
+        }
+      },
+    );
 }

package/src/cli/index.ts

@@ -1,10 +1,13 @@
 #!/usr/bin/env tsx
 
 import { cac } from "cac";
-import { registerCheckCommand } from "./commands/check";
-import { registerGenerateCommand } from "./commands/generate";
-import { registerValidateCommand } from "./commands/validate";
-import { runInteractive } from "./interactive/run";
+import {
+  registerDiscoverCommand,
+  registerGenerateCommand,
+  registerCheckCommand,
+  registerValidateCommand,
+} from "./commands";
+import { run } from "./menu";
 
 const VERSION = "0.1.10";
 
@@ -13,10 +16,10 @@ async function main() {
   const args = process.argv.slice(2);
 
   // -------------------------------------------------------------------
-  // Interactive mode bypasses CAC entirely
+  // Interactive menu bypasses CAC entirely
   // -------------------------------------------------------------------
   if (args.length === 0) {
-    await runInteractive();
+    await run();
     return;
   }
 
@@ -25,6 +28,7 @@ async function main() {
   // -------------------------------------------------------------------
   const cli = cac("intor");
 
+  registerDiscoverCommand(cli);
   registerGenerateCommand(cli);
   registerCheckCommand(cli);
   registerValidateCommand(cli);

package/src/cli/menu/index.ts

@@ -0,0 +1 @@
+export { run } from "./run";

package/src/cli/menu/prompts/prompt-check.ts

@@ -0,0 +1,74 @@
+import type { CheckOptions } from "../../../features";
+import { text, isCancel, confirm } from "@clack/prompts";
+import {
+  promptMode,
+  promptDebug,
+  printOptionsSummary,
+  promptFormat,
+  promptOutput,
+} from "./shared/shared";
+
+export async function promptCheck(): Promise<CheckOptions | null> {
+  // ------------------------------------------------------------------
+  // Mode
+  // ------------------------------------------------------------------
+  const mode = await promptMode();
+  if (!mode) return null;
+  if (mode === "default") return {};
+
+  const options: CheckOptions = {};
+
+  // ------------------------------------------------------------------
+  // tsconfig path
+  // ------------------------------------------------------------------
+  const useCustomTsconfig = await confirm({
+    message: "Do you want to use a custom tsconfig file?",
+    initialValue: false,
+  });
+  if (isCancel(useCustomTsconfig)) return null;
+
+  if (useCustomTsconfig) {
+    const path = await text({
+      message: "Path to tsconfig file",
+      placeholder: "tsconfig.json",
+      defaultValue: "tsconfig.json",
+    });
+    if (isCancel(path)) return null;
+    options.tsconfigPath = path || undefined;
+  }
+
+  // ------------------------------------------------------------------
+  // Output format
+  // ------------------------------------------------------------------
+  const format = await promptFormat();
+  if (!format) return null;
+  options.format = format;
+
+  // ------------------------------------------------------------------
+  // Output file (only for json)
+  // ------------------------------------------------------------------
+  if (format === "json") {
+    const output = await promptOutput();
+    if (output === null) return null;
+    options.output = output;
+  }
+
+  // ------------------------------------------------------------------
+  // Debug
+  // ------------------------------------------------------------------
+  const debug = await promptDebug();
+  if (debug === null) return null;
+  if (debug) options.debug = true;
+
+  // ------------------------------------------------------------------
+  // Summary
+  // ------------------------------------------------------------------
+  printOptionsSummary("Check options", [
+    ["tsconfig", options.tsconfigPath ?? "tsconfig.json"],
+    ["format", options.format ?? "human"],
+    ["output", options.output ?? "stdout"],
+    ["debug", options.debug ? "on" : "off"],
+  ]);
+
+  return options;
+}