@gunshi/plugin-renderer 0.29.3 → 0.29.4

package/lib/index.js

@@ -1,5 +1,4 @@
 import { ANONYMOUS_COMMAND_NAME, plugin } from "@gunshi/plugin";
-
 //#region ../../node_modules/.pnpm/args-tokens@0.24.3/node_modules/args-tokens/lib/utils.js
 /**
 * Entry point of utils.
@@ -21,7 +20,6 @@ import { ANONYMOUS_COMMAND_NAME, plugin } from "@gunshi/plugin";
 function kebabnize(str) {
 	return str.replace(/[A-Z]/g, (match, offset) => (offset > 0 ? "-" : "") + match.toLowerCase());
 }
-
 //#endregion
 //#region ../gunshi/src/utils.ts
 /**
@@ -100,20 +98,8 @@ function deepFreeze(obj, ignores = []) {
 	}
 	return Object.freeze(obj);
 }
-
-//#endregion
-//#region ../shared/src/constants.ts
-/**
-* @author kazuya kawaguchi (a.k.a. kazupon)
-* @license MIT
-*/
-const BUILT_IN_PREFIX = "_";
-const PLUGIN_PREFIX = "g";
-const ARG_PREFIX = "arg";
-const BUILT_IN_KEY_SEPARATOR = ":";
-const BUILD_IN_PREFIX_AND_KEY_SEPARATOR = `${BUILT_IN_PREFIX}${BUILT_IN_KEY_SEPARATOR}`;
-const ARG_PREFIX_AND_KEY_SEPARATOR = `${ARG_PREFIX}${BUILT_IN_KEY_SEPARATOR}`;
-const ARG_NEGATABLE_PREFIX = "no-";
+const BUILD_IN_PREFIX_AND_KEY_SEPARATOR = `_:`;
+const ARG_PREFIX_AND_KEY_SEPARATOR = `arg:`;
 const COMMON_ARGS = {
 	help: {
 		type: "boolean",
@@ -126,7 +112,6 @@ const COMMON_ARGS = {
 		description: "Display this version"
 	}
 };
-
 //#endregion
 //#region ../resources/locales/en-US.json
 var NEGATABLE = "Negatable of";
@@ -145,7 +130,6 @@ var en_US_default = {
 	help: "Display this help message",
 	version: "Display this version"
 };
-
 //#endregion
 //#region ../shared/src/utils.ts
 /**
@@ -163,7 +147,7 @@ var en_US_default = {
 * @returns Prefixed built-in key.
 */
 function resolveBuiltInKey(key) {
-	return `${BUILT_IN_PREFIX}${BUILT_IN_KEY_SEPARATOR}${key}`;
+	return `_:${key}`;
 }
 /**
 * Resolve a namespaced key for argument resources.
@@ -178,7 +162,7 @@ function resolveBuiltInKey(key) {
 * @returns Prefixed argument key.
 */
 function resolveArgKey(key, name) {
-	return `${name ? `${name}${BUILT_IN_KEY_SEPARATOR}` : ""}${ARG_PREFIX}${BUILT_IN_KEY_SEPARATOR}${key}`;
+	return `${name ? `${name}:` : ""}arg:${key}`;
 }
 /**
 * Resolve a namespaced key for non-built-in resources.
@@ -192,7 +176,7 @@ function resolveArgKey(key, name) {
 * @returns Prefixed non-built-in key.
 */
 function resolveKey(key, name) {
-	return `${name ? `${name}${BUILT_IN_KEY_SEPARATOR}` : ""}${key}`;
+	return `${name ? `${name}:` : ""}${key}`;
 }
 /**
 * Resolve command examples.
@@ -215,7 +199,7 @@ async function resolveExamples$1(ctx, examples) {
 * @returns A namespaced key for the plugin.
 */
 function namespacedId(id) {
-	return `${PLUGIN_PREFIX}${BUILT_IN_KEY_SEPARATOR}${id}`;
+	return `g:${id}`;
 }
 /**
 * Generate a short and long option pair for command arguments.
@@ -230,7 +214,6 @@ function makeShortLongOptionPair(schema, name, toKebab) {
 	if (schema.short) key = `-${schema.short}, ${key}`;
 	return key;
 }
-
 //#endregion
 //#region ../shared/src/localization.ts
 /**
@@ -259,8 +242,8 @@ function localizable(ctx, cmd, translate) {
 		if (key.startsWith(namaspacedArgKey)) {
 			let argKey = key.slice(namaspacedArgKey.length);
 			let negatable = false;
-			if (argKey.startsWith(ARG_NEGATABLE_PREFIX)) {
-				argKey = argKey.slice(ARG_NEGATABLE_PREFIX.length);
+			if (argKey.startsWith("no-")) {
+				argKey = argKey.slice(3);
 				negatable = true;
 			}
 			const schema = ctx.args[argKey];
@@ -273,7 +256,6 @@ function localizable(ctx, cmd, translate) {
 	}
 	return localize;
 }
-
 //#endregion
 //#region src/header.ts
 /**
@@ -286,7 +268,6 @@ function renderHeader(ctx) {
 	const title = ctx.env.description || ctx.env.name || "";
 	return Promise.resolve(title ? `${title} (${ctx.env.name || ""}${ctx.env.version ? ` v${ctx.env.version}` : ""})` : title);
 }
-
 //#endregion
 //#region src/types.ts
 /**
@@ -297,7 +278,6 @@ function renderHeader(ctx) {
 * The unique identifier for usage renderer plugin.
 */
 const pluginId = namespacedId("renderer");
-
 //#endregion
 //#region src/usage.ts
 /**
@@ -533,14 +513,14 @@ function getOptionalArgsPairs(ctx) {
 		acc[name] = key;
 		if (schema.type === "boolean" && schema.negatable && !COMMON_ARGS_KEYS.includes(name)) {
 			const displayName = ctx.toKebab || schema.toKebab ? kebabnize(name) : name;
-			acc[`${ARG_NEGATABLE_PREFIX}${name}`] = `--${ARG_NEGATABLE_PREFIX}${displayName}`;
+			acc[`no-${name}`] = `--no-${displayName}`;
 		}
 		return acc;
 	}, Object.create(null));
 }
-const resolveNegatableKey = (key) => key.split(ARG_NEGATABLE_PREFIX)[1];
+const resolveNegatableKey = (key) => key.split("no-")[1];
 function resolveNegatableType(key, ctx) {
-	return ctx.args[key.startsWith(ARG_NEGATABLE_PREFIX) ? resolveNegatableKey(key) : key].type;
+	return ctx.args[key.startsWith("no-") ? resolveNegatableKey(key) : key].type;
 }
 async function generateDefaultDisplayValue(ctx, schema) {
 	return `${await ctx.extensions[pluginId].text(resolveBuiltInKey("DEFAULT"))}: ${schema.default}`;
@@ -568,14 +548,14 @@ async function generateOptionalArgsUsage(ctx, optionsPairs) {
 	const optionSchemaMaxLength = ctx.env.usageOptionType ? Math.max(...Object.entries(optionsPairs).map(([key]) => resolveNegatableType(key, ctx).length)) : 0;
 	return (await Promise.all(Object.entries(optionsPairs).map(async ([key, value]) => {
 		let rawDesc = await ctx.extensions[pluginId].text(resolveArgKey(key, ctx.name));
-		if (!rawDesc && key.startsWith(ARG_NEGATABLE_PREFIX)) {
+		if (!rawDesc && key.startsWith("no-")) {
 			const name = resolveNegatableKey(key);
 			const schema = ctx.args[name];
 			const optionKey = makeShortLongOptionPair(schema, name, ctx.toKebab);
 			rawDesc = `${await ctx.extensions[pluginId].text(resolveBuiltInKey("NEGATABLE"))} ${optionKey}`;
 		}
 		const optionsSchema = ctx.env.usageOptionType ? `[${resolveNegatableType(key, ctx)}] ` : "";
-		const valueDesc = key.startsWith(ARG_NEGATABLE_PREFIX) ? "" : await resolveDisplayValue(ctx, key);
+		const valueDesc = key.startsWith("no-") ? "" : await resolveDisplayValue(ctx, key);
 		const desc = `${optionsSchema ? optionsSchema.padEnd(optionSchemaMaxLength + 3) : ""}${rawDesc}`;
 		const descLength = desc.length + valueDesc.length;
 		const option = `${value.padEnd((descLength > 0 ? optionsMaxLength : 0) + ctx.env.middleMargin)}${desc}${valueDesc ? ` ${valueDesc}` : ""}`;
@@ -602,7 +582,6 @@ function generatePositionalSymbols(args) {
 		return elements.join(" ");
 	}).join(" ") : "";
 }
-
 //#endregion
 //#region src/validation.ts
 /**
@@ -617,7 +596,6 @@ function renderValidationErrors(_ctx, error) {
 	for (const err of error.errors) messages.push(err.message);
 	return Promise.resolve(messages.join("\n"));
 }
-
 //#endregion
 //#region src/index.ts
 /**
@@ -693,6 +671,5 @@ function renderer() {
 		}
 	});
 }
-
 //#endregion
-export { renderer as default, pluginId, renderHeader, renderUsage, renderValidationErrors };
+export { renderer as default, pluginId, renderHeader, renderUsage, renderValidationErrors };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@gunshi/plugin-renderer",
   "description": "usage renderer plugin for gunshi",
-  "version": "0.29.3",
+  "version": "0.29.4",
   "author": {
     "name": "kazuya kawaguchi",
     "email": "kawakazu80@gmail.com"
@@ -53,20 +53,20 @@
     }
   },
   "dependencies": {
-    "@gunshi/plugin": "0.29.3"
+    "@gunshi/plugin": "0.29.4"
   },
   "peerDependencies": {
-    "@gunshi/plugin-i18n": "0.29.3"
+    "@gunshi/plugin-i18n": "0.29.4"
   },
   "devDependencies": {
-    "deno": "^2.7.4",
-    "jsr": "^0.13.5",
+    "deno": "^2.7.11",
+    "jsr": "^0.14.3",
     "jsr-exports-lint": "^0.4.2",
     "publint": "^0.3.18",
     "tsdown": "0.15.12",
-    "typedoc": "^0.28.17",
-    "typedoc-plugin-markdown": "^4.10.0",
-    "@gunshi/shared": "0.29.3"
+    "typedoc": "^0.28.18",
+    "typedoc-plugin-markdown": "^4.11.0",
+    "@gunshi/shared": "0.29.4"
   },
   "scripts": {
     "build": "tsdown",