@eik/cli 3.1.4 → 3.1.5

package/commands/map-alias.js

@@ -1,72 +1,63 @@
-// @deprecated in favor of `alias` command
-
-import ora from "ora";
 import Alias from "../classes/alias.js";
-import { logger, getDefaults } from "../utils/index.js";
 import { Alias as AliasFormatter } from "../formatters/index.js";
+import { commandHandler } from "../utils/command-handler.js";
 
 export const command = "map-alias <name> <version> <alias>";
 
 export const aliases = ["ma"];
 
-export const describe = `DEPRECATED: This command has been replaced by the alias command and will be removed in a future version. Create a semver major alias for an import map as identified by its name and version. An import map with the given name and version must already exist on asset server. Alias should be the semver major part of the import map version. Eg. For an import map of version 5.4.3, you should use 5 as the alias`;
+export const describe = "Create an alias for a map";
 
-export const builder = (yargs) => {
-	const defaults = getDefaults(yargs.argv.config || yargs.argv.cwd);
+export const deprecated = "map-alias has been replaced by alias";
 
-	yargs
+/** @type {import('yargs').CommandBuilder} */
+export const builder = (yargs) => {
+	return yargs
 		.positional("name", {
-			describe: `Import map name for import map that is to be aliased`,
+			describe: "Import map package name",
 			type: "string",
 		})
 		.positional("version", {
-			describe: `Import map version for import map that is to be aliased`,
+			describe: "Import map version",
 			type: "string",
 		})
 		.positional("alias", {
-			describe: `Alias for a semver version. Should be the semver major component of version.`,
-			type: "string",
-		});
-
-	yargs.options({
-		server: {
-			alias: "s",
-			describe: "Specify location of asset server.",
-			// @ts-expect-error
-			default: defaults.server,
-		},
-		token: {
 			describe:
-				"Provide a jwt token to be used to authenticate with the Eik server.",
-			default: "",
-			alias: "t",
-		},
-	});
-
-	// @ts-expect-error
-	yargs.default("token", defaults.token, defaults.token ? "######" : "");
-
-	yargs.example(`eik map-alias my-map 1.0.0 1`);
-	yargs.example(`eik map-alias my-map 1.7.3 1`);
-	yargs.example(`eik map-alias my-map 6.3.1 6`);
-	yargs.example(
-		`eik map-alias my-map 6.3.1 6 --server https://assets.myeikserver.com`,
-	);
-	yargs.example(`eik map-alias my-map 4.2.2 4 --debug`);
+				"Alias value, the semver major component of the import map version",
+			type: "string",
+		})
+		.options({
+			server: {
+				alias: "s",
+				describe: "Eik server address, if different from configuration file",
+			},
+			token: {
+				describe: "JWT used for authentication, if not using eik login",
+				alias: "t",
+			},
+		})
+		.example("eik map-alias my-map 1.0.0 1")
+		.example("eik map-alias my-map 1.7.3 1")
+		.example("eik map-alias my-map 6.3.1 6")
+		.example(
+			"eik map-alias my-map 6.3.1 6 --server https://assets.myeikserver.com",
+		)
+		.example("eik map-alias my-map 6.3.1 6 --token yourtoken");
 };
 
-export const handler = async (argv) => {
-	const spinner = ora({ stream: process.stdout }).start("working...");
-	let success = false;
-	const { debug, name, version, server } = argv;
-	const log = logger(spinner, debug);
-	let data = {};
+export const handler = commandHandler(
+	{ command, options: ["server"] },
+	async (argv, log) => {
+		const { debug, name, version, server, ...rest } = argv;
 
-	try {
-		data = await new Alias({
+		const data = await new Alias({
+			debug,
+			name,
+			version,
+			server,
+			...rest,
 			type: "map",
 			logger: log,
-			...argv,
 		}).run();
 
 		data.name = name;
@@ -74,22 +65,11 @@ export const handler = async (argv) => {
 		data.files = [];
 
 		const createdOrUpdated = data.update ? "Updated" : "Created";
+
 		log.info(
 			`${createdOrUpdated} alias for package "${data.name}". ("${data.version}" => "v${data.alias}")`,
 		);
-		success = true;
-	} catch (err) {
-		log.warn(err.message);
-	}
 
-	spinner.text = "";
-	spinner.stopAndPersist();
-	if (success) {
 		new AliasFormatter(data).format(server);
-	} else {
-		process.exit(1);
-	}
-};
-
-export const deprecated =
-	'"map-alias" will be removed in a future version. Please use "alias" instead';
+	},
+);

package/commands/map.js

@@ -1,19 +1,17 @@
 import { join } from "path";
-import ora from "ora";
 import PublishMap from "../classes/publish/map.js";
-import { logger, getDefaults } from "../utils/index.js";
 import { Artifact } from "../formatters/index.js";
+import { commandHandler } from "../utils/command-handler.js";
 
 export const command = "map <name> <version> <file>";
 
 export const aliases = ["m"];
 
-export const describe = `Upload an import map file to the server under a given name and version. A name/version combination must be unique and a version must be semver compliant. Subsquent published versions must increase. Eg. 1.0.0 1.0.1, 1.1.0, 2.0.0 etc.`;
+export const describe = "Publish an import map to the server";
 
+/** @type {import('yargs').CommandBuilder} */
 export const builder = (yargs) => {
-	const defaults = getDefaults(yargs.argv.config || yargs.argv.cwd);
-
-	yargs
+	return yargs
 		.positional("name", {
 			describe: "Import map name.",
 			type: "string",
@@ -27,41 +25,37 @@ export const builder = (yargs) => {
 				"Path to import map file on local disk relative to the current working directory.",
 			type: "string",
 			normalize: true,
-		});
-
-	yargs.options({
-		server: {
-			alias: "s",
-			describe: "Specify location of asset server.",
-			// @ts-expect-error
-			default: defaults.server,
-		},
-		token: {
-			describe:
-				"Provide a jwt token to be used to authenticate with the Eik server.",
-			default: "",
-			alias: "t",
-		},
-	});
-
-	// @ts-expect-error
-	yargs.default("token", defaults.token, defaults.token ? "######" : "");
-
-	yargs.example(`eik map my-map 1.0.0 ./import-map.json`);
-	yargs.example(`eik map my-map 2.1.0 ./import-map.json --debug`);
-	yargs.example(
-		`eik map my-map 2.1.1 ./import-map.json --server https://assets.myeikserver.com`,
-	);
+		})
+		.options({
+			server: {
+				alias: "s",
+				describe: "Eik server address, if different from configuration file",
+			},
+			token: {
+				describe: "JWT used for authentication, if not using eik login",
+				alias: "t",
+			},
+		})
+		.example("eik map my-map 1.0.0 ./import-map.json")
+		.example(
+			"eik map my-map 2.1.1 ./import-map.json --server https://assets.myeikserver.com",
+		)
+		.example("eik map my-map 1.0.0 ./import-map.json --token yourtoken");
 };
 
-export const handler = async (argv) => {
-	const spinner = ora({ stream: process.stdout }).start("working...");
-	const { debug, server, name, version } = argv;
-
-	try {
-		const log = logger(spinner, debug);
+export const handler = commandHandler(
+	{ command, options: ["server"] },
+	async (argv, log) => {
+		const { debug, name, version, server, ...rest } = argv;
 
-		await new PublishMap({ logger: log, ...argv }).run();
+		await new PublishMap({
+			logger: log,
+			debug,
+			name,
+			version,
+			server,
+			...rest,
+		}).run();
 
 		let url = new URL(join("map", name), server);
 		let res = await fetch(url);
@@ -72,19 +66,11 @@ export const handler = async (argv) => {
 
 		log.info(`Published import map "${name}" at version "${version}"`);
 
-		spinner.text = "";
-		spinner.stopAndPersist();
-
 		const artifact = new Artifact(pkgMeta);
 		const versions = new Map(pkgMeta.versions);
 		artifact.versions = Array.from(versions.values());
 		artifact.format(server);
 
 		process.stdout.write("\n");
-	} catch (err) {
-		spinner.warn(err.message);
-		spinner.text = "";
-		spinner.stopAndPersist();
-		process.exit(1);
-	}
-};
+	},
+);

package/commands/meta.js

@@ -1,59 +1,43 @@
-import ora from "ora";
 import Meta from "../classes/meta.js";
 import { Artifact } from "../formatters/index.js";
-import { logger, getDefaults } from "../utils/index.js";
+import { commandHandler } from "../utils/command-handler.js";
 
 export const command = "meta <name>";
 
 export const aliases = ["show"];
 
-export const describe = `Retrieve meta information by package, map or npm name.If a given name exists in several types (package and map for example), results will be returned and displayed from all matching types`;
+export const describe = "Get information about a package";
 
+/** @type {import('yargs').CommandBuilder} */
 export const builder = (yargs) => {
-	const defaults = getDefaults(yargs.argv.config || yargs.argv.cwd);
-
-	yargs.positional("name", {
-		describe: "Name matching one or more of package, npm or import map name",
-		type: "string",
-	});
-
-	yargs.options({
-		server: {
-			alias: "s",
-			describe: "Specify location of asset server.",
-			// @ts-expect-error
-			default: defaults.server,
-		},
-	});
-
-	yargs.example(`eik meta lit-html`);
-	yargs.example(`eik meta my-map --debug`);
-	yargs.example(`eik meta my-app --server https://assets.myeikserver.com`);
+	return yargs
+		.positional("name", {
+			describe: "Name matching one or more of package, npm or import map name",
+			type: "string",
+		})
+		.options({
+			server: {
+				alias: "s",
+				describe: "Eik server address, if different from configuration file",
+			},
+		})
+		.example("eik meta lit-html")
+		.example("eik meta my-map --debug")
+		.example("eik meta my-app --server https://assets.myeikserver.com");
 };
 
-export const handler = async (argv) => {
-	const spinner = ora({ stream: process.stdout }).start("working...");
-	let meta = false;
-	const { debug, server } = argv;
-	const l = logger(spinner, debug);
-
-	try {
-		// @ts-expect-error
-		meta = await new Meta({ logger: l, ...argv }).run();
-		spinner.text = "";
-		spinner.stopAndPersist();
-	} catch (err) {
-		spinner.text = "";
-		spinner.stopAndPersist();
-		l.warn(err.message);
-		process.exit(1);
-	}
-
-	if (meta) {
-		for (const m of Object.values(meta)) {
-			const artifact = new Artifact(m);
-			artifact.format(server);
-			process.stdout.write(`\n`);
+export const handler = commandHandler(
+	{ command, options: ["server"] },
+	async (argv, log) => {
+		const { debug, server, ...rest } = argv;
+
+		const meta = await new Meta({ logger: log, debug, server, ...rest }).run();
+		if (meta) {
+			for (const m of Object.values(meta)) {
+				const artifact = new Artifact(m);
+				artifact.format(server);
+				process.stdout.write(`\n`);
+			}
 		}
-	}
-};
+	},
+);

package/commands/npm-alias.js

@@ -1,20 +1,18 @@
-// @deprecated in favor of `alias` command
-
-import ora from "ora";
 import Alias from "../classes/alias.js";
-import { logger, getDefaults } from "../utils/index.js";
 import { Alias as AliasFormatter } from "../formatters/index.js";
+import { commandHandler } from "../utils/command-handler.js";
 
 export const command = "npm-alias <name> <version> <alias>";
 
 export const aliases = ["na", "dep-alias", "dependency-alias"];
 
-export const describe = `DEPRECATED: This command has been replaced by the alias command and will be removed in a future version. Create a semver major alias for an NPM package as identified by its name and version. An NPM package with the given name and version must already exist on the asset server. Alias should be the semver major part of the NPM package version. Eg. For an NPM package of version 5.4.3, you should use 5 as the alias`;
+export const describe = "Create an alias for an NPM package";
 
-export const builder = (yargs) => {
-	const defaults = getDefaults(yargs.argv.config || yargs.argv.cwd);
+export const deprecated = "npm-alias has been replaced by alias";
 
-	yargs
+/** @type {import('yargs').CommandBuilder} */
+export const builder = (yargs) => {
+	return yargs
 		.positional("name", {
 			describe: "Name matching NPM package name.",
 			type: "string",
@@ -27,64 +25,41 @@ export const builder = (yargs) => {
 			describe:
 				"Alias for a semver version. Must be the semver major component of version.",
 			type: "string",
-		});
-
-	yargs.options({
-		server: {
-			alias: "s",
-			describe: "Specify location of asset server.",
-			// @ts-expect-error
-			default: defaults.server,
-		},
-		token: {
-			describe:
-				"Provide a jwt token to be used to authenticate with the Eik server.",
-			default: "",
-			alias: "t",
-		},
-	});
-
-	// @ts-expect-error
-	yargs.default("token", defaults.token, defaults.token ? "######" : "");
-
-	yargs.example(`eik npm lit-html 1.0.0 1`);
-	yargs.example(`eik npm lit-html 1.3.5 1 --debug`);
-	yargs.example(
-		`eik npm lit-html 5.3.2 5 --server https://assets.myeikserver.com`,
-	);
+		})
+		.options({
+			server: {
+				alias: "s",
+				describe: "Eik server address, if different from configuration file",
+			},
+			token: {
+				describe: "JWT used for authentication, if not using eik login",
+				alias: "t",
+			},
+		})
+		.example("eik npm-alias lit-html 1.0.0 1")
+		.example(
+			"eik npm-alias lit-html 5.3.2 5 --server https://assets.myeikserver.com",
+		)
+		.example("eik npm-alias lit-html 1.0.0 1 --token yourtoken");
 };
 
-export const handler = async (argv) => {
-	const spinner = ora({ stream: process.stdout }).start("working...");
-	let success = false;
-	const { debug, server } = argv;
-	const log = logger(spinner, debug);
-	let data = {};
+export const handler = commandHandler(
+	{ command, options: ["server"] },
+	async (argv, log) => {
+		const { debug, server, ...rest } = argv;
 
-	try {
-		data = await new Alias({
+		const data = await new Alias({
+			debug,
+			server,
+			...rest,
 			type: "npm",
 			logger: log,
-			...argv,
 		}).run();
 
 		const createdOrUpdated = data.update ? "Updated" : "Created";
 		log.info(
 			`${createdOrUpdated} alias for package "${data.name}". ("${data.version}" => "v${data.alias}")`,
 		);
-		success = true;
-	} catch (err) {
-		log.warn(err.message);
-	}
-
-	spinner.text = "";
-	spinner.stopAndPersist();
-	if (success) {
 		new AliasFormatter(data).format(server);
-	} else {
-		process.exit(1);
-	}
-};
-
-export const deprecated =
-	'"npm-alias" will be removed in a future version. Please use "alias" instead';
+	},
+);

package/commands/package-alias.js

@@ -1,101 +1,70 @@
-// @deprecated in favor of `alias` command
-
-import ora from "ora";
-import semver from "semver";
 import Alias from "../classes/alias.js";
-import { logger, getDefaults } from "../utils/index.js";
 import { Alias as AliasFormatter } from "../formatters/index.js";
+import { commandHandler } from "../utils/command-handler.js";
 
 export const command = "package-alias [name] [version] [alias]";
 
 export const aliases = ["pkg-alias", "pa"];
 
-export const describe = `DEPRECATED: This command has been replaced by the alias command and will be removed in a future version. Create a semver major alias for a package as identified by its name and version. A package with the given name and version must already exist on asset server. Alias should be the semver major part of the package version. Eg. For a package of version 5.4.3, you should use 5 as the alias`;
+export const describe = "Create an alias for a package";
 
-export const builder = (yargs) => {
-	const defaults = getDefaults(yargs.argv.config || yargs.argv.cwd);
+export const deprecated = "package-alias has been replaced by alias";
 
-	yargs
+/** @type {import('yargs').CommandBuilder} */
+export const builder = (yargs) => {
+	return yargs
 		.positional("name", {
 			describe: "Name matching existing name for a package on Eik server",
 			type: "string",
-			// @ts-expect-error
-			default: defaults.name,
 		})
 		.positional("version", {
 			describe: "Version matching existing version for a package on Eik server",
 			type: "string",
-			// @ts-expect-error
-			default: defaults.version,
 		})
 		.positional("alias", {
 			describe:
 				"Alias for a semver version. Must be the semver major component of version. Eg. 1.0.0 should be given as 1",
 			type: "string",
-			// @ts-expect-error
-			default: defaults.version ? semver.major(defaults.version) : null,
-		});
-
-	yargs.options({
-		server: {
-			alias: "s",
-			describe: "Specify location of Eik asset server.",
-			// @ts-expect-error
-			default: defaults.server,
-		},
-		token: {
-			describe:
-				"Provide a jwt token to be used to authenticate with the Eik server.",
-			default: "",
-			alias: "t",
-		},
-	});
-
-	// @ts-expect-error
-	yargs.default("token", defaults.token, defaults.token ? "######" : "");
-
-	yargs.example(`eik package-alias my-app 1.0.0 1`);
-	yargs.example(`eik package-alias my-app 1.7.3 1`);
-	yargs.example(`eik package-alias my-app 6.3.1 6`);
-	yargs.example(
-		`eik package-alias my-app 6.3.1 6 --server https://assets.myeikserver.com`,
-	);
-	yargs.example(`eik package-alias my-app 4.2.2 4 --debug`);
+		})
+		.options({
+			server: {
+				alias: "s",
+				describe: "Eik server address, if different from configuration file",
+			},
+			token: {
+				describe: "JWT used for authentication, if not using eik login",
+				alias: "t",
+			},
+		})
+		.example("eik package-alias my-app 1.0.0 1")
+		.example("eik package-alias my-app 1.7.3 1")
+		.example("eik package-alias my-app 6.3.1 6")
+		.example(
+			"eik package-alias my-app 6.3.1 6 --server https://assets.myeikserver.com",
+		)
+		.example("eik package-alias my-app 4.2.2 4 --token yourtoken");
 };
 
-export const handler = async (argv) => {
-	const spinner = ora({ stream: process.stdout }).start("working...");
-	let success = false;
-	const { debug, server } = argv;
-	const log = logger(spinner, debug);
-	let af;
+export const handler = commandHandler(
+	{ command, options: ["server"] },
+	async (argv, log) => {
+		const { debug, server, ...rest } = argv;
 
-	try {
 		const data = await new Alias({
+			debug,
+			server,
+			...rest,
 			type: "pkg",
 			logger: log,
-			...argv,
 		}).run();
 
-		af = new AliasFormatter(data);
+		const af = new AliasFormatter(data);
 
 		const createdOrUpdated = data.update ? "Updated" : "Created";
 		log.info(
 			`${createdOrUpdated} alias for package "${data.name}". ("${data.version}" => "v${data.alias}")`,
 		);
-		success = true;
-	} catch (err) {
-		log.warn(err.message);
-	}
-
-	spinner.text = "";
-	spinner.stopAndPersist();
-	if (success) {
-		af?.format(server);
-	} else {
-		process.exit(1);
-	}
-};
 
-export const deprecated =
-	'"package-alias" will be removed in a future version. Please use "alias" instead';
+		af.format(server);
+	},
+);

package/commands/ping.js

@@ -1,38 +1,27 @@
-import ora from "ora";
 import Ping from "../classes/ping.js";
-import { logger, getDefaults } from "../utils/index.js";
+import { commandHandler } from "../utils/command-handler.js";
 
+// TODO: replace positional argument with --server to be in line with other commands
 export const command = "ping [server]";
 
 export const aliases = [];
 
-export const describe = `Ping an Eik server to check that it is responding.`;
+export const describe = "Check that the Eik server is responding";
 
+/** @type {import('yargs').CommandBuilder} */
 export const builder = (yargs) => {
-	const defaults = getDefaults(yargs.argv.config || yargs.argv.cwd);
-
-	yargs.positional("server", {
-		describe: "Specify location of Eik server to ping.",
-		// @ts-expect-error
-		default: defaults.server,
-	});
-
-	yargs.example(`eik ping`);
-	yargs.example(`eik ping http://assets.myeikserver.com`);
-	yargs.example(`eik ping http://assets.myeikserver.com --debug`);
+	return yargs
+		.positional("server", {
+			describe: "Specify location of Eik server to check against.",
+		})
+		.example("eik ping")
+		.example("eik ping http://assets.myeikserver.com");
 };
 
-export const handler = async (argv) => {
-	const spinner = ora({ stream: process.stdout }).start("working...");
-	const { debug, server } = argv;
-
-	try {
-		await new Ping({ logger: logger(spinner, debug), server }).run();
-	} catch (err) {
-		// @ts-expect-error
-		logger.warn(err.message);
-	}
-
-	spinner.text = "";
-	spinner.stopAndPersist();
-};
+export const handler = commandHandler(
+	{ command, options: ["server"] },
+	async (argv, logger) => {
+		const { server } = argv;
+		await new Ping({ logger, server }).run();
+	},
+);