@eik/cli 3.1.3 → 3.1.5

package/classes/version.js

@@ -1,12 +1,12 @@
-import { copyFileSync, writeFileSync } from 'fs';
-import { join, isAbsolute, parse } from 'path';
-import abslog from 'abslog';
-import semver from 'semver';
-import { makeDirectorySync } from 'make-dir';
-import { schemas, EikConfig } from '@eik/common';
-import { integrity } from '../utils/http/index.js';
-import hash from '../utils/hash/index.js';
-import { typeSlug } from '../utils/index.js';
+import { copyFileSync, writeFileSync } from "fs";
+import { join, isAbsolute, parse } from "path";
+import abslog from "abslog";
+import semver from "semver";
+import { makeDirectorySync } from "make-dir";
+import { schemas, EikConfig } from "@eik/common";
+import { integrity } from "../utils/http/index.js";
+import hash from "../utils/hash/index.js";
+import { typeSlug } from "../utils/index.js";
 
 /**
  * @typedef {object} VersionOptions
@@ -23,158 +23,147 @@ import { typeSlug } from '../utils/index.js';
  */
 
 export default class Version {
-    /**
-     * @param {VersionOptions} options
-     */
-    constructor({
-        logger,
-        server,
-        type = 'package',
-        name,
-        version,
-        level = 'patch',
-        cwd,
-        map = [],
-        out = './.eik',
-        files,
-    }) {
-        const config = new EikConfig(
-            {
-                server,
-                type,
-                name,
-                version,
-                'import-map': map,
-                out,
-                files,
-            },
-            null,
-            cwd,
-        );
-
-        this.log = abslog(logger);
-        this.config = config;
-        this.path = isAbsolute(config.out) ? config.out : join(cwd, config.out);
-        this.level = level;
-    }
-
-    /**
-     * Similar to `npm version`, but updates `eik.json`
-     * @returns {Promise<string | null>} The new version number, or null if the versioning failed
-     */
-    async run() {
-        const { name, server, type, version, cwd, out, files, map } =
-            this.config;
-        const { log, level, path } = this;
-        log.debug('Validating input');
-
-        log.debug(`  ==> config object`);
-        this.config.validate();
-
-        log.debug(`  ==> cwd: ${cwd}`);
-        parse(cwd);
-
-        log.debug(`  ==> level: ${level}`);
-        if (!['major', 'minor', 'patch'].includes(level)) {
-            // @ts-expect-error
-            throw new schemas.ValidationError(
-                'Parameter "version" is not valid',
-            );
-        }
-
-        log.debug(`  ==> files: ${JSON.stringify(files)}`);
-        if (!files) {
-            // @ts-expect-error
-            throw new schemas.ValidationError('Parameter "files" is not valid');
-        }
-
-        log.debug(`  ==> map: ${JSON.stringify(map)}`);
-        if (!Array.isArray(map)) {
-            // @ts-expect-error
-            throw new schemas.ValidationError('Parameter "map" is not valid');
-        }
-
-        log.debug('Checking local package version');
-        log.debug(`Current local package version determined to be ${version}`);
-        log.debug(`Fetching remote package metadata from ${server}`);
-
-        let integrityHash;
-        try {
-            integrityHash = await integrity(
-                server,
-                typeSlug(type),
-                name,
-                version,
-            );
-        } catch (err) {
-            throw new Error(
-                `Unable to fetch package metadata from server: ${err.message}`,
-            );
-        }
-
-        if (!integrityHash) {
-            // version does not exist on server yet. No increment needed.
-            throw new Error(
-                `The current version of this package has not yet been published, version change is not needed.`,
-            );
-        }
-
-        log.debug('Hashing local files for comparison with server');
-
-        let localHash;
-        try {
-            makeDirectorySync(path);
-            const eikPathDest = join(path, 'eik.json');
-            const eikJSON = {
-                name,
-                server,
-                files,
-                'import-map': map,
-                out,
-            };
-            writeFileSync(eikPathDest, JSON.stringify(eikJSON, null, 2));
-
-            const localFiles = [eikPathDest];
-            log.debug(`  ==> ${eikPathDest}`);
-
-            if (files) {
-                try {
-                    const mappings = await this.config.mappings();
-
-                    for (const mapping of mappings) {
-                        const destination = join(
-                            path,
-                            mapping.destination.filePathname,
-                        );
-                        copyFileSync(mapping.source.absolute, destination);
-                        log.debug(`  ==> ${destination}`);
-                        localFiles.push(destination);
-                    }
-                } catch (err) {
-                    // throw new Error(`Failed to zip JavaScripts: ${err.message}`);
-                }
-            }
-            localHash = await hash.files(localFiles);
-        } catch (err) {
-            throw new Error(
-                `Unable to hash local files for comparison: ${err.message}`,
-            );
-        }
-
-        log.debug(`Comparing hashes:`);
-        log.debug(`  ==> local: ${localHash}`);
-        log.debug(`  ==> remote: ${integrityHash}`);
-        const same = hash.compare(integrityHash, localHash);
-
-        if (same) {
-            throw new Error(
-                `The current version of this package already contains these files, version change is not needed.`,
-            );
-        }
-
-        log.debug(`Incrementing by "${level}" level`);
-        const newVersion = semver.inc(version, level);
-        log.debug(`  ==> ${newVersion}`);
-        return newVersion;
-    }
+	/**
+	 * @param {VersionOptions} options
+	 */
+	constructor({
+		logger,
+		server,
+		type = "package",
+		name,
+		version,
+		level = "patch",
+		cwd,
+		map = [],
+		out = "./.eik",
+		files,
+	}) {
+		const config = new EikConfig(
+			{
+				server,
+				type,
+				name,
+				version,
+				"import-map": map,
+				out,
+				files,
+			},
+			null,
+			cwd,
+		);
+
+		this.log = abslog(logger);
+		this.config = config;
+		this.path = isAbsolute(config.out) ? config.out : join(cwd, config.out);
+		this.level = level;
+	}
+
+	/**
+	 * Similar to `npm version`, but updates `eik.json`
+	 * @returns {Promise<string | null>} The new version number, or null if the versioning failed
+	 */
+	async run() {
+		const { name, server, type, version, cwd, out, files, map } = this.config;
+		const { log, level, path } = this;
+		log.debug("Validating input");
+
+		log.debug(`  ==> config object`);
+		this.config.validate();
+
+		log.debug(`  ==> cwd: ${cwd}`);
+		parse(cwd);
+
+		log.debug(`  ==> level: ${level}`);
+		if (!["major", "minor", "patch"].includes(level)) {
+			// @ts-expect-error
+			throw new schemas.ValidationError('Parameter "version" is not valid');
+		}
+
+		log.debug(`  ==> files: ${JSON.stringify(files)}`);
+		if (!files) {
+			// @ts-expect-error
+			throw new schemas.ValidationError('Parameter "files" is not valid');
+		}
+
+		log.debug(`  ==> map: ${JSON.stringify(map)}`);
+		if (!Array.isArray(map)) {
+			// @ts-expect-error
+			throw new schemas.ValidationError('Parameter "map" is not valid');
+		}
+
+		log.debug("Checking local package version");
+		log.debug(`Current local package version determined to be ${version}`);
+		log.debug(`Fetching remote package metadata from ${server}`);
+
+		let integrityHash;
+		try {
+			integrityHash = await integrity(server, typeSlug(type), name, version);
+		} catch (err) {
+			throw new Error(
+				`Unable to fetch package metadata from server: ${err.message}`,
+			);
+		}
+
+		if (!integrityHash) {
+			// version does not exist on server yet. No increment needed.
+			throw new Error(
+				`The current version of this package has not yet been published, version change is not needed.`,
+			);
+		}
+
+		log.debug("Hashing local files for comparison with server");
+
+		let localHash;
+		try {
+			makeDirectorySync(path);
+			const eikPathDest = join(path, "eik.json");
+			const eikJSON = {
+				name,
+				server,
+				files,
+				"import-map": map,
+				out,
+			};
+			writeFileSync(eikPathDest, JSON.stringify(eikJSON, null, 2));
+
+			const localFiles = [eikPathDest];
+			log.debug(`  ==> ${eikPathDest}`);
+
+			if (files) {
+				try {
+					const mappings = await this.config.mappings();
+
+					for (const mapping of mappings) {
+						const destination = join(path, mapping.destination.filePathname);
+						copyFileSync(mapping.source.absolute, destination);
+						log.debug(`  ==> ${destination}`);
+						localFiles.push(destination);
+					}
+				} catch (err) {
+					// throw new Error(`Failed to zip JavaScripts: ${err.message}`);
+				}
+			}
+			localHash = await hash.files(localFiles);
+		} catch (err) {
+			throw new Error(
+				`Unable to hash local files for comparison: ${err.message}`,
+			);
+		}
+
+		log.debug(`Comparing hashes:`);
+		log.debug(`  ==> local: ${localHash}`);
+		log.debug(`  ==> remote: ${integrityHash}`);
+		const same = hash.compare(integrityHash, localHash);
+
+		if (same) {
+			throw new Error(
+				`The current version of this package already contains these files, version change is not needed.`,
+			);
+		}
+
+		log.debug(`Incrementing by "${level}" level`);
+		const newVersion = semver.inc(version, level);
+		log.debug(`  ==> ${newVersion}`);
+		return newVersion;
+	}
 }

package/commands/alias.js

@@ -1,105 +1,71 @@
-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 Alias from "../classes/alias.js";
+import { Alias as AliasFormatter } from "../formatters/index.js";
+import { commandHandler } from "../utils/command-handler.js";
 
-export const command = 'alias [name] [version] [alias]';
+export const command = "alias [name] [version] [alias]";
 
-export const aliases = ['a'];
+export const aliases = ["a"];
 
-export const describe = `Create or update a semver major alias for a package, NPM package or import map as identified by its name and version. A package with the given name and version must already exist on the Eik server. The 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. The alias type (npm, map, package) is detected from eik.json in the current working directory.`;
+export const describe =
+	"Create or update a semver major alias for a package or map";
 
+/** @type {import('yargs').CommandBuilder} */
 export const builder = (yargs) => {
-    const defaults = getDefaults(yargs.argv.config || yargs.argv.cwd);
-
-    yargs
-        .positional('name', {
-            describe: 'Name matching a package or import map on the Eik server',
-            type: 'string',
-            // @ts-expect-error
-            default: defaults.name,
-        })
-        .positional('version', {
-            describe: 'The version the alias should redirect to',
-            type: 'string',
-            // @ts-expect-error
-            default: defaults.version,
-        })
-        .positional('alias', {
-            describe:
-                'Alias, should be the semver major component of version. Eg. 1.0.0 should be given the alias 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,
-        },
-        type: {
-            describe:
-                'Alter the alias type. Default is detected from eik.json. Valid values are `package`, `npm`, or `map` Eg. --type npm',
-            // @ts-expect-error
-            default: defaults.type,
-        },
-        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 alias my-app 1.0.0 1`);
-    yargs.example(`eik alias my-app 1.7.3 1`);
-    yargs.example(`eik alias my-app 6.3.1 6`);
-    yargs.example(
-        `eik alias my-app 6.3.1 6 --server https://assets.myeikserver.com`,
-    );
-    yargs.example(`eik alias my-app 4.2.2 4 --debug`);
-    yargs.example(`eik alias my-app 4.2.2 4 --type package`);
+	return yargs
+		.positional("name", {
+			describe: "Name matching a package or import map on the Eik server",
+			type: "string",
+		})
+		.positional("version", {
+			describe: "The version the alias should redirect to",
+			type: "string",
+		})
+		.positional("alias", {
+			describe:
+				"Alias, should be the semver major component of version. Eg. 1.0.0 should be given the alias 1",
+			type: "string",
+		})
+		.options({
+			server: {
+				alias: "s",
+				describe: "Eik server address, if different from configuration file",
+			},
+			type: {
+				describe:
+					"Alter the alias type. Default is detected from eik.json. Valid values are `package`, `npm`, 'image', or `map` Eg. --type npm",
+			},
+			token: {
+				describe: "JWT used for authentication, if not using eik login",
+				alias: "t",
+			},
+		})
+		.example("eik alias my-app 1.0.0 1")
+		.example("eik alias my-app 1.7.3 1")
+		.example("eik alias my-app 6.3.1 6 --server https://assets.myeikserver.com")
+		.example("eik alias my-app 6.3.1 6 --token yourtoken")
+		.example("eik alias my-app 4.2.2 4 --type package");
 };
 
-export const handler = async (argv) => {
-    const spinner = ora({ stream: process.stdout }).start('working...');
-    let success = false;
-    const { debug, server, type } = argv;
-    const log = logger(spinner, debug);
-    let af;
-
-    try {
-        const data = await new Alias({
-            type,
-            logger: log,
-            ...argv,
-        }).run();
+export const handler = commandHandler(
+	{ command, options: ["server", "type"] },
+	async (argv, log) => {
+		const { debug, server, type, ...rest } = argv;
+		const data = await new Alias({
+			type,
+			server,
+			logger: log,
+			...rest,
+		}).run();
 
-        // TODO: get rid of this rediculous formatter class idea that past me put here to irk present and future me.
-        // Smells like DRY silliness
-        af = new AliasFormatter(data);
+		// TODO: get rid of this rediculous formatter class idea that past me put here to irk present and future me.
+		// Smells like DRY silliness
+		const af = new AliasFormatter(data);
 
-        const createdOrUpdated = data.update ? 'Updated' : 'Created';
-        log.info(
-            `${createdOrUpdated} alias for "${type}" "${data.name}". ("${data.version}" => "v${data.alias}")`,
-        );
-        success = true;
-    } catch (err) {
-        log.warn(err.message);
-    }
+		const createdOrUpdated = data.update ? "Updated" : "Created";
+		log.info(
+			`${createdOrUpdated} alias for "${type}" "${data.name}". ("${data.version}" => "v${data.alias}")`,
+		);
 
-    spinner.text = '';
-    spinner.stopAndPersist();
-    if (success) {
-        af?.format(server);
-    } else {
-        process.exit(1);
-    }
-};
+		af.format(server);
+	},
+);