erii 2.0.6 → 3.0.0-beta.1

package/dist/index.d.mts

@@ -0,0 +1,117 @@
+import validator from "validator";
+//#region src/types.d.ts
+type ArgumentValue = string | number | boolean | ArgumentValue[] | {
+  [key: string]: ArgumentValue;
+};
+type CommandOptions = Record<string, ArgumentValue | undefined>;
+interface ParsedArguments extends CommandOptions {
+  _: Array<string | number>;
+}
+type CommandHandler = (ctx: CommandCtx, options: CommandOptions) => unknown;
+type LifecycleHandler = () => unknown;
+type ArgumentValidator = (value: ArgumentValue | undefined, logger: (message: string) => void) => boolean;
+type ValidatorName = { [K in keyof typeof validator]: typeof validator[K] extends ((value: string) => boolean) ? K : never; }[keyof typeof validator];
+interface MetaInfo {
+  version?: string;
+  name?: string;
+}
+interface Command {
+  name: string | string[];
+  description?: string;
+  argument?: Argument;
+  alias?: string[];
+  redirect?: string;
+  options?: Option[];
+  handler?: CommandHandler;
+}
+interface Option {
+  name: string | string[];
+  description?: string;
+  command?: string;
+  argument?: Argument;
+}
+interface CommandMap {
+  [key: string]: Command | undefined;
+}
+interface CommandCtx {
+  showVersion: () => void;
+  showHelp: () => void;
+  getArgument: (commandName?: string) => ArgumentValue | undefined;
+}
+interface Argument {
+  name: string;
+  description: string;
+  validate?: ValidatorName | ArgumentValidator;
+}
+//#endregion
+//#region src/erii.d.ts
+export declare class Erii {
+  rawArguments: string[];
+  parsedArguments: ParsedArguments;
+  private version;
+  private name;
+  commands: CommandMap;
+  commonOptions: Option[];
+  validator: typeof validator;
+  alwaysHandler?: LifecycleHandler;
+  defaultHandler?: LifecycleHandler;
+  constructor();
+  /**
+   * 绑定命令处理函数
+   * @param config
+   * @param handler
+   */
+  bind(config: Command, handler: CommandHandler): void;
+  /**
+   * 总是执行
+   * @param handler
+   */
+  always(handler: LifecycleHandler): void;
+  default(handler: LifecycleHandler): void;
+  /**
+   * 增加设置项
+   * @param config
+   */
+  addOption(config: Option): void;
+  private commandCtx;
+  /**
+   * 设定基础信息
+   * @param metaInfo
+   */
+  setMetaInfo({ version, name }?: MetaInfo): void;
+  /**
+   * 显示帮助信息
+   */
+  showHelp(command?: string): void;
+  /**
+   * 显示版本号
+   */
+  showVersion(): void;
+  /**
+   * 启动
+   */
+  start(): void;
+  /**
+   * 执行命令担当函数
+   * @param command
+   */
+  private exec;
+  validateArgument(argumentValue: ArgumentValue | undefined, argument?: Argument): boolean;
+  /**
+   * 获得命令的参数
+   * @param commandName
+   * @param followRedirect 是否遵循重定向
+   */
+  getArgument(commandName: string, followRedirect?: boolean): ArgumentValue | undefined;
+  private findArgument;
+  /**
+   * 启动
+   * エリイ 起きてます❤
+   */
+  okite(): void;
+}
+//#endregion
+//#region src/index.d.ts
+declare const _default: Erii;
+//#endregion
+export { type Argument, type ArgumentValidator, type ArgumentValue, type Command, type CommandCtx, type CommandHandler, type CommandMap, type CommandOptions, type LifecycleHandler, type MetaInfo, type Option, type ParsedArguments, type ValidatorName, _default as default };

package/dist/index.mjs

@@ -0,0 +1,239 @@
+import yargs from "yargs-parser";
+import chalk from "chalk";
+import validator from "validator";
+import CLI from "clui";
+import clc from "cli-color";
+//#region src/help.ts
+/** Render the help body; the caller prints the version first. */
+function renderHelp(commands, commonOptions) {
+	console.log("\nHelp:");
+	const Line = CLI.Line;
+	new Line().padding(5).column("Commands", 30, [clc.cyan]).column("Description", 30, [clc.cyan]).column("Alias", 20, [clc.cyan]).output();
+	new Line().output();
+	for (const [key, command] of Object.entries(commands)) {
+		if (!command || command.redirect) continue;
+		const commandText = "--" + key + (command.argument ? ` <${command.argument.name}>` : "");
+		const aliasText = (command.alias ?? []).map((alias) => alias.length === 1 ? `-${alias}` : `--${alias}`).join(" / ");
+		new Line().padding(5).column(commandText, 30).column(command.description ?? "", 30).column(aliasText, 20).output();
+		if (command.argument) new Line().padding(9).column(`<${command.argument.name}>`, 26).column(command.argument.description, 30).output();
+		for (const option of command.options ?? []) renderOption(option, 9, 26);
+	}
+	new Line().output();
+	if (commonOptions.length > 0) {
+		console.log("Options:\n");
+		new Line().padding(5).column("Options", 30, [clc.cyan]).column("Description", 30, [clc.cyan]).output();
+		for (const option of commonOptions) renderOption(option, 5, 30);
+	}
+}
+/** Scoped and common options share formatting, with different indentation. */
+function renderOption(option, padding, width) {
+	const text = `--${(Array.isArray(option.name) ? option.name : [option.name]).join(", ")}` + (option.argument ? ` <${option.argument.name}>` : "");
+	new CLI.Line().padding(padding).column(text, width).column(option.description || "", 30).output();
+	if (option.argument) new CLI.Line().padding(padding + 4).column(`<${option.argument.name}>`, width - 4).column(option.argument.description || "", 30).output();
+}
+//#endregion
+//#region src/utils/convert.ts
+function toKebabCase(str) {
+	return (str[0]?.toLowerCase() ?? "") + str.slice(1).replace(/[A-Z]/g, (letter) => `-${letter.toLowerCase()}`);
+}
+function createCamelProxifiedObject(before) {
+	return new Proxy(before, {
+		get(target, key, receiver) {
+			const value = Reflect.get(target, key, receiver);
+			return typeof key === "string" ? value ?? Reflect.get(target, toKebabCase(key), receiver) : value;
+		},
+		set(target, key, value, receiver) {
+			if (typeof key === "string" && !key.includes("-") && Reflect.get(target, key, receiver) == null && Reflect.get(target, toKebabCase(key), receiver) != null) return Reflect.set(target, toKebabCase(key), value, receiver);
+			return Reflect.set(target, key, value, receiver);
+		}
+	});
+}
+//#endregion
+//#region src/erii.ts
+var Erii = class {
+	rawArguments;
+	parsedArguments;
+	version = "1.0.0";
+	name = "Erii";
+	commands = {};
+	commonOptions = [];
+	validator;
+	alwaysHandler;
+	defaultHandler;
+	constructor() {
+		this.rawArguments = process.argv.slice(2);
+		this.parsedArguments = yargs(process.argv.slice(2), { configuration: { "boolean-negation": false } });
+		this.validator = validator;
+		for (const key of Object.keys(this.parsedArguments)) if (key !== "_" && !this.rawArguments.includes("--" + key) && !this.rawArguments.includes("-" + key)) delete this.parsedArguments[key];
+	}
+	/**
+	* 绑定命令处理函数
+	* @param config
+	* @param handler
+	*/
+	bind(config, handler) {
+		if (config.name === void 0) return console.error(chalk.red("Invalid command binding, ignored."));
+		const { name, description, argument } = config;
+		const [mainCommand, ...aliases] = Array.isArray(name) ? name : [name];
+		if (!mainCommand) {
+			console.error(chalk.red("Invalid command binding, ignored."));
+			return;
+		}
+		this.commands[mainCommand] = {
+			name: mainCommand,
+			description,
+			argument,
+			alias: aliases,
+			options: [],
+			handler
+		};
+		if (Array.isArray(name)) for (const alias of aliases) this.commands[alias] = {
+			name: alias,
+			redirect: mainCommand
+		};
+	}
+	/**
+	* 总是执行
+	* @param handler
+	*/
+	always(handler) {
+		this.alwaysHandler = handler;
+	}
+	default(handler) {
+		this.defaultHandler = handler;
+	}
+	/**
+	* 增加设置项
+	* @param config
+	*/
+	addOption(config) {
+		config.name = Array.isArray(config.name) ? config.name : [config.name];
+		if (!config.command) this.commonOptions.push(config);
+		else {
+			if (!(config.command in this.commands)) return console.error(chalk.red(`Command for option [${config.name.join(", ")}] not found, ignored.`));
+			const command = this.commands[config.command];
+			const target = command?.redirect ? this.commands[command.redirect] : command;
+			if (target) (target.options ??= []).push(config);
+		}
+	}
+	commandCtx(command) {
+		return {
+			showVersion: () => {
+				this.showVersion();
+			},
+			showHelp: () => {
+				this.showHelp();
+			},
+			getArgument: (commandName = command) => {
+				return this.getArgument(commandName);
+			}
+		};
+	}
+	/**
+	* 设定基础信息
+	* @param metaInfo
+	*/
+	setMetaInfo({ version = "", name = "" } = {}) {
+		this.version = version;
+		this.name = name;
+	}
+	/**
+	* 显示帮助信息
+	*/
+	showHelp(command) {
+		this.showVersion();
+		renderHelp(this.commands, this.commonOptions);
+	}
+	/**
+	* 显示版本号
+	*/
+	showVersion() {
+		console.log(`${this.name} / ${this.version}`);
+	}
+	/**
+	* 启动
+	*/
+	start() {
+		if (this.alwaysHandler) this.alwaysHandler();
+		if (this.defaultHandler) {
+			if (this.parsedArguments["_"].length === 0 && Object.keys(this.parsedArguments).length === 1) this.defaultHandler();
+		}
+		for (const key of Object.keys(this.parsedArguments)) if (key in this.commands) this.exec(key);
+		for (const key of this.parsedArguments["_"]) if (key in this.commands) this.exec(String(key));
+	}
+	/**
+	* 执行命令担当函数
+	* @param command
+	*/
+	exec(command) {
+		const boundCommand = this.commands[command];
+		if (!boundCommand) return;
+		if (boundCommand.redirect) {
+			this.exec(boundCommand.redirect);
+			return;
+		}
+		const options = {};
+		for (const option of [...boundCommand.options ?? [], ...this.commonOptions]) {
+			const names = Array.isArray(option.name) ? option.name : [option.name];
+			const primaryName = names[0];
+			if (!primaryName) continue;
+			for (const name of names) {
+				if (!(name in this.parsedArguments)) continue;
+				if (this.validateArgument(this.parsedArguments[name], option.argument)) options[primaryName] = this.parsedArguments[name];
+				else {
+					console.error(chalk.red(`Argument validation failed for option '${name}'.`));
+					if (typeof option.argument?.validate === "string") console.error(chalk.red(`<${option.argument.name}> should be a/an ${option.argument.validate.slice(2)}.`));
+				}
+			}
+		}
+		const argumentValue = this.findArgument(command);
+		if (this.validateArgument(argumentValue, boundCommand.argument)) boundCommand.handler?.(this.commandCtx(command), createCamelProxifiedObject(options));
+		else {
+			console.error(chalk.red(`Argument validation failed for command ${command}`));
+			if (typeof boundCommand.argument?.validate === "string") console.error(chalk.red(`<${boundCommand.argument.name}> should be a/an ${boundCommand.argument.validate.slice(2)}.`));
+		}
+	}
+	validateArgument(argumentValue, argument) {
+		if (!argument || !argument.validate) return true;
+		if (typeof argument.validate === "string") {
+			if (argument.validate in this.validator) {
+				if (argumentValue === void 0) return false;
+				return this.validator[argument.validate](String(argumentValue));
+			} else {
+				console.error(chalk.red(`Unknown validate method for ${argument.name}.`));
+				return true;
+			}
+		} else return argument.validate(argumentValue, (message) => {
+			console.log(chalk.red(message));
+		});
+	}
+	/**
+	* 获得命令的参数
+	* @param commandName
+	* @param followRedirect 是否遵循重定向
+	*/
+	getArgument(commandName, followRedirect = true) {
+		const value = this.findArgument(commandName, followRedirect);
+		if (value === void 0) console.error(chalk.red(`Command ${commandName} not found.`));
+		return value;
+	}
+	findArgument(commandName, followRedirect = true) {
+		const command = this.commands[commandName];
+		if (!command) return void 0;
+		if (command.redirect && followRedirect) return this.findArgument(command.redirect);
+		if (commandName !== "_" && Object.hasOwn(this.parsedArguments, commandName)) return this.parsedArguments[commandName];
+		for (const alias of command.alias ?? []) if (Object.hasOwn(this.parsedArguments, alias)) return this.parsedArguments[alias];
+	}
+	/**
+	* 启动
+	* エリイ 起きてます❤
+	*/
+	okite() {
+		return this.start();
+	}
+};
+//#endregion
+//#region src/index.ts
+var src_default = new Erii();
+//#endregion
+export { Erii, src_default as default };

package/package.json

@@ -1,30 +1,55 @@
-{
-  "name": "erii",
-  "version": "2.0.6",
-  "description": "",
-  "main": "./dist/index.js",
-  "types": "./dist/index.d.ts",
-  "scripts": {
-    "build": "tsc"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/Last-Order/erii.git"
-  },
-  "author": "",
-  "license": "MIT",
-  "bugs": {
-    "url": "https://github.com/Last-Order/erii/issues"
-  },
-  "homepage": "https://github.com/Last-Order/erii#readme",
-  "dependencies": {
-    "chalk": "^2.4.1",
-    "clui": "^0.3.6",
-    "validator": "^13.7.0",
-    "yargs-parser": "^21.0.0"
-  },
-  "devDependencies": {
-    "@types/node": "^10.17.48",
-    "typescript": "^4.1.2"
-  }
-}
+{
+  "name": "erii",
+  "version": "3.0.0-beta.1",
+  "description": "",
+  "main": "./dist/index.mjs",
+  "types": "./dist/index.d.mts",
+  "scripts": {
+    "build": "tsdown",
+    "typecheck": "tsc --noEmit",
+    "test": "npm run build && npm run typecheck && node --test test/*.test.mjs",
+    "test:coverage": "npm run build && npm run typecheck && node --test --experimental-test-coverage --test-coverage-include=dist/index.mjs --test-coverage-include=src/utils/convert.ts --test-coverage-lines=100 --test-coverage-functions=100 --test-coverage-branches=95 test/*.test.mjs",
+    "prepack": "npm run build"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Last-Order/erii.git"
+  },
+  "author": "",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/Last-Order/erii/issues"
+  },
+  "homepage": "https://github.com/Last-Order/erii#readme",
+  "dependencies": {
+    "@types/validator": "^13.15.10",
+    "chalk": "^6.0.0",
+    "cli-color": "^2.0.0",
+    "clui": "^0.3.6",
+    "validator": "^13.15.35",
+    "yargs-parser": "^21.0.0"
+  },
+  "devDependencies": {
+    "@types/cli-color": "^2.0.6",
+    "@types/clui": "^0.3.5",
+    "@types/node": "^24.13.5",
+    "@types/yargs-parser": "^21.0.3",
+    "tsdown": "^0.23.0",
+    "typescript": "^7.0.2"
+  },
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.mts",
+      "import": "./dist/index.mjs"
+    }
+  },
+  "files": [
+    "dist",
+    "readme.md",
+    "logo.png"
+  ],
+  "engines": {
+    "node": ">=22.18.0"
+  }
+}