fast-npm-meta 1.3.0 → 1.4.0

package/dist/cli.mjs

@@ -1,8 +1,7 @@
 #!/usr/bin/env node
 import process$1 from "node:process";
-import { EventEmitter } from "events";
 
-//#region ../node_modules/.pnpm/cac@6.7.14/node_modules/cac/dist/index.mjs
+//#region ../node_modules/.pnpm/cac@7.0.0/node_modules/cac/dist/index.js
 function toArr(any) {
 	return any == null ? [] : Array.isArray(any) ? any : [any];
 }
@@ -10,7 +9,7 @@ function toVal(out, key, val, opts) {
 	var x, old = out[key], nxt = !!~opts.string.indexOf(key) ? val == null || val === true ? "" : String(val) : typeof val === "boolean" ? val : !!~opts.boolean.indexOf(key) ? val === "false" ? false : val === "true" || (out._.push((x = +val, x * 0 === 0) ? x : val), !!val) : (x = +val, x * 0 === 0) ? x : val;
 	out[key] = old == null ? nxt : Array.isArray(old) ? old.concat(nxt) : [old, nxt];
 }
-function mri2(args, opts) {
+function lib_default(args, opts) {
 	args = args || [];
 	opts = opts || {};
 	var k, arr, arg, name, val, out = { _: [] };
@@ -75,8 +74,10 @@ function mri2(args, opts) {
 	}
 	return out;
 }
-const removeBrackets = (v) => v.replace(/[<[].+/, "").trim();
-const findAllBrackets = (v) => {
+function removeBrackets(v) {
+	return v.replace(/[<[].+/, "").trim();
+}
+function findAllBrackets(v) {
 	const ANGLED_BRACKET_RE_GLOBAL = /<([^>]+)>/g;
 	const SQUARE_BRACKET_RE_GLOBAL = /\[([^\]]+)\]/g;
 	const res = [];
@@ -98,8 +99,8 @@ const findAllBrackets = (v) => {
 	let squareMatch;
 	while (squareMatch = SQUARE_BRACKET_RE_GLOBAL.exec(v)) res.push(parse(squareMatch));
 	return res;
-};
-const getMriOptions = (options) => {
+}
+function getMriOptions(options) {
 	const result = {
 		alias: {},
 		boolean: []
@@ -113,62 +114,76 @@ const getMriOptions = (options) => {
 		} else result.boolean.push(option.names[0]);
 	}
 	return result;
-};
-const findLongest = (arr) => {
+}
+function findLongest(arr) {
 	return arr.sort((a, b) => {
 		return a.length > b.length ? -1 : 1;
 	})[0];
-};
-const padRight = (str, length) => {
+}
+function padRight(str, length) {
 	return str.length >= length ? str : `${str}${" ".repeat(length - str.length)}`;
-};
-const camelcase = (input) => {
-	return input.replace(/([a-z])-([a-z])/g, (_, p1, p2) => {
+}
+function camelcase(input) {
+	return input.replaceAll(/([a-z])-([a-z])/g, (_, p1, p2) => {
 		return p1 + p2.toUpperCase();
 	});
-};
-const setDotProp = (obj, keys, val) => {
-	let i = 0;
-	let length = keys.length;
-	let t = obj;
-	let x;
-	for (; i < length; ++i) {
-		x = t[keys[i]];
-		t = t[keys[i]] = i === length - 1 ? val : x != null ? x : !!~keys[i + 1].indexOf(".") || !(+keys[i + 1] > -1) ? {} : [];
+}
+function setDotProp(obj, keys, val) {
+	let current = obj;
+	for (let i = 0; i < keys.length; i++) {
+		const key = keys[i];
+		if (i === keys.length - 1) {
+			current[key] = val;
+			return;
+		}
+		if (current[key] == null) {
+			const nextKeyIsArrayIndex = +keys[i + 1] > -1;
+			current[key] = nextKeyIsArrayIndex ? [] : {};
+		}
+		current = current[key];
 	}
-};
-const setByType = (obj, transforms) => {
+}
+function setByType(obj, transforms) {
 	for (const key of Object.keys(transforms)) {
 		const transform = transforms[key];
 		if (transform.shouldTransform) {
-			obj[key] = Array.prototype.concat.call([], obj[key]);
+			obj[key] = [obj[key]].flat();
 			if (typeof transform.transformFunction === "function") obj[key] = obj[key].map(transform.transformFunction);
 		}
 	}
-};
-const getFileName = (input) => {
-	const m = /([^\\\/]+)$/.exec(input);
+}
+function getFileName(input) {
+	const m = /([^\\/]+)$/.exec(input);
 	return m ? m[1] : "";
-};
-const camelcaseOptionName = (name) => {
+}
+function camelcaseOptionName(name) {
 	return name.split(".").map((v, i) => {
 		return i === 0 ? camelcase(v) : v;
 	}).join(".");
-};
+}
 var CACError = class extends Error {
 	constructor(message) {
 		super(message);
-		this.name = this.constructor.name;
-		if (typeof Error.captureStackTrace === "function") Error.captureStackTrace(this, this.constructor);
-		else this.stack = new Error(message).stack;
+		this.name = "CACError";
+		if (typeof Error.captureStackTrace !== "function") this.stack = new Error(message).stack;
 	}
 };
 var Option = class {
+	rawName;
+	description;
+	/** Option name */
+	name;
+	/** Option name and aliases */
+	names;
+	isBoolean;
+	required;
+	config;
+	negated;
 	constructor(rawName, description, config) {
 		this.rawName = rawName;
 		this.description = description;
 		this.config = Object.assign({}, config);
-		rawName = rawName.replace(/\.\*/g, "");
+		rawName = rawName.replaceAll(".*", "");
 		this.negated = false;
 		this.names = removeBrackets(rawName).split(",").map((v) => {
 			let name = v.trim().replace(/^-{1,2}/, "");
@@ -178,16 +193,39 @@ var Option = class {
 			}
 			return camelcaseOptionName(name);
 		}).sort((a, b) => a.length > b.length ? 1 : -1);
-		this.name = this.names[this.names.length - 1];
+		this.name = this.names.at(-1);
 		if (this.negated && this.config.default == null) this.config.default = true;
 		if (rawName.includes("<")) this.required = true;
 		else if (rawName.includes("[")) this.required = false;
 		else this.isBoolean = true;
 	}
 };
-const processArgs = process.argv;
-const platformInfo = `${process.platform}-${process.arch} node-${process.version}`;
+let runtimeProcessArgs;
+let runtimeInfo;
+if (typeof process !== "undefined") {
+	let runtimeName;
+	if (typeof Deno !== "undefined" && typeof Deno.version?.deno === "string") runtimeName = "deno";
+	else if (typeof Bun !== "undefined" && typeof Bun.version === "string") runtimeName = "bun";
+	else runtimeName = "node";
+	runtimeInfo = `${process.platform}-${process.arch} ${runtimeName}-${process.version}`;
+	runtimeProcessArgs = process.argv;
+} else if (typeof navigator === "undefined") runtimeInfo = `unknown`;
+else runtimeInfo = `${navigator.platform} ${navigator.userAgent}`;
 var Command = class {
+	rawName;
+	description;
+	config;
+	cli;
+	options;
+	aliasNames;
+	name;
+	args;
+	commandAction;
+	usageText;
+	versionNumber;
+	examples;
+	helpCallback;
+	globalCommand;
 	constructor(rawName, description, config = {}, cli) {
 		this.rawName = rawName;
 		this.description = description;
@@ -220,6 +258,12 @@ var Command = class {
 		this.examples.push(example);
 		return this;
 	}
+	/**
+	* Add a option for this command
+	* @param rawName Raw option name(s)
+	* @param description Option description
+	* @param config Option config
+	*/
 	option(rawName, description, config) {
 		const option = new Option(rawName, description, config);
 		this.options.push(option);
@@ -233,6 +277,10 @@ var Command = class {
 		this.commandAction = callback;
 		return this;
 	}
+	/**
+	* Check if a command name is matched by this command
+	* @param name Command name
+	*/
 	isMatched(name) {
 		return this.name === name || this.aliasNames.includes(name);
 	}
@@ -242,6 +290,10 @@ var Command = class {
 	get isGlobalCommand() {
 		return this instanceof GlobalCommand;
 	}
+	/**
+	* Check if an option is registered in this command
+	* @param name Option name
+	*/
 	hasOption(name) {
 		name = name.split(".")[0];
 		return this.options.find((option) => {
@@ -263,8 +315,7 @@ var Command = class {
 				body: commands.map((command) => {
 					return `  ${padRight(command.rawName, longestCommandName.length)}  ${command.description}`;
 				}).join("\n")
-			});
-			sections.push({
+			}, {
 				title: `For more info, run any command with the \`--help\` flag`,
 				body: commands.map((command) => `  $ ${name}${command.name === "" ? "" : ` ${command.name}`} --help`).join("\n")
 			});
@@ -288,26 +339,33 @@ var Command = class {
 			}).join("\n")
 		});
 		if (helpCallback) sections = helpCallback(sections) || sections;
-		console.log(sections.map((section) => {
-			return section.title ? `${section.title}:
-${section.body}` : section.body;
+		console.info(sections.map((section) => {
+			return section.title ? `${section.title}:\n${section.body}` : section.body;
 		}).join("\n\n"));
 	}
 	outputVersion() {
 		const { name } = this.cli;
 		const { versionNumber } = this.cli.globalCommand;
-		if (versionNumber) console.log(`${name}/${versionNumber} ${platformInfo}`);
+		if (versionNumber) console.info(`${name}/${versionNumber} ${runtimeInfo}`);
 	}
 	checkRequiredArgs() {
 		const minimalArgsCount = this.args.filter((arg) => arg.required).length;
 		if (this.cli.args.length < minimalArgsCount) throw new CACError(`missing required args for command \`${this.rawName}\``);
 	}
+	/**
+	* Check if the parsed options contain any unknown options
+	*
+	* Exit and output error when true
+	*/
 	checkUnknownOptions() {
 		const { options, globalCommand } = this.cli;
 		if (!this.config.allowUnknownOptions) {
 			for (const name of Object.keys(options)) if (name !== "--" && !this.hasOption(name) && !globalCommand.hasOption(name)) throw new CACError(`Unknown option \`${name.length > 1 ? `--${name}` : `-${name}`}\``);
 		}
 	}
+	/**
+	* Check if the required string-type options exist
+	*/
 	checkOptionValue() {
 		const { options: parsedOptions, globalCommand } = this.cli;
 		const options = [...globalCommand.options, ...this.options];
@@ -319,14 +377,43 @@ ${section.body}` : section.body;
 			}
 		}
 	}
+	/**
+	* Check if the number of args is more than expected
+	*/
+	checkUnusedArgs() {
+		const maximumArgsCount = this.args.some((arg) => arg.variadic) ? Infinity : this.args.length;
+		if (maximumArgsCount < this.cli.args.length) throw new CACError(`Unused args: ${this.cli.args.slice(maximumArgsCount).map((arg) => `\`${arg}\``).join(", ")}`);
+	}
 };
 var GlobalCommand = class extends Command {
 	constructor(cli) {
 		super("@@global@@", "", {}, cli);
 	}
 };
-var __assign = Object.assign;
-var CAC = class extends EventEmitter {
+var CAC = class extends EventTarget {
+	/** The program name to display in help and version message */
+	name;
+	commands;
+	globalCommand;
+	matchedCommand;
+	matchedCommandName;
+	/**
+	* Raw CLI arguments
+	*/
+	rawArgs;
+	/**
+	* Parsed CLI arguments
+	*/
+	args;
+	/**
+	* Parsed CLI options, camelCased
+	*/
+	options;
+	showHelpOnExit;
+	showVersionOnExit;
+	/**
+	* @param name The program name to display in help and version message
+	*/
 	constructor(name = "") {
 		super();
 		this.name = name;
@@ -337,39 +424,75 @@ var CAC = class extends EventEmitter {
 		this.globalCommand = new GlobalCommand(this);
 		this.globalCommand.usage("<command> [options]");
 	}
+	/**
+	* Add a global usage text.
+	*
+	* This is not used by sub-commands.
+	*/
 	usage(text) {
 		this.globalCommand.usage(text);
 		return this;
 	}
+	/**
+	* Add a sub-command
+	*/
 	command(rawName, description, config) {
 		const command = new Command(rawName, description || "", config, this);
 		command.globalCommand = this.globalCommand;
 		this.commands.push(command);
 		return command;
 	}
+	/**
+	* Add a global CLI option.
+	*
+	* Which is also applied to sub-commands.
+	*/
 	option(rawName, description, config) {
 		this.globalCommand.option(rawName, description, config);
 		return this;
 	}
+	/**
+	* Show help message when `-h, --help` flags appear.
+	*
+	*/
 	help(callback) {
 		this.globalCommand.option("-h, --help", "Display this message");
 		this.globalCommand.helpCallback = callback;
 		this.showHelpOnExit = true;
 		return this;
 	}
+	/**
+	* Show version number when `-v, --version` flags appear.
+	*
+	*/
 	version(version, customFlags = "-v, --version") {
 		this.globalCommand.version(version, customFlags);
 		this.showVersionOnExit = true;
 		return this;
 	}
+	/**
+	* Add a global example.
+	*
+	* This example added here will not be used by sub-commands.
+	*/
 	example(example) {
 		this.globalCommand.example(example);
 		return this;
 	}
+	/**
+	* Output the corresponding help message
+	* When a sub-command is matched, output the help message for the command
+	* Otherwise output the global one.
+	*
+	*/
 	outputHelp() {
 		if (this.matchedCommand) this.matchedCommand.outputHelp();
 		else this.globalCommand.outputHelp();
 	}
+	/**
+	* Output the version number.
+	*
+	*/
 	outputVersion() {
 		this.globalCommand.outputVersion();
 	}
@@ -384,7 +507,14 @@ var CAC = class extends EventEmitter {
 		this.matchedCommand = void 0;
 		this.matchedCommandName = void 0;
 	}
-	parse(argv = processArgs, { run = true } = {}) {
+	/**
+	* Parse argv
+	*/
+	parse(argv, { run = true } = {}) {
+		if (!argv) {
+			if (!runtimeProcessArgs) throw new Error("No argv provided and runtime process argv is not available.");
+			argv = runtimeProcessArgs;
+		}
 		this.rawArgs = argv;
 		if (!this.name) this.name = argv[1] ? getFileName(argv[1]) : "cli";
 		let shouldParse = true;
@@ -393,17 +523,20 @@ var CAC = class extends EventEmitter {
 			const commandName = parsed.args[0];
 			if (command.isMatched(commandName)) {
 				shouldParse = false;
-				const parsedInfo = __assign(__assign({}, parsed), { args: parsed.args.slice(1) });
+				const parsedInfo = {
+					...parsed,
+					args: parsed.args.slice(1)
+				};
 				this.setParsedInfo(parsedInfo, command, commandName);
-				this.emit(`command:${commandName}`, command);
+				this.dispatchEvent(new CustomEvent(`command:${commandName}`, { detail: command }));
 			}
 		}
 		if (shouldParse) {
-			for (const command of this.commands) if (command.name === "") {
+			for (const command of this.commands) if (command.isDefaultCommand) {
 				shouldParse = false;
 				const parsed = this.mri(argv.slice(2), command);
 				this.setParsedInfo(parsed, command);
-				this.emit(`command:!`, command);
+				this.dispatchEvent(new CustomEvent("command:!", { detail: command }));
 			}
 		}
 		if (shouldParse) {
@@ -425,7 +558,7 @@ var CAC = class extends EventEmitter {
 			options: this.options
 		};
 		if (run) this.runMatchedCommand();
-		if (!this.matchedCommand && this.args[0]) this.emit("command:*");
+		if (!this.matchedCommand && this.args[0]) this.dispatchEvent(new CustomEvent("command:*", { detail: this.args[0] }));
 		return parsedArgv;
 	}
 	mri(argv, command) {
@@ -433,26 +566,27 @@ var CAC = class extends EventEmitter {
 		const mriOptions = getMriOptions(cliOptions);
 		let argsAfterDoubleDashes = [];
 		const doubleDashesIndex = argv.indexOf("--");
-		if (doubleDashesIndex > -1) {
+		if (doubleDashesIndex !== -1) {
 			argsAfterDoubleDashes = argv.slice(doubleDashesIndex + 1);
 			argv = argv.slice(0, doubleDashesIndex);
 		}
-		let parsed = mri2(argv, mriOptions);
+		let parsed = lib_default(argv, mriOptions);
 		parsed = Object.keys(parsed).reduce((res, name) => {
-			return __assign(__assign({}, res), { [camelcaseOptionName(name)]: parsed[name] });
+			return {
+				...res,
+				[camelcaseOptionName(name)]: parsed[name]
+			};
 		}, { _: [] });
 		const args = parsed._;
 		const options = { "--": argsAfterDoubleDashes };
 		const ignoreDefault = command && command.config.ignoreOptionDefaultValue ? command.config.ignoreOptionDefaultValue : this.globalCommand.config.ignoreOptionDefaultValue;
-		let transforms = Object.create(null);
+		const transforms = Object.create(null);
 		for (const cliOption of cliOptions) {
 			if (!ignoreDefault && cliOption.config.default !== void 0) for (const name of cliOption.names) options[name] = cliOption.config.default;
-			if (Array.isArray(cliOption.config.type)) {
-				if (transforms[cliOption.name] === void 0) {
-					transforms[cliOption.name] = Object.create(null);
-					transforms[cliOption.name]["shouldTransform"] = true;
-					transforms[cliOption.name]["transformFunction"] = cliOption.config.type[0];
-				}
+			if (Array.isArray(cliOption.config.type) && transforms[cliOption.name] === void 0) {
+				transforms[cliOption.name] = Object.create(null);
+				transforms[cliOption.name].shouldTransform = true;
+				transforms[cliOption.name].transformFunction = cliOption.config.type[0];
 			}
 		}
 		for (const key of Object.keys(parsed)) if (key !== "_") {
@@ -470,6 +604,7 @@ var CAC = class extends EventEmitter {
 		command.checkUnknownOptions();
 		command.checkOptionValue();
 		command.checkRequiredArgs();
+		command.checkUnusedArgs();
 		const actionArgs = [];
 		command.args.forEach((arg, index) => {
 			if (arg.variadic) actionArgs.push(args.slice(index));
@@ -479,11 +614,14 @@ var CAC = class extends EventEmitter {
 		return command.commandAction.apply(this, actionArgs);
 	}
 };
+/**
+* @param name The program name to display in help and version message
+*/
 const cac = (name = "") => new CAC(name);
 
 //#endregion
 //#region package.json
-var version = "1.3.0";
+var version = "1.4.0";
 
 //#endregion
 //#region ../node_modules/.pnpm/is-network-error@1.3.0/node_modules/is-network-error/index.js

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "fast-npm-meta",
   "type": "module",
-  "version": "1.3.0",
+  "version": "1.4.0",
   "description": "Get npm package metadata",
   "author": "Anthony Fu <anthonyfu117@hotmail.com>",
   "license": "MIT",
@@ -27,7 +27,7 @@
     "skills"
   ],
   "devDependencies": {
-    "cac": "^6.7.14",
+    "cac": "^7.0.0",
     "p-retry": "^7.1.1",
     "tsdown": "^0.20.3"
   },

package/skills/fast-npm-meta/SKILL.md

@@ -1,3 +1,9 @@
+---
+name: fast-npm-meta
+description: Get npm package metadata
+license: MIT
+---
+
 # fast-npm-meta CLI
 
 When querying npm package versions or metadata, **prefer `fast-npm-meta` over `npm view`**.