@gunshi/plugin 0.27.0-alpha.8 → 0.27.0-beta.0

package/lib/index.js

@@ -1,5 +1,8 @@
 //#region ../gunshi/src/constants.ts
 const ANONYMOUS_COMMAND_NAME = "(anonymous)";
+/**
+* A no-operation function.
+*/
 const NOOP = () => {};
 const CLI_OPTIONS_DEFAULT = {
 	name: void 0,
@@ -15,20 +18,45 @@ const CLI_OPTIONS_DEFAULT = {
 	renderHeader: void 0,
 	renderUsage: void 0,
 	renderValidationErrors: void 0,
-	plugins: void 0
+	plugins: void 0,
+	fallbackToEntry: false
 };
 
 //#endregion
 //#region ../gunshi/src/utils.ts
+/**
+* Check if the given command is a {@link LazyCommand}.
+*
+* @param cmd - A command to check
+* @returns `true` if the command is a {@link LazyCommand}, otherwise `false
+*/
 function isLazyCommand(cmd) {
 	return typeof cmd === "function" && "commandName" in cmd && !!cmd.commandName;
 }
+/**
+* Create an object with the specified prototype. A shorthand for `Object.create`.
+*
+* @param obj - An object to use as the prototype for the new object. If `null`, it will create an object with no prototype.
+* @returns A new object with the specified prototype
+*/
 function create(obj = null) {
 	return Object.create(obj);
 }
+/**
+* Log a message to the console.
+*
+* @param args - Arguments to log
+*/
 function log(...args) {
 	console.log(...args);
 }
+/**
+* Deep freeze an object, making it immutable.
+*
+* @param obj - The object to freeze
+* @param ignores - Properties to ignore during freezing
+* @returns A frozen object
+*/
 function deepFreeze(obj, ignores = []) {
 	if (obj === null || typeof obj !== "object") return obj;
 	for (const key of Object.keys(obj)) {
@@ -42,11 +70,12 @@ function deepFreeze(obj, ignores = []) {
 //#endregion
 //#region ../gunshi/src/context.ts
 /**
-* Create a {@link CommandContext | command context}
-* @param param A {@link CommandContextParams | parameters} to create a {@link CommandContext | command context}
-* @returns A {@link CommandContext | command context}, which is readonly
+* Create a command context.
+*
+* @param param - A {@link CommandContextParams | parameters} to create a command context.
+* @returns A {@link CommandContext | command context}, which is readonly.
 */
-async function createCommandContext({ args, explicit, values, positionals, rest, argv, tokens, command, extensions = {}, cliOptions, callMode = "entry", omitted = false, validationError }) {
+async function createCommandContext({ args = {}, explicit = {}, values = {}, positionals = [], rest = [], argv = [], tokens = [], command = {}, extensions = {}, cliOptions = {}, callMode = "entry", omitted = false, validationError = void 0 }) {
 	/**
 	* normailize the options schema and values, to avoid prototype pollution
 	*/
@@ -59,6 +88,15 @@ async function createCommandContext({ args, explicit, values, positionals, rest,
 	*/
 	const env = Object.assign(create(), CLI_OPTIONS_DEFAULT, cliOptions);
 	/**
+	* apply Command definition's rendering option with highest priority
+	*/
+	if (command.rendering) {
+		const { header, usage, validationErrors } = command.rendering;
+		if (header !== void 0) env.renderHeader = header;
+		if (usage !== void 0) env.renderUsage = usage;
+		if (validationErrors !== void 0) env.renderValidationErrors = validationErrors;
+	}
+	/**
 	* create the command context
 	*/
 	const core = Object.assign(create(), {
@@ -94,8 +132,7 @@ async function createCommandContext({ args, explicit, values, positionals, rest,
 			if (extension.onFactory) await extension.onFactory(core, command);
 		}
 	}
-	const ctx = deepFreeze(core, ["extensions"]);
-	return ctx;
+	return deepFreeze(core, ["extensions"]);
 }
 function getCommandName(cmd) {
 	if (isLazyCommand(cmd)) return cmd.commandName || cmd.name || ANONYMOUS_COMMAND_NAME;
@@ -105,35 +142,40 @@ function getCommandName(cmd) {
 
 //#endregion
 //#region ../gunshi/src/plugin/core.ts
+const NOOP_EXTENSION = () => {
+	return Object.create(null);
+};
 /**
 * Define a plugin
-* @param options - {@link PluginOptions | plugin options}
-* @returns A defined plugin.
+*
+* @param options - {@linkcode PluginOptions | plugin options}
+* @returns A defined plugin
+*
 * @since v0.27.0
 */
-function plugin(options) {
-	const { id, name, setup, extension, onExtension, dependencies } = options;
+function plugin(options = {}) {
+	const { id, name, setup, onExtension, dependencies } = options;
+	const extension = options.extension || NOOP_EXTENSION;
 	const pluginFn = async (ctx) => {
 		if (setup) await setup(ctx);
 	};
+	const props = {
+		writable: false,
+		enumerable: true,
+		configurable: true
+	};
 	return Object.defineProperties(pluginFn, {
 		id: {
 			value: id,
-			writable: false,
-			enumerable: true,
-			configurable: true
+			...props
 		},
 		...name && { name: {
 			value: name,
-			writable: false,
-			enumerable: true,
-			configurable: true
+			...props
 		} },
 		...dependencies && { dependencies: {
 			value: dependencies,
-			writable: false,
-			enumerable: true,
-			configurable: true
+			...props
 		} },
 		...extension && { extension: {
 			value: {
@@ -141,12 +183,10 @@ function plugin(options) {
 				factory: extension,
 				onFactory: onExtension
 			},
-			writable: false,
-			enumerable: true,
-			configurable: true
+			...props
 		} }
 	});
 }
 
 //#endregion
-export { CLI_OPTIONS_DEFAULT, createCommandContext, plugin };
+export { ANONYMOUS_COMMAND_NAME, CLI_OPTIONS_DEFAULT, createCommandContext, plugin };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@gunshi/plugin",
-  "description": "utilities for gunshi plugin",
-  "version": "0.27.0-alpha.8",
+  "description": "plugin development kit for gunshi",
+  "version": "0.27.0-beta.0",
   "author": {
     "name": "kazuya kawaguchi",
     "email": "kawakazu80@gmail.com"
@@ -51,12 +51,12 @@
     }
   },
   "devDependencies": {
-    "deno": "^2.4.0",
+    "deno": "^2.5.4",
     "jsr": "^0.13.5",
     "jsr-exports-lint": "^0.4.1",
-    "publint": "^0.3.12",
-    "tsdown": "^0.12.9",
-    "gunshi": "0.27.0-alpha.8"
+    "publint": "^0.3.14",
+    "tsdown": "^0.15.6",
+    "gunshi": "0.27.0-beta.0"
   },
   "scripts": {
     "build": "tsdown",