gunshi 0.24.0 → 0.25.1

package/lib/{cli-BVD3QITm.js → cli-DVGNVw3h.js}

@@ -1,6 +1,6 @@
 import { ANONYMOUS_COMMAND_NAME, COMMAND_OPTIONS_DEFAULT, COMMON_ARGS, create, isLazyCommand, resolveLazyCommand } from "./utils-D41C8Abf.js";
-import { createCommandContext } from "./context-COFfMm-R.js";
-import { renderHeader, renderUsage, renderValidationErrors } from "./renderer-kzo45gaB.js";
+import { createCommandContext } from "./context-D_EmfRNA.js";
+import { renderHeader, renderUsage, renderValidationErrors } from "./renderer-BzRfaLdJ.js";
 import { parseArgs, resolveArgs } from "args-tokens";
 
 //#region src/cli.ts
@@ -19,7 +19,8 @@ async function cli(argv, entry, options = {}) {
 	if (!command) throw new Error(`Command not found: ${name || ""}`);
 	const args = resolveArguments(getCommandArgs(command));
 	const { values, positionals, rest, error } = resolveArgs(args, tokens, {
-		optionGrouping: true,
+		shortGrouping: true,
+		toKebab: command.toKebab,
 		skipPositional: cliOptions.subCommands.size > 0 ? 0 : -1
 	});
 	const omitted = !subCommand;

package/lib/{context-COFfMm-R.js → context-D_EmfRNA.js}

@@ -137,6 +137,7 @@ async function createCommandContext({ args, values, positionals, rest, argv, tok
 		rest,
 		_: argv,
 		tokens,
+		toKebab: command.toKebab,
 		log: cliOptions.usageSilent ? NOOP : log,
 		loadCommands,
 		translate

package/lib/context.d.ts

@@ -1,4 +1,4 @@
-import { CliOptions, Command, CommandCallMode, CommandContext, LazyCommand } from "./types-BDWiiycu.js";
+import { CliOptions, Command, CommandCallMode, CommandContext, LazyCommand } from "./types-DtEE4hKC.js";
 import { ArgToken, ArgValues, Args } from "args-tokens";
 
 //#region src/context.d.ts

package/lib/context.js

@@ -1,4 +1,4 @@
 import "./utils-D41C8Abf.js";
-import { createCommandContext } from "./context-COFfMm-R.js";
+import { createCommandContext } from "./context-D_EmfRNA.js";
 
 export { createCommandContext };

package/lib/{definition-zTfMFgKw.d.ts → definition-CKKX4Yvy.d.ts}

@@ -1,4 +1,4 @@
-import { Command, CommandLoader, LazyCommand } from "./types-BDWiiycu.js";
+import { Command, CommandLoader, LazyCommand } from "./types-DtEE4hKC.js";
 import { ArgSchema, ArgValues as ArgValues$1, Args, Args as Args$1 } from "args-tokens";
 
 //#region src/definition.d.ts

package/lib/{definition-DyVBFqB7.js → definition-wq1Kmbvq.js}

@@ -20,6 +20,7 @@ function lazy(loader, definition) {
 		loader.args = definition.args;
 		loader.examples = definition.examples;
 		loader.resource = definition.resource;
+		loader.toKebab = definition.toKebab;
 	}
 	return loader;
 }

package/lib/definition.d.ts

@@ -1,3 +1,3 @@
-import "./types-BDWiiycu.js";
-import { ArgSchema, ArgValues, Args, define$1 as define, lazy$1 as lazy } from "./definition-zTfMFgKw.js";
+import "./types-DtEE4hKC.js";
+import { ArgSchema, ArgValues, Args, define$1 as define, lazy$1 as lazy } from "./definition-CKKX4Yvy.js";
 export { ArgSchema, ArgValues, Args, define, lazy };

package/lib/definition.js

@@ -1,3 +1,3 @@
-import { define, lazy } from "./definition-DyVBFqB7.js";
+import { define, lazy } from "./definition-wq1Kmbvq.js";
 
 export { define, lazy };

package/lib/generator.d.ts

@@ -1,4 +1,4 @@
-import { CliOptions, Command, LazyCommand } from "./types-BDWiiycu.js";
+import { CliOptions, Command, LazyCommand } from "./types-DtEE4hKC.js";
 import { Args } from "args-tokens";
 
 //#region src/generator.d.ts

package/lib/generator.js

@@ -1,7 +1,7 @@
 import { create } from "./utils-D41C8Abf.js";
-import "./context-COFfMm-R.js";
-import "./renderer-kzo45gaB.js";
-import { cli } from "./cli-BVD3QITm.js";
+import "./context-D_EmfRNA.js";
+import "./renderer-BzRfaLdJ.js";
+import { cli } from "./cli-DVGNVw3h.js";
 
 //#region src/generator.ts
 /**

package/lib/index.d.ts

@@ -1,5 +1,5 @@
-import { CliOptions, Command, CommandArgKeys, CommandBuiltinArgsKeys, CommandBuiltinKeys, CommandBuiltinResourceKeys, CommandCallMode, CommandContext, CommandEnvironment, CommandExamplesFetcher, CommandLoader, CommandResource, CommandResourceFetcher, CommandRunner, Commandable, DEFAULT_LOCALE, GenerateNamespacedKey, KeyOfArgs, LazyCommand, RemovedIndex, TranslationAdapter, TranslationAdapterFactory, TranslationAdapterFactoryOptions } from "./types-BDWiiycu.js";
-import { define$1 as define, lazy$1 as lazy } from "./definition-zTfMFgKw.js";
+import { CliOptions, Command, CommandArgKeys, CommandBuiltinArgsKeys, CommandBuiltinKeys, CommandBuiltinResourceKeys, CommandCallMode, CommandContext, CommandEnvironment, CommandExamplesFetcher, CommandLoader, CommandResource, CommandResourceFetcher, CommandRunner, Commandable, DEFAULT_LOCALE, GenerateNamespacedKey, KeyOfArgs, LazyCommand, RemovedIndex, TranslationAdapter, TranslationAdapterFactory, TranslationAdapterFactoryOptions } from "./types-DtEE4hKC.js";
+import { define$1 as define, lazy$1 as lazy } from "./definition-CKKX4Yvy.js";
 import { ArgSchema, ArgValues, Args, Args as Args$1, parseArgs, resolveArgs } from "args-tokens";
 
 //#region src/cli.d.ts

package/lib/index.js

@@ -1,8 +1,8 @@
 import { DEFAULT_LOCALE$1 as DEFAULT_LOCALE } from "./utils-D41C8Abf.js";
-import { DefaultTranslation } from "./context-COFfMm-R.js";
-import { define, lazy } from "./definition-DyVBFqB7.js";
-import "./renderer-kzo45gaB.js";
-import { cli } from "./cli-BVD3QITm.js";
+import { DefaultTranslation } from "./context-D_EmfRNA.js";
+import { define, lazy } from "./definition-wq1Kmbvq.js";
+import "./renderer-BzRfaLdJ.js";
+import { cli } from "./cli-DVGNVw3h.js";
 import { parseArgs, resolveArgs } from "args-tokens";
 
 export { DEFAULT_LOCALE, DefaultTranslation, cli, define, lazy, parseArgs, resolveArgs };

package/lib/{renderer-kzo45gaB.js → renderer-BzRfaLdJ.js}

@@ -1,4 +1,5 @@
 import { COMMON_ARGS, create, resolveArgKey, resolveBuiltInKey, resolveExamples } from "./utils-D41C8Abf.js";
+import { kebabnize } from "args-tokens/utils";
 
 //#region src/renderer/header.ts
 /**
@@ -187,8 +188,9 @@ function hasAllDefaultOptions(ctx) {
 function generateOptionsSymbols(ctx) {
 	return hasOptionalArgs(ctx) ? hasAllDefaultOptions(ctx) ? `[${ctx.translate(resolveBuiltInKey("OPTIONS"))}]` : `<${ctx.translate(resolveBuiltInKey("OPTIONS"))}>` : "";
 }
-function makeShortLongOptionPair(schema, name) {
-	let key = `--${name}`;
+function makeShortLongOptionPair(schema, name, toKebab) {
+	const displayName = toKebab || schema.toKebab ? kebabnize(name) : name;
+	let key = `--${displayName}`;
 	if (schema.short) key = `-${schema.short}, ${key}`;
 	return key;
 }
@@ -198,12 +200,18 @@ function makeShortLongOptionPair(schema, name) {
 * @returns Options pairs for usage
 */
 function getOptionalArgsPairs(ctx) {
-	return Object.entries(ctx.args).reduce((acc, [name, value]) => {
-		if (value.type === "positional") return acc;
-		let key = makeShortLongOptionPair(value, name);
-		if (value.type !== "boolean") key = value.default ? `${key} [${name}]` : `${key} <${name}>`;
+	return Object.entries(ctx.args).reduce((acc, [name, schema]) => {
+		if (schema.type === "positional") return acc;
+		let key = makeShortLongOptionPair(schema, name, ctx.toKebab);
+		if (schema.type !== "boolean") {
+			const displayName = ctx.toKebab || schema.toKebab ? kebabnize(name) : name;
+			key = schema.default ? `${key} [${displayName}]` : `${key} <${displayName}>`;
+		}
 		acc[name] = key;
-		if (value.type === "boolean" && value.negatable && !COMMON_ARGS_KEYS.includes(name)) acc[`no-${name}`] = `--no-${name}`;
+		if (schema.type === "boolean" && schema.negatable && !COMMON_ARGS_KEYS.includes(name)) {
+			const displayName = ctx.toKebab || schema.toKebab ? kebabnize(name) : name;
+			acc[`no-${name}`] = `--no-${displayName}`;
+		}
 		return acc;
 	}, create());
 }
@@ -217,7 +225,7 @@ function generateDefaultDisplayValue(ctx, schema) {
 function resolveDisplayValue(ctx, key) {
 	if (COMMON_ARGS_KEYS.includes(key)) return "";
 	const schema = ctx.args[key];
-	if ((schema.type === "boolean" || schema.type === "number" || schema.type === "string") && schema.default !== void 0) return `(${generateDefaultDisplayValue(ctx, schema)})`;
+	if ((schema.type === "boolean" || schema.type === "number" || schema.type === "string" || schema.type === "custom") && schema.default !== void 0) return `(${generateDefaultDisplayValue(ctx, schema)})`;
 	if (schema.type === "enum") {
 		const _default = schema.default !== void 0 ? generateDefaultDisplayValue(ctx, schema) : "";
 		const choices = `${ctx.translate(resolveBuiltInKey("CHOICES"))}: ${schema.choices.join(" | ")}`;
@@ -239,7 +247,7 @@ async function generateOptionalArgsUsage(ctx, optionsPairs) {
 		if (!rawDesc && key.startsWith("no-")) {
 			const name = resolveNegatableKey(key);
 			const schema = ctx.args[name];
-			const optionKey = makeShortLongOptionPair(schema, name);
+			const optionKey = makeShortLongOptionPair(schema, name, ctx.toKebab);
 			rawDesc = `${ctx.translate(resolveBuiltInKey("NEGATABLE"))} ${optionKey}`;
 		}
 		const optionsSchema = ctx.env.usageOptionType ? `[${resolveNegatableType(key, ctx)}] ` : "";

package/lib/renderer.d.ts

@@ -1,4 +1,4 @@
-import { CommandContext } from "./types-BDWiiycu.js";
+import { CommandContext } from "./types-DtEE4hKC.js";
 import { Args } from "args-tokens";
 
 //#region src/renderer/header.d.ts

package/lib/renderer.js

@@ -1,4 +1,4 @@
 import "./utils-D41C8Abf.js";
-import { renderHeader, renderUsage, renderValidationErrors } from "./renderer-kzo45gaB.js";
+import { renderHeader, renderUsage, renderValidationErrors } from "./renderer-BzRfaLdJ.js";
 
 export { renderHeader, renderUsage, renderValidationErrors };

package/lib/{types-BDWiiycu.d.ts → types-DtEE4hKC.d.ts}

@@ -271,11 +271,17 @@ interface CommandContext<A extends Args = Args, V = ArgValues<A>> {
    * The command call mode is `entry` when the command is executed as an entry command, and `subCommand` when the command is executed as a sub-command.
    */
   callMode: CommandCallMode;
+  /**
+   * Whether to convert the camel-case style argument name to kebab-case.
+   * This context value is set from {@link Command.toKebab} option.
+   */
+  toKebab?: boolean;
   /**
    * Output a message.
    * If {@link CommandEnvironment.usageSilent} is true, the message is not output.
    * @param message an output message, @see {@link console.log}
    * @param optionalParams an optional parameters, @see {@link console.log}
+   * @internal
    */
   log: (message?: any, ...optionalParams: any[]) => void;
   /**
@@ -324,6 +330,11 @@ interface Command<A extends Args = Args> {
    * Command resource fetcher.
    */
   resource?: CommandResourceFetcher<A>;
+  /**
+   * Whether to convert the camel-case style argument name to kebab-case.
+   * If you will set to `true`, All {@link Command.args} names will be converted to kebab-case.
+   */
+  toKebab?: boolean;
 }
 /**
  * Command resource.

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "gunshi",
   "description": "Modern javascript command-line library",
-  "version": "0.24.0",
+  "version": "0.25.1",
   "author": {
     "name": "kazuya kawaguchi",
     "email": "kawakazu80@gmail.com"
@@ -13,7 +13,8 @@
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/kazupon/gunshi.git"
+    "url": "git+https://github.com/kazupon/gunshi.git",
+    "directory": "packages/gunshi"
   },
   "keywords": [
     "command",
@@ -78,95 +79,21 @@
     }
   },
   "dependencies": {
-    "args-tokens": "^0.18.0"
+    "args-tokens": "^0.20.1"
   },
   "devDependencies": {
-    "@eslint/markdown": "^6.4.0",
     "@intlify/core": "next",
-    "@kazupon/eslint-config": "^0.29.0",
-    "@kazupon/prettier-config": "^0.1.1",
-    "@types/node": "^22.15.21",
-    "@typescript/native-preview": "7.0.0-dev.20250522.2",
-    "@vitest/eslint-plugin": "^1.2.0",
-    "bumpp": "^10.1.1",
     "deno": "^2.3.3",
-    "eslint": "^9.27.0",
-    "eslint-config-prettier": "^10.1.5",
-    "eslint-import-resolver-typescript": "^4.3.5",
-    "eslint-plugin-import": "^2.31.0",
-    "eslint-plugin-jsonc": "^2.20.1",
-    "eslint-plugin-module-interop": "^0.3.1",
-    "eslint-plugin-promise": "^7.2.1",
-    "eslint-plugin-regexp": "^2.7.0",
-    "eslint-plugin-unicorn": "^58.0.0",
-    "eslint-plugin-unused-imports": "^4.1.4",
-    "eslint-plugin-vue": "^10.1.0",
-    "eslint-plugin-vue-composable": "^1.0.0",
-    "eslint-plugin-yml": "^1.18.0",
-    "gh-changelogen": "^0.2.8",
-    "gunshi019": "npm:gunshi@0.23.1",
     "jsr": "^0.13.4",
     "jsr-exports-lint": "^0.4.0",
-    "knip": "^5.57.2",
-    "lint-staged": "^16.0.0",
     "messageformat": "4.0.0-12",
-    "mitata": "^1.0.34",
-    "pkg-pr-new": "^0.0.50",
-    "prettier": "^3.5.3",
     "publint": "^0.3.12",
-    "tsdown": "^0.12.2",
-    "typedoc": "^0.28.4",
-    "typedoc-plugin-markdown": "^4.6.3",
-    "typedoc-vitepress-theme": "^1.1.2",
-    "typescript-eslint": "^8.32.1",
-    "vitepress": "^1.6.3",
-    "vitepress-plugin-group-icons": "^1.5.5",
-    "vitepress-plugin-llms": "^1.3.3",
-    "vitest": "^3.1.4",
-    "vue": "^3.5.14"
-  },
-  "prettier": "@kazupon/prettier-config",
-  "lint-staged": {
-    "*.ts?(x)": [
-      "prettier --parser=typescript --write",
-      "eslint --fix"
-    ],
-    "*.{js,mjs,cjs}": [
-      "prettier --write",
-      "eslint --fix"
-    ],
-    "*.{json,jsonc,json5,md,yml,yaml}": [
-      "prettier --write"
-    ]
+    "tsdown": "^0.12.3",
+    "zod": "^3.25.28"
   },
   "scripts": {
-    "bench:mitata": "node --expose-gc bench/mitata.js",
-    "bench:vitest": "vitest bench --run",
     "build": "tsdown",
-    "changelog": "gh-changelogen --repo=kazupon/gunshi",
-    "clean": "git clean -df",
-    "dev": "pnpx @eslint/config-inspector --config eslint.config.ts",
-    "dev:eslint": "pnpx @eslint/config-inspector --config eslint.config.ts",
-    "dev:typedoc": "typedoc --watch --preserveWatchOutput",
-    "docs:build": "pnpm run docs:build:typedoc && pnpm docs:build:vitepress",
-    "docs:build:typedoc": "typedoc --excludeInternal",
-    "docs:build:vitepress": "vitepress build docs",
-    "docs:dev": "pnpm run docs:build:typedoc && pnpm docs:dev:vitepress",
-    "docs:dev:vitepress": "vitepress dev docs",
-    "docs:preview": "vitepress preview docs",
-    "fix": "pnpm run --stream --color \"/^fix:/\"",
-    "fix:eslint": "eslint . --fix",
-    "fix:knip": "knip --fix --no-exit-code",
-    "fix:prettier": "prettier . --write",
-    "lint": "pnpm run --stream --color \"/^lint:/\"",
-    "lint:eslint": "eslint .",
     "lint:jsr": "jsr publish --dry-run --allow-dirty",
-    "lint:knip": "knip",
-    "lint:prettier": "prettier . --check",
-    "release": "bumpp --commit \"release: v%s\" --all --push --tag",
-    "test": "vitest --typecheck run",
-    "typecheck": "pnpm run --stream --color \"/^typecheck:/\"",
-    "typecheck:deno": "deno check --all ./src",
-    "typecheck:tsc": "tsgo --noEmit"
+    "typecheck:deno": "deno check --all ./src"
   }
 }

package/README.md

@@ -1,142 +0,0 @@
-<p align="center">
-	<img width="196" src="./assets/logo.png">
-</p>
-<h1 align="center">🏯 Gunshi</h1>
-
-[![Version][npm-version-src]][npm-version-href]
-[![CI][ci-src]][ci-href]
-[![InstallSize][install-size-src]][install-size-src]
-[![JSR][jsr-src]][jsr-href]
-
-Gunshi is a modern javascript command-line library
-
-<!-- eslint-disable markdown/no-missing-label-refs -->
-
-> [!TIP]
-> gunshi (軍師) is a position in ancient Japanese samurai battle in which a samurai devised strategies and gave orders. That name is inspired by the word "command".
-
-<!-- eslint-enable markdown/no-missing-label-refs -->
-
-## ✨ Features
-
-Gunshi is designed to simplify the creation of modern command-line interfaces:
-
-- 📏 **Simple & Universal**: Run the commands with simple API and support universal runtime.
-- ⚙️ **Declarative configuration**: Configure command modules declaratively for better organization and maintainability.
-- 🛡️ **Type Safe**: TypeScript support with type-safe argument parsing and option resolution by [args-tokens](https://github.com/kazupon/args-tokens)
-- 🧩 **Composable**: Create modular sub-commands that can be composed together for complex CLIs.
-- ⏳ **Lazy & Async**: Load command modules lazily and execute them asynchronously for better performance.
-- 📜 **Auto usage generation**: Generate helpful usage messages automatically for your commands.
-- 🎨 **Custom usage generation**: Customize how usage messages are generated to match your CLI's style.
-- 🌍 **Internationalization**: Support multiple languages with built-in i18n, locale resource lazy loading and i18n library integration.
-
-## 💿 Installation
-
-```sh
-# npm
-npm install --save gunshi
-
-## pnpm
-pnpm add gunshi
-
-## yarn
-yarn add gunshi
-
-## deno
-deno add jsr:@kazupon/gunshi
-
-## bun
-bun add gunshi
-```
-
-## 🚀 Usage
-
-```js
-import { cli } from 'gunshi'
-
-// define a command with declarative configuration, using commandable object
-const command = {
-  name: 'greet',
-  description: 'A greeting command',
-  options: {
-    name: {
-      type: 'string',
-      short: 'n',
-      description: 'Name to greet'
-    },
-    greeting: {
-      type: 'string',
-      short: 'g',
-      default: 'Hello',
-      description: 'Greeting to use (default: "Hello")'
-    },
-    times: {
-      type: 'number',
-      short: 't',
-      default: 1,
-      description: 'Number of times to repeat the greeting (default: 1)'
-    }
-  },
-  run: ctx => {
-    const { name = 'World', greeting, times } = ctx.values
-    for (let i = 0; i < times; i++) {
-      console.log(`${greeting}, ${name}!`)
-    }
-  }
-}
-
-// run a command that is defined above
-// (the 3rd argument of `cli` is the command option)
-await cli(process.argv.slice(2), command, {
-  name: 'my-app',
-  version: '1.0.0',
-  description: 'My CLI application'
-})
-```
-
-About more details and usage, see [documentations](https://gunshi.dev)
-
-## 💁‍♀️ Showcases
-
-- [pnpmc](https://github.com/kazupon/pnpmc): PNPM Catalogs Tooling
-- [sourcemap-publisher](https://github.com/es-tooling/sourcemap-publisher): A tool to publish sourcemaps externally and rewrite sourcemap URLs at pre-publish time
-- [curxy](https://github.com/ryoppippi/curxy): An proxy worker for using ollama in cursor
-
-## 🙌 Contributing guidelines
-
-If you are interested in contributing to `gunshi`, I highly recommend checking out [the contributing guidelines](/CONTRIBUTING.md) here. You'll find all the relevant information such as [how to make a PR](/CONTRIBUTING.md#pull-request-guidelines), [how to setup development](/CONTRIBUTING.md#development-setup)) etc., there.
-
-## 💖 Credits
-
-This project is inspired and powered by:
-
-- [`citty`](https://github.com/unjs/citty), created by [UnJS team](https://github.com/unjs) and contributors
-- [`ordana`](https://github.com/sapphi-red/ordana), createdy by [sapphi-red](https://github.com/sapphi-red), inspired documentation generation
-- cline and claude 3.7 sonnet, examples and docs is generated
-
-Thank you!
-
-## 🤝 Sponsors
-
-The development of Gunshi is supported by my OSS sponsors!
-
-<p align="center">
-  <a href="https://cdn.jsdelivr.net/gh/kazupon/sponsors/sponsors.svg">
-    <img src='https://cdn.jsdelivr.net/gh/kazupon/sponsors/sponsors.svg'/>
-  </a>
-</p>
-
-## ©️ License
-
-[MIT](http://opensource.org/licenses/MIT)
-
-<!-- Badges -->
-
-[npm-version-src]: https://img.shields.io/npm/v/gunshi?style=flat
-[npm-version-href]: https://npmjs.com/package/gunshi
-[jsr-src]: https://jsr.io/badges/@kazupon/gunshi
-[jsr-href]: https://jsr.io/@kazupon/gunshi
-[install-size-src]: https://pkg-size.dev/badge/install/72346
-[install-size-href]: https://pkg-size.dev/gunshi
-[ci-src]: https://github.com/kazupon/gunshi/actions/workflows/ci.yml/badge.svg
-[ci-href]: https://github.com/kazupon/gunshi/actions/workflows/ci.yml