@eik/cli 3.1.3 → 3.1.5

package/commands/map-alias.js

@@ -1,95 +1,75 @@
-// @deprecated in favor of `alias` command
+import Alias from "../classes/alias.js";
+import { Alias as AliasFormatter } from "../formatters/index.js";
+import { commandHandler } from "../utils/command-handler.js";
 
-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';
+export const command = "map-alias <name> <version> <alias>";
 
-export const command = 'map-alias <name> <version> <alias>';
+export const aliases = ["ma"];
 
-export const aliases = ['ma'];
+export const describe = "Create an alias for a map";
 
-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 deprecated = "map-alias has been replaced by alias";
 
+/** @type {import('yargs').CommandBuilder} */
 export const builder = (yargs) => {
-    const defaults = getDefaults(yargs.argv.config || yargs.argv.cwd);
-
-    yargs
-        .positional('name', {
-            describe: `Import map name for import map that is to be aliased`,
-            type: 'string',
-        })
-        .positional('version', {
-            describe: `Import map version for import map that is to be aliased`,
-            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`);
+	return yargs
+		.positional("name", {
+			describe: "Import map package name",
+			type: "string",
+		})
+		.positional("version", {
+			describe: "Import map version",
+			type: "string",
+		})
+		.positional("alias", {
+			describe:
+				"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({
-            type: 'map',
-            logger: log,
-            ...argv,
-        }).run();
+		const data = await new Alias({
+			debug,
+			name,
+			version,
+			server,
+			...rest,
+			type: "map",
+			logger: log,
+		}).run();
 
-        data.name = name;
-        data.version = version;
-        data.files = [];
+		data.name = name;
+		data.version = version;
+		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);
-    }
+		const createdOrUpdated = data.update ? "Updated" : "Created";
 
-    spinner.text = '';
-    spinner.stopAndPersist();
-    if (success) {
-        new AliasFormatter(data).format(server);
-    } else {
-        process.exit(1);
-    }
-};
+		log.info(
+			`${createdOrUpdated} alias for package "${data.name}". ("${data.version}" => "v${data.alias}")`,
+		);
 
-export const deprecated =
-    '"map-alias" will be removed in a future version. Please use "alias" instead';
+		new AliasFormatter(data).format(server);
+	},
+);

package/commands/map.js

@@ -1,90 +1,76 @@
-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 { join } from "path";
+import PublishMap from "../classes/publish/map.js";
+import { Artifact } from "../formatters/index.js";
+import { commandHandler } from "../utils/command-handler.js";
 
-export const command = 'map <name> <version> <file>';
+export const command = "map <name> <version> <file>";
 
-export const aliases = ['m'];
+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
-        .positional('name', {
-            describe: 'Import map name.',
-            type: 'string',
-        })
-        .positional('version', {
-            describe: 'Import map version.',
-            type: 'string',
-        })
-        .positional('file', {
-            describe:
-                '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`,
-    );
+	return yargs
+		.positional("name", {
+			describe: "Import map name.",
+			type: "string",
+		})
+		.positional("version", {
+			describe: "Import map version.",
+			type: "string",
+		})
+		.positional("file", {
+			describe:
+				"Path to import map file on local disk relative to the current working directory.",
+			type: "string",
+			normalize: true,
+		})
+		.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);
-
-        await new PublishMap({ logger: log, ...argv }).run();
-
-        let url = new URL(join('map', name), server);
-        let res = await fetch(url);
-        const pkgMeta = await res.json();
-
-        url = new URL(join('map', name, version), server);
-        res = await fetch(url);
-
-        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);
-    }
-};
+export const handler = commandHandler(
+	{ command, options: ["server"] },
+	async (argv, log) => {
+		const { debug, name, version, server, ...rest } = argv;
+
+		await new PublishMap({
+			logger: log,
+			debug,
+			name,
+			version,
+			server,
+			...rest,
+		}).run();
+
+		let url = new URL(join("map", name), server);
+		let res = await fetch(url);
+		const pkgMeta = await res.json();
+
+		url = new URL(join("map", name, version), server);
+		res = await fetch(url);
+
+		log.info(`Published import map "${name}" at version "${version}"`);
+
+		const artifact = new Artifact(pkgMeta);
+		const versions = new Map(pkgMeta.versions);
+		artifact.versions = Array.from(versions.values());
+		artifact.format(server);
+
+		process.stdout.write("\n");
+	},
+);

package/commands/meta.js

@@ -1,60 +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 Meta from "../classes/meta.js";
+import { Artifact } from "../formatters/index.js";
+import { commandHandler } from "../utils/command-handler.js";
 
-export const command = 'meta <name>';
+export const command = "meta <name>";
 
-export const aliases = ['show'];
+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,90 +1,65 @@
-// @deprecated in favor of `alias` command
+import Alias from "../classes/alias.js";
+import { Alias as AliasFormatter } from "../formatters/index.js";
+import { commandHandler } from "../utils/command-handler.js";
 
-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';
+export const command = "npm-alias <name> <version> <alias>";
 
-export const command = 'npm-alias <name> <version> <alias>';
+export const aliases = ["na", "dep-alias", "dependency-alias"];
 
-export const aliases = ['na', 'dep-alias', 'dependency-alias'];
+export const describe = "Create an alias for an NPM package";
 
-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 deprecated = "npm-alias has been replaced by alias";
 
+/** @type {import('yargs').CommandBuilder} */
 export const builder = (yargs) => {
-    const defaults = getDefaults(yargs.argv.config || yargs.argv.cwd);
-
-    yargs
-        .positional('name', {
-            describe: 'Name matching NPM package name.',
-            type: 'string',
-        })
-        .positional('version', {
-            describe: 'Version matching NPM package version.',
-            type: 'string',
-        })
-        .positional('alias', {
-            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`,
-    );
+	return yargs
+		.positional("name", {
+			describe: "Name matching NPM package name.",
+			type: "string",
+		})
+		.positional("version", {
+			describe: "Version matching NPM package version.",
+			type: "string",
+		})
+		.positional("alias", {
+			describe:
+				"Alias for a semver version. Must be the semver major component of 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 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({
-            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);
-    }
-};
+		const data = await new Alias({
+			debug,
+			server,
+			...rest,
+			type: "npm",
+			logger: log,
+		}).run();
 
-export const deprecated =
-    '"npm-alias" will be removed in a future version. Please use "alias" instead';
+		const createdOrUpdated = data.update ? "Updated" : "Created";
+		log.info(
+			`${createdOrUpdated} alias for package "${data.name}". ("${data.version}" => "v${data.alias}")`,
+		);
+		new AliasFormatter(data).format(server);
+	},
+);