@gunshi/resources 0.26.3

package/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 kazuya kawaguchi
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,121 @@
+# @gunshi/resources
+
+> built-in localization resources for gunshi
+
+This package provides multilingual resources for gunshi.
+っｋｗ
+
+## 💿 Installation
+
+```sh
+# npm
+npm install --save @gunshi/resources
+
+# pnpm
+pnpm add @gunshi/resources
+
+# yarn
+yarn add @gunshi/resources
+
+# deno
+deno add jsr:@gunshi/resources
+
+# bun
+bun add @gunshi/resources
+```
+
+## 🚀 Usage
+
+### Import all locales
+
+```ts
+import resources from '@gunshi/resources'
+
+console.log(resources['en-US']) // display en-US reousrces
+console.log(resources['ja-JP']) // display ja-JP resources
+```
+
+### Import specific locale
+
+You can import via sub paths.
+
+```ts
+// English resources
+import enUS from '@gunshi/resources/en-US' with { type: 'json' }
+
+// Japanese resources
+import jaJP from '@gunshi/resources/ja-JP' with { type: 'json' }
+```
+
+## ✨ Built-in Keys
+
+Keys for built-in functionalities are handled by Gunshi's default locales. The complete list includes:
+
+- `USAGE` - Usage section header
+- `OPTIONS` - Options section header
+- `ARGUMENTS` - Arguments section header
+- `COMMANDS` - Commands section header
+- `EXAMPLES` - Examples section header
+- `FORMORE` - Footer text for additional help
+- `NEGATABLE` - Prefix for negatable options (e.g., "Negatable of --verbose")
+- `DEFAULT` - Prefix for default values (e.g., "default: 5")
+- `CHOICES` - Prefix for available choices (e.g., "choices: red, green, blue")
+- `help` - Description for the help option ("Display this help message")
+- `version` - Description for the version option ("Display this version")
+  The following keys are provided for each locale:
+
+## 🌍 Supported Locales
+
+- `en-US` - English (United States)
+- `ja-JP` - Japanese (Japan)
+
+## 🧩 Usage in i18n plugin
+
+This package is internally used by gunshi plugins, particularly `@gunshi/plugin-i18n` and `@gunshi/plugin-renderer`.
+
+### Example with @gunshi/plugin-i18n
+
+```ts
+import i18n from '@gunshi/plugin-i18n'
+import resources from '@gunshi/resources'
+import { cli } from 'gunshi'
+
+await cli(
+  args,
+  {
+    /* your entry command */
+  },
+  {
+    plugins: [
+      i18n({
+        locale: 'ja-JP',
+        resources // Use @gunshi/resources directly
+      })
+    ]
+  }
+)
+```
+
+### Integration with Custom Resources
+
+```ts
+import resources from '@gunshi/resources'
+
+// Extend built-in resources
+const customResources = {
+  'en-US': {
+    ...resources['en-US'],
+    // Add custom keys
+    MY_CUSTOM_KEY: 'My custom message'
+  },
+  'ja-JP': {
+    ...resources['ja-JP'],
+    // Add custom keys
+    MY_CUSTOM_KEY: '私のカスタムメッセージ'
+  }
+}
+```
+
+## ©️ License
+
+[MIT](http://opensource.org/licenses/MIT)

package/lib/index.d.ts

@@ -0,0 +1,38 @@
+//#region src/index.d.ts
+/**
+ * @author kazuya kawaguchi (a.k.a. kazupon)
+ * @license MIT
+ */
+declare const _default: {
+  'en-US': {
+    COMMAND: string;
+    COMMANDS: string;
+    SUBCOMMAND: string;
+    USAGE: string;
+    ARGUMENTS: string;
+    OPTIONS: string;
+    EXAMPLES: string;
+    FORMORE: string;
+    NEGATABLE: string;
+    DEFAULT: string;
+    CHOICES: string;
+    help: string;
+    version: string;
+  };
+  'ja-JP': {
+    COMMAND: string;
+    COMMANDS: string;
+    SUBCOMMAND: string;
+    USAGE: string;
+    ARGUMENTS: string;
+    OPTIONS: string;
+    EXAMPLES: string;
+    FORMORE: string;
+    NEGATABLE: string;
+    DEFAULT: string;
+    CHOICES: string;
+    help: string;
+    version: string;
+  };
+}; //#endregion
+export { _default as default };

package/lib/index.js

@@ -0,0 +1,70 @@
+//#region locales/en-US.json
+var COMMAND$1 = "COMMAND";
+var COMMANDS$1 = "COMMANDS";
+var SUBCOMMAND$1 = "SUBCOMMAND";
+var USAGE$1 = "USAGE";
+var ARGUMENTS$1 = "ARGUMENTS";
+var OPTIONS$1 = "OPTIONS";
+var EXAMPLES$1 = "EXAMPLES";
+var FORMORE$1 = "For more info, run any command with the `--help` flag";
+var NEGATABLE$1 = "Negatable of";
+var DEFAULT$1 = "default";
+var CHOICES$1 = "choices";
+var help$1 = "Display this help message";
+var version$1 = "Display this version";
+var en_US_default = {
+	COMMAND: COMMAND$1,
+	COMMANDS: COMMANDS$1,
+	SUBCOMMAND: SUBCOMMAND$1,
+	USAGE: USAGE$1,
+	ARGUMENTS: ARGUMENTS$1,
+	OPTIONS: OPTIONS$1,
+	EXAMPLES: EXAMPLES$1,
+	FORMORE: FORMORE$1,
+	NEGATABLE: NEGATABLE$1,
+	DEFAULT: DEFAULT$1,
+	CHOICES: CHOICES$1,
+	help: help$1,
+	version: version$1
+};
+
+//#endregion
+//#region locales/ja-JP.json
+var COMMAND = "コマンド";
+var COMMANDS = "コマンド";
+var SUBCOMMAND = "サブコマンド";
+var USAGE = "使い方";
+var ARGUMENTS = "引数";
+var OPTIONS = "オプション";
+var EXAMPLES = "例";
+var FORMORE = "詳細は、コマンドと`--help`フラグを実行してください";
+var NEGATABLE = "否定可能な";
+var DEFAULT = "デフォルト";
+var CHOICES = "選択肢";
+var help = "このヘルプメッセージを表示";
+var version = "このバージョンを表示";
+var ja_JP_default = {
+	COMMAND,
+	COMMANDS,
+	SUBCOMMAND,
+	USAGE,
+	ARGUMENTS,
+	OPTIONS,
+	EXAMPLES,
+	FORMORE,
+	NEGATABLE,
+	DEFAULT,
+	CHOICES,
+	help,
+	version
+};
+
+//#endregion
+//#region src/index.ts
+var src_default = {
+	"en-US": en_US_default,
+	"ja-JP": ja_JP_default
+};
+
+//#endregion
+export { src_default as default };

package/locales/en-US.json

@@ -0,0 +1,15 @@
+{
+  "COMMAND": "COMMAND",
+  "COMMANDS": "COMMANDS",
+  "SUBCOMMAND": "SUBCOMMAND",
+  "USAGE": "USAGE",
+  "ARGUMENTS": "ARGUMENTS",
+  "OPTIONS": "OPTIONS",
+  "EXAMPLES": "EXAMPLES",
+  "FORMORE": "For more info, run any command with the `--help` flag",
+  "NEGATABLE": "Negatable of",
+  "DEFAULT": "default",
+  "CHOICES": "choices",
+  "help": "Display this help message",
+  "version": "Display this version"
+}

package/locales/ja-JP.json

@@ -0,0 +1,15 @@
+{
+  "COMMAND": "コマンド",
+  "COMMANDS": "コマンド",
+  "SUBCOMMAND": "サブコマンド",
+  "USAGE": "使い方",
+  "ARGUMENTS": "引数",
+  "OPTIONS": "オプション",
+  "EXAMPLES": "例",
+  "FORMORE": "詳細は、コマンドと`--help`フラグを実行してください",
+  "NEGATABLE": "否定可能な",
+  "DEFAULT": "デフォルト",
+  "CHOICES": "選択肢",
+  "help": "このヘルプメッセージを表示",
+  "version": "このバージョンを表示"
+}

package/package.json

@@ -0,0 +1,78 @@
+{
+  "name": "@gunshi/resources",
+  "description": "built-in localization resources for gunshi",
+  "version": "0.26.3",
+  "author": {
+    "name": "kazuya kawaguchi",
+    "email": "kawakazu80@gmail.com"
+  },
+  "license": "MIT",
+  "funding": "https://github.com/sponsors/kazupon",
+  "bugs": {
+    "url": "https://github.com/kazupon/gunshi/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/kazupon/gunshi.git",
+    "directory": "packages/resources"
+  },
+  "keywords": [
+    "gunshi",
+    "l10n",
+    "localization",
+    "cli"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "engines": {
+    "node": ">= 20"
+  },
+  "type": "module",
+  "files": [
+    "lib",
+    "locales"
+  ],
+  "module": "lib/index.js",
+  "exports": {
+    ".": {
+      "types": "./lib/index.d.ts",
+      "import": "./lib/index.js",
+      "require": "./lib/index.js",
+      "default": "./lib/index.js"
+    },
+    "./en-US": {
+      "import": "./locales/en-US.json",
+      "require": "./locales/en-US.json",
+      "default": "./locales/en-US.json"
+    },
+    "./ja-JP": {
+      "import": "./locales/ja-JP.json",
+      "require": "./locales/ja-JP.json",
+      "default": "./locales/ja-JP.json"
+    },
+    "./package.json": "./package.json"
+  },
+  "types": "lib/index.d.ts",
+  "typesVersions": {
+    "*": {
+      "*": [
+        "./lib/*",
+        "./*"
+      ]
+    }
+  },
+  "devDependencies": {
+    "@types/node": "^22.15.29",
+    "deno": "^2.3.3",
+    "jsr": "^0.13.4",
+    "jsr-exports-lint": "^0.4.1",
+    "publint": "^0.3.12",
+    "tsdown": "^0.12.3"
+  },
+  "scripts": {
+    "build": "tsdown",
+    "lint:jsr": "jsr publish --dry-run --allow-dirty",
+    "typecheck:deno": "deno check ./src"
+  }
+}