@guanghechen/commander 1.0.1

package/CHANGELOG.md

@@ -0,0 +1,17 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+
+## <small>1.0.1 (2024-09-28)</small>
+
+* :art:  improve: reuse @guanghechen/cli ([6c8e6a0](https://github.com/guanghechen/node-scaffolds/commit/6c8e6a0))
+* :wrench:  chore: fix publish issues ([7316526](https://github.com/guanghechen/node-scaffolds/commit/7316526))
+
+
+
+
+
+## <small>1.0.1 (2024-09-28)</small>
+
+* :art:  improve: reuse @guanghechen/cli ([6c8e6a0](https://github.com/guanghechen/node-scaffolds/commit/6c8e6a0))

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020-2023 guanghechen (https://github.com/guanghechen)
+
+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,83 @@
+<header>
+  <h1 align="center">
+    <a href="https://github.com/guanghechen/node-scaffolds/tree/@guanghechen/commander@1.0.1/packages/commander#readme">@guanghechen/commander</a>
+  </h1>
+  <div align="center">
+    <a href="https://www.npmjs.com/package/@guanghechen/commander">
+      <img
+        alt="Npm Version"
+        src="https://img.shields.io/npm/v/@guanghechen/commander.svg"
+      />
+    </a>
+    <a href="https://www.npmjs.com/package/@guanghechen/commander">
+      <img
+        alt="Npm Download"
+        src="https://img.shields.io/npm/dm/@guanghechen/commander.svg"
+      />
+    </a>
+    <a href="https://www.npmjs.com/package/@guanghechen/commander">
+      <img
+        alt="Npm License"
+        src="https://img.shields.io/npm/l/@guanghechen/commander.svg"
+      />
+    </a>
+    <a href="#install">
+      <img
+        alt="Module Formats: cjs"
+        src="https://img.shields.io/badge/module_formats-cjs-green.svg"
+      />
+    </a>
+    <a href="https://github.com/nodejs/node">
+      <img
+        alt="Node.js Version"
+        src="https://img.shields.io/node/v/@guanghechen/commander"
+      />
+    </a>
+    <a href="https://github.com/facebook/jest">
+      <img
+        alt="Eslint Version"
+        src="https://img.shields.io/npm/dependency-version/@guanghechen/commander/peer/jest"
+      />
+    </a>
+    <a href="https://github.com/facebook/jest">
+      <img
+        alt="Tested with Jest"
+        src="https://img.shields.io/badge/tested_with-jest-9c465e.svg"
+      />
+    </a>
+    <a href="https://github.com/prettier/prettier">
+      <img
+        alt="Code Style: prettier"
+        src="https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square"
+      />
+    </a>
+  </div>
+</header>
+<br/>
+
+
+Utility functions for creating command programs tools based on [commander.js][].
+
+## Install
+
+* npm
+
+  ```bash
+  npm install --save-dev @guanghechen/commander
+  ```
+
+* yarn
+
+  ```bash
+  yarn add --dev @guanghechen/commander
+  ```
+
+
+## Related
+
+* [commander.js][]
+
+
+[homepage]: https://github.com/guanghechen/node-scaffolds/tree/@guanghechen/commander@1.0.1/packages/commander#readme
+[commander.js]: https://github.com/tj/commander.js/
+

package/lib/cjs/index.cjs

@@ -0,0 +1,175 @@
+'use strict';
+
+var commander = require('commander');
+var exec = require('@guanghechen/exec');
+var select = require('@inquirer/select');
+var commandExists = require('command-exists');
+var cli = require('@guanghechen/cli');
+
+function _interopDefault (e) { return e && e.__esModule ? e : { default: e }; }
+
+var select__default = /*#__PURE__*/_interopDefault(select);
+var commandExists__default = /*#__PURE__*/_interopDefault(commandExists);
+
+class Command extends commander.Command {
+    _actionHandler;
+    _optionValues;
+    _storeOptionsAsProperties;
+    _version;
+    _versionOptionName;
+    constructor() {
+        super();
+        this._optionValues = {};
+        this._storeOptionsAsProperties = false;
+    }
+    action(fn) {
+        const listener = (args) => {
+            const expectedArgsCount = this.registeredArguments.length;
+            const actionArgs = [
+                args.slice(0, expectedArgsCount),
+                this.opts(),
+                args.slice(expectedArgsCount),
+                this,
+            ];
+            const actionResult = fn.apply(this, actionArgs);
+            return actionResult;
+        };
+        this._actionHandler = listener;
+        return this;
+    }
+    opts() {
+        const nodes = [this];
+        for (let parent = this.parent; parent != null; parent = parent.parent) {
+            nodes.push(parent);
+        }
+        const options = {};
+        for (let i = nodes.length - 1; i >= 0; --i) {
+            const o = nodes[i];
+            if (o._storeOptionsAsProperties) {
+                for (const option of o.options) {
+                    const key = option.attributeName();
+                    options[key] = key === o._versionOptionName ? o._version : o[key];
+                }
+            }
+            else {
+                const optionValues = o._optionValues;
+                for (const key of Object.getOwnPropertyNames(optionValues)) {
+                    options[key] = optionValues[key];
+                }
+            }
+        }
+        return options;
+    }
+}
+
+function createMainCommandMounter(create, handle) {
+    return (program, opts) => {
+        const command = create(handle);
+        if (command.name().length <= 0) {
+            command.name('__main__');
+        }
+        program.addCommand(command, { ...opts, isDefault: true });
+    };
+}
+function createMainCommandExecutor(create, handle) {
+    return (args) => {
+        return new Promise(resolve => {
+            const wrappedHandler = async (options) => {
+                await handle(options);
+                resolve();
+            };
+            const command = create(wrappedHandler);
+            command.parse(args);
+        });
+    };
+}
+
+class SubCommand {
+    mount(parentCommand, opts) {
+        const processor = this;
+        const command = this.command(processor);
+        parentCommand.addCommand(command, opts);
+    }
+    execute(parentCommand, rawArgs) {
+        return new Promise((resolve, reject) => {
+            const processor = {
+                process: async (args, options) => {
+                    try {
+                        await this.process(args, options);
+                        resolve();
+                    }
+                    catch (error) {
+                        reject(error);
+                    }
+                },
+            };
+            const command = this.command(processor);
+            parentCommand.addCommand(command);
+            parentCommand.parse(rawArgs);
+        });
+    }
+    async process(args, options) {
+        const processor = await this.resolveProcessor(args, options);
+        await processor.process(args, options);
+    }
+}
+
+function createTopCommand(commandName, version) {
+    const program = new Command();
+    program
+        .storeOptionsAsProperties(false)
+        .version(version)
+        .name(commandName)
+        .option('--log-encoding <encoding>', 'Encoding of log file.')
+        .option('--log-filepath <filepath>', 'Path which the log file is located.')
+        .option('--log-level <level>', 'Log level.')
+        .option('--log-name <name>', 'Logger name.')
+        .option('--log-mode <normal|loose>', 'Log format mode.')
+        .option('--log-flight <[[no-]<date|title|colorful|inline>]>', 'Enable / disable logger flights.', (val, acc) => acc.concat(val), [])
+        .option('-c, --config-path, --configPath <configPath>', 'config filepaths', (val, acc) => acc.concat(val), [])
+        .option('--parastic-config-path, --parasticConfigFilepath <parasticConfigFilepath>', 'parastic config filepath')
+        .option('--parastic-config-entry, --parasticConfigEntry <parasticConfigEntry>', 'parastic config filepath')
+        .option('--workspace <workspace>', 'The root dir to locate the config files and resolve relative paths');
+    return program;
+}
+
+const hasGitInstalled = () => commandExists__default.default.sync('git');
+async function installDependencies(params) {
+    const { cwd, plopBypass, reporter } = params;
+    const hasYarnInstalled = commandExists__default.default.sync('yarn');
+    if (!hasYarnInstalled) {
+        const hasNpmInstalled = commandExists__default.default.sync('npm');
+        if (!hasNpmInstalled)
+            return;
+    }
+    let npmScript;
+    if (plopBypass.length > 0) {
+        npmScript = plopBypass.shift();
+    }
+    else {
+        npmScript = await select__default.default({
+            message: 'npm or yarn?',
+            choices: ['npm', 'yarn', 'skip'],
+            default: hasYarnInstalled ? 'yarn' : 'npm',
+        });
+    }
+    reporter?.debug?.('npmScript:', npmScript);
+    if (npmScript === 'skip')
+        return;
+    await exec.safeExec({ from: 'installDependencies', cmd: npmScript, args: ['install'], cwd, reporter });
+}
+
+exports.Command = Command;
+exports.SubCommand = SubCommand;
+exports.createMainCommandExecutor = createMainCommandExecutor;
+exports.createMainCommandMounter = createMainCommandMounter;
+exports.createTopCommand = createTopCommand;
+exports.hasGitInstalled = hasGitInstalled;
+exports.installDependencies = installDependencies;
+Object.keys(cli).forEach(function (k) {
+    if (k !== 'default' && !Object.prototype.hasOwnProperty.call(exports, k)) Object.defineProperty(exports, k, {
+        enumerable: true,
+        get: function () { return cli[k]; }
+    });
+});
+//# sourceMappingURL=index.cjs.map

package/lib/esm/index.mjs

@@ -0,0 +1,156 @@
+import { Command as Command$1 } from 'commander';
+import { safeExec } from '@guanghechen/exec';
+import select from '@inquirer/select';
+import commandExists from 'command-exists';
+export * from '@guanghechen/cli';
+
+class Command extends Command$1 {
+    _actionHandler;
+    _optionValues;
+    _storeOptionsAsProperties;
+    _version;
+    _versionOptionName;
+    constructor() {
+        super();
+        this._optionValues = {};
+        this._storeOptionsAsProperties = false;
+    }
+    action(fn) {
+        const listener = (args) => {
+            const expectedArgsCount = this.registeredArguments.length;
+            const actionArgs = [
+                args.slice(0, expectedArgsCount),
+                this.opts(),
+                args.slice(expectedArgsCount),
+                this,
+            ];
+            const actionResult = fn.apply(this, actionArgs);
+            return actionResult;
+        };
+        this._actionHandler = listener;
+        return this;
+    }
+    opts() {
+        const nodes = [this];
+        for (let parent = this.parent; parent != null; parent = parent.parent) {
+            nodes.push(parent);
+        }
+        const options = {};
+        for (let i = nodes.length - 1; i >= 0; --i) {
+            const o = nodes[i];
+            if (o._storeOptionsAsProperties) {
+                for (const option of o.options) {
+                    const key = option.attributeName();
+                    options[key] = key === o._versionOptionName ? o._version : o[key];
+                }
+            }
+            else {
+                const optionValues = o._optionValues;
+                for (const key of Object.getOwnPropertyNames(optionValues)) {
+                    options[key] = optionValues[key];
+                }
+            }
+        }
+        return options;
+    }
+}
+
+function createMainCommandMounter(create, handle) {
+    return (program, opts) => {
+        const command = create(handle);
+        if (command.name().length <= 0) {
+            command.name('__main__');
+        }
+        program.addCommand(command, { ...opts, isDefault: true });
+    };
+}
+function createMainCommandExecutor(create, handle) {
+    return (args) => {
+        return new Promise(resolve => {
+            const wrappedHandler = async (options) => {
+                await handle(options);
+                resolve();
+            };
+            const command = create(wrappedHandler);
+            command.parse(args);
+        });
+    };
+}
+
+class SubCommand {
+    mount(parentCommand, opts) {
+        const processor = this;
+        const command = this.command(processor);
+        parentCommand.addCommand(command, opts);
+    }
+    execute(parentCommand, rawArgs) {
+        return new Promise((resolve, reject) => {
+            const processor = {
+                process: async (args, options) => {
+                    try {
+                        await this.process(args, options);
+                        resolve();
+                    }
+                    catch (error) {
+                        reject(error);
+                    }
+                },
+            };
+            const command = this.command(processor);
+            parentCommand.addCommand(command);
+            parentCommand.parse(rawArgs);
+        });
+    }
+    async process(args, options) {
+        const processor = await this.resolveProcessor(args, options);
+        await processor.process(args, options);
+    }
+}
+
+function createTopCommand(commandName, version) {
+    const program = new Command();
+    program
+        .storeOptionsAsProperties(false)
+        .version(version)
+        .name(commandName)
+        .option('--log-encoding <encoding>', 'Encoding of log file.')
+        .option('--log-filepath <filepath>', 'Path which the log file is located.')
+        .option('--log-level <level>', 'Log level.')
+        .option('--log-name <name>', 'Logger name.')
+        .option('--log-mode <normal|loose>', 'Log format mode.')
+        .option('--log-flight <[[no-]<date|title|colorful|inline>]>', 'Enable / disable logger flights.', (val, acc) => acc.concat(val), [])
+        .option('-c, --config-path, --configPath <configPath>', 'config filepaths', (val, acc) => acc.concat(val), [])
+        .option('--parastic-config-path, --parasticConfigFilepath <parasticConfigFilepath>', 'parastic config filepath')
+        .option('--parastic-config-entry, --parasticConfigEntry <parasticConfigEntry>', 'parastic config filepath')
+        .option('--workspace <workspace>', 'The root dir to locate the config files and resolve relative paths');
+    return program;
+}
+
+const hasGitInstalled = () => commandExists.sync('git');
+async function installDependencies(params) {
+    const { cwd, plopBypass, reporter } = params;
+    const hasYarnInstalled = commandExists.sync('yarn');
+    if (!hasYarnInstalled) {
+        const hasNpmInstalled = commandExists.sync('npm');
+        if (!hasNpmInstalled)
+            return;
+    }
+    let npmScript;
+    if (plopBypass.length > 0) {
+        npmScript = plopBypass.shift();
+    }
+    else {
+        npmScript = await select({
+            message: 'npm or yarn?',
+            choices: ['npm', 'yarn', 'skip'],
+            default: hasYarnInstalled ? 'yarn' : 'npm',
+        });
+    }
+    reporter?.debug?.('npmScript:', npmScript);
+    if (npmScript === 'skip')
+        return;
+    await safeExec({ from: 'installDependencies', cmd: npmScript, args: ['install'], cwd, reporter });
+}
+
+export { Command, SubCommand, createMainCommandExecutor, createMainCommandMounter, createTopCommand, hasGitInstalled, installDependencies };
+//# sourceMappingURL=index.mjs.map

package/lib/types/index.d.ts

@@ -0,0 +1,137 @@
+import { ICommandConfigurationOptions } from '@guanghechen/cli';
+export * from '@guanghechen/cli';
+import { Command as Command$1, OptionValues, CommandOptions } from 'commander';
+import { IReporter } from '@guanghechen/reporter.types';
+
+/**
+ * Callback for handling the command
+ *
+ * @param args    command arguments
+ * @param options command options
+ * @param extra   extra args (neither declared command arguments nor command options)
+ * @param self    current command
+ */
+type ICommandActionCallback<T extends ICommandConfigurationOptions> = (args: string[], options: T, extra: string[], self: Command) => void | Promise<void> | never;
+declare class Command extends Command$1 {
+    protected _actionHandler: ((args: string[]) => void) | null | undefined;
+    protected _optionValues: object;
+    protected _storeOptionsAsProperties: boolean;
+    protected _version: string | undefined;
+    protected _versionOptionName: string | undefined;
+    constructor();
+    /**
+     * Register callback `fn` for the command.
+     *
+     * @example
+     * program
+     *   .command('serve')
+     *   .description('start service')
+     *   .action(function() {
+     *      // do work here
+     *   });
+     *
+     * @param {Function} fn
+     * @return {Command} `this` command for chaining
+     */
+    action<T extends ICommandConfigurationOptions>(fn: ICommandActionCallback<T>): this;
+    opts<T extends OptionValues>(): T;
+}
+
+type IMainCommandProcessor<O extends ICommandConfigurationOptions> = (options: O) => void | Promise<void>;
+type IMainCommandCreator<O extends ICommandConfigurationOptions> = (handle?: IMainCommandProcessor<O>) => Command;
+type IMainCommandMounter = (parentCommand: Command, opts?: CommandOptions) => void;
+type IMainCommandExecutor<V = void> = (args: string[]) => Promise<V>;
+/**
+ * Create main command mounter
+ *
+ * @param create  main command creator
+ * @param handle  main command processor
+ */
+declare function createMainCommandMounter<O extends ICommandConfigurationOptions>(create: IMainCommandCreator<O>, handle: IMainCommandProcessor<O>): IMainCommandMounter;
+/**
+ * Create main command executor
+ *
+ * @param create  main command creator
+ * @param handle  main command processor
+ */
+declare function createMainCommandExecutor<O extends ICommandConfigurationOptions>(create: IMainCommandCreator<O>, handle: IMainCommandProcessor<O>): IMainCommandExecutor;
+
+interface ISubCommandOptions extends ICommandConfigurationOptions {
+}
+interface ISubCommandProcessor<O extends ISubCommandOptions> {
+    /**
+     * Process the command arguments and options.
+     * @param args      Command arguments.
+     * @param options   Command options.
+     */
+    process(args: string[], options: O): Promise<void>;
+}
+interface ISubCommand<O extends ISubCommandOptions> extends ISubCommandProcessor<O> {
+    /**
+     * Sub command name.
+     */
+    readonly subCommandName: string;
+    /**
+     * Sub command alias.
+     */
+    readonly aliases: string[];
+    /**
+     * Create an commander instance.
+     * @param processor
+     */
+    command(processor: ISubCommandProcessor<O>): Command;
+    /**
+     * Create a sub-command instance and execute it immediately.
+     * @param args      Command arguments.
+     * @param options   Command options.
+     */
+    execute(parentCommand: Command, rawArgs: string[]): Promise<void>;
+    /**
+     * Create a sub-command instance and mount it to the parentCommand.
+     * @param parentCommand
+     * @param opts
+     */
+    mount(parentCommand: Command, opts: CommandOptions | undefined): void;
+    /**
+     * Process the command options and rawArgs.
+     * @param args      Command arguments.
+     * @param options   Command options.
+     */
+    process(args: string[], options: O): Promise<void>;
+    /**
+     * Resolve a processor for process the command.
+     * @param args
+     * @param options
+     */
+    resolveProcessor(args: string[], options: O): Promise<ISubCommandProcessor<O>>;
+}
+declare abstract class SubCommand<O extends ISubCommandOptions> implements ISubCommand<O> {
+    abstract subCommandName: string;
+    abstract aliases: string[];
+    abstract command(processor: ISubCommandProcessor<O>): Command;
+    mount(parentCommand: Command, opts: CommandOptions | undefined): void;
+    execute(parentCommand: Command, rawArgs: string[]): Promise<void>;
+    process(args: string[], options: O): Promise<void>;
+    abstract resolveProcessor(args: string[], options: O): Promise<ISubCommandProcessor<O>>;
+}
+
+/**
+ * Create top command
+ * @param commandName
+ * @param version
+ */
+declare function createTopCommand(commandName: string, version: string): Command;
+
+declare const hasGitInstalled: () => boolean;
+interface IInstallDependenciesParams {
+    readonly cwd: string;
+    readonly plopBypass: string[];
+    readonly reporter?: IReporter;
+}
+/**
+ * Run `npm/yarn install` to Install node.js dependencies
+ */
+declare function installDependencies(params: IInstallDependenciesParams): Promise<void>;
+
+export { Command, type ICommandActionCallback, type IInstallDependenciesParams, type IMainCommandCreator, type IMainCommandExecutor, type IMainCommandMounter, type IMainCommandProcessor, type ISubCommand, type ISubCommandOptions, type ISubCommandProcessor, SubCommand, createMainCommandExecutor, createMainCommandMounter, createTopCommand, hasGitInstalled, installDependencies };
+//# sourceMappingURL=index.d.ts.map

package/package.json

@@ -0,0 +1,55 @@
+{
+  "name": "@guanghechen/commander",
+  "version": "1.0.1",
+  "description": "A wrapper of commander.js with some utilities",
+  "author": {
+    "name": "guanghechen",
+    "url": "https://github.com/guanghechen/"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/guanghechen/node-scaffolds/tree/@guanghechen/commander@1.0.0",
+    "directory": "packages/commander"
+  },
+  "homepage": "https://github.com/guanghechen/node-scaffolds/tree/@guanghechen/commander@1.0.0/packages/commander#readme",
+  "keywords": [
+    "commander"
+  ],
+  "type": "module",
+  "exports": {
+    ".": {
+      "source": "./src/index.ts",
+      "import": "./lib/esm/index.mjs",
+      "require": "./lib/cjs/index.cjs",
+      "types": "./lib/types/index.d.ts"
+    }
+  },
+  "source": "./src/index.ts",
+  "main": "./lib/cjs/index.cjs",
+  "module": "./lib/esm/index.mjs",
+  "types": "./lib/types/index.d.ts",
+  "license": "MIT",
+  "engines": {
+    "node": ">= 18.0.0"
+  },
+  "files": [
+    "lib/",
+    "!lib/**/*.map",
+    "package.json",
+    "CHANGELOG.md",
+    "LICENSE",
+    "README.md"
+  ],
+  "dependencies": {
+    "@guanghechen/cli": "^1.0.1",
+    "@guanghechen/exec": "^1.0.6",
+    "@guanghechen/reporter.types": "^1.0.4",
+    "@inquirer/select": "^3.0.1",
+    "command-exists": "^1.2.9",
+    "commander": "^12.1.0"
+  },
+  "devDependencies": {
+    "@types/js-yaml": "^4.0.9"
+  },
+  "gitHead": "0b05e2e41ca5e5bebf4cd88c9eef1d80b36460a1"
+}