@doracli/commander 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020-2029 zhangzhiguo
+
+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,7 @@
+# `cli`
+
+> @doracli/cli
+构建功能集合
+
+## Usage
+

package/lib/cjs/index.js

@@ -0,0 +1 @@
+"use strict";var n=require("commander"),o=function(o){return new n.Command(o)},e=function(n){return function(e){var t=n.command,r=n.description,a=n.action,i=n.help,c=n.options,m=o(t);m.description(r),(c||[]).forEach(function(n){var o=n.name,e=n.simpleName,t=n.description,r=n.type,a=n.defaultValue;m.option("-".concat(e," --").concat(o," ").concat(r),t,a)}),m.action(a),i&&i.onHelp&&m.on("--help",i.onHelp),e.addCommand(m)}};exports.createChildCommand=o,exports.createProgram=function(){return n.program},exports.dealChildOption=e,exports.dealOptions=function(n){return function(o){var t=n.name,r=n.usage,a=n.version,i=n.childCommands;o.name(t),r&&o.usage(r),a&&o.version(a),(i||[]).forEach(function(n){e(n)(o)})}};

package/lib/esm/index.js

@@ -0,0 +1 @@
+import{Command as n,program as o}from"commander";var e=function(o){return new n(o)},t=function(){return o},a=function(n){return function(o){var e=n.name,t=n.usage,a=n.version,i=n.childCommands;o.name(e),t&&o.usage(t),a&&o.version(a),(i||[]).forEach(function(n){c(n)(o)})}},c=function(n){return function(o){var t=n.command,a=n.description,c=n.action,i=n.help,r=n.options,u=e(t);u.description(a),(r||[]).forEach(function(n){var o=n.name,e=n.simpleName,t=n.description,a=n.type,c=n.defaultValue;u.option("-".concat(e," --").concat(o," ").concat(a),t,c)}),u.action(c),i&&i.onHelp&&u.on("--help",i.onHelp),o.addCommand(u)}};export{e as createChildCommand,t as createProgram,c as dealChildOption,a as dealOptions};

package/lib/type/index.d.ts

@@ -0,0 +1,67 @@
+import * as commander from 'commander';
+import { Command } from 'commander';
+import { TPlainFunction } from '@cclr/lang';
+
+declare const createChildCommand: (childComman: string) => Command;
+
+/** 获取命令行程序 */
+declare const createProgram: () => commander.Command;
+
+type TCommandOptionList = TCommandOption[];
+type TCommandOption = {
+    name: string;
+    usage?: string;
+    version?: string;
+    childCommands?: TChildCommandOption[];
+};
+/**
+ * 实际会执行的命令
+ * @description 带详细配置参数
+ */
+type TChildCommandOption = {
+    command: string;
+    description: string;
+    options?: {
+        /**
+         * 主要命令
+         * @description 会自动拼接成 --version
+         * @example version
+         */
+        name: string;
+        /**
+         * 简写命令
+         * @description 会自动拼接成 -V
+         * @example V
+         */
+        simpleName: string;
+        /**
+         * 参数类型
+         * @example undefined -> boolean
+         * @example <number> -> 用户输入的值
+         * @example [file] -> 可选参数
+         */
+        type?: string;
+        description?: string;
+        defaultValue?: string | boolean | number;
+    }[];
+    action: TPlainFunction;
+    help?: {
+        onHelp?: () => void;
+    };
+};
+
+/**
+ * 处理命令配置
+ * @param options 命令配置
+ * @returns
+ */
+declare const dealOptions: (options: TCommandOption) => (c: Command) => void;
+/**
+ * 处理子命令配置
+ * @param option 子命令配置
+ * @returns
+ */
+declare const dealChildOption: (option: TChildCommandOption) => (c: Command) => void;
+
+export { createChildCommand, createProgram, dealChildOption, dealOptions };
+export type { TChildCommandOption, TCommandOption, TCommandOptionList };

package/package.json

@@ -0,0 +1,37 @@
+{
+  "name": "@doracli/commander",
+  "version": "0.0.1",
+  "description": "command line parser",
+  "author": "cclr <18843152354@163.com>",
+  "homepage": "",
+  "license": "MIT",
+  "type": "module",
+  "exports": {
+    "import": "./lib/esm/index.js",
+    "require": "./lib/cjs/index.js"
+  },
+  "types": "lib/type/index.d.ts",
+  "directories": {
+    "lib": "lib"
+  },
+  "files": [
+    "lib",
+    "README.md"
+  ],
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "scripts": {
+    "test": "vitest",
+    "g:test": "vitest run",
+    "build": "drn build"
+  },
+  "dependencies": {
+    "@cclr/lang": "^0.1.28",
+    "@cclr/utils": "^0.1.28",
+    "@doracli/type": "^0.0.1",
+    "commander": "^14.0.1"
+  },
+  "gitHead": "40ab496f25042487a671979074515f3345c96453"
+}