@eik/cli 3.1.4 → 3.1.5

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+## [3.1.5](https://github.com/eik-lib/cli/compare/v3.1.4...v3.1.5) (2024-08-29)
+
+
+### Bug Fixes
+
+* handle relative and absolute paths to config, improve error messages, edit help for brevity ([06e9951](https://github.com/eik-lib/cli/commit/06e9951a6efe6b3f37600f6f0477417e708dcf08))
+
 ## [3.1.4](https://github.com/eik-lib/cli/compare/v3.1.3...v3.1.4) (2024-08-26)
 
 

package/classes/alias.js

@@ -9,7 +9,7 @@ import { joinUrlPathname } from "../utils/url.js";
  * @typedef {object} AliasOptions
  * @property {import('abslog').AbstractLoggerOptions} [logger]
  * @property {string} server
- * @property {"package" | "npm" | "map"} [type="package"]
+ * @property {"package" | "npm" | "image" | "map"} [type="package"]
  * @property {string} name
  * @property {string} version
  * @property {string} alias

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 { commandHandler } from "../utils/command-handler.js";
 
 export const command = "alias [name] [version] [alias]";
 
 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
+	return 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`);
+		})
+		.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 {
+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,
-			...argv,
+			...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);
+		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);
-	}
 
-	spinner.text = "";
-	spinner.stopAndPersist();
-	if (success) {
-		af?.format(server);
-	} else {
-		process.exit(1);
-	}
-};
+		af.format(server);
+	},
+);

package/commands/init.js

@@ -1,115 +1,102 @@
 import { join } from "path";
 import fs from "fs";
-import ora from "ora";
-import { logger } from "../utils/index.js";
+import { commandHandler } from "../utils/command-handler.js";
 
 const command = "init";
 
 const aliases = ["i"];
 
-const describe = `Creates an eik.json file and saves it to the current working directory. If package.json exists in the directory its name and version will be used as the default. Override defaults using command line flags.`;
+const describe = "Create an eik.json file";
 
+/** @type {import('yargs').CommandBuilder} */
 const builder = (yargs) => {
-	yargs.example("eik init");
-	yargs.example("eik init --cwd /path/to/dir");
-	yargs.example(
-		'eik init --server https://assets.myserver.com --version 2.0.0 --name my-app --files "./public"',
-	);
-	yargs.example("eik init --debug");
-
-	yargs.options({
-		server: {
-			alias: "s",
-			describe: `Specify asset server field in "eik.json". This the URL to an Eik asset server Eg. --server https://assets.myeikserver.com`,
-			default: "",
-		},
-		version: {
-			alias: "v",
-			describe: `Specify the semver version field in "eik.json". Eg. --version 1.0.0`,
-			default: "1.0.0",
-		},
-		name: {
-			alias: "n",
-			describe: `Specify the app name field in "eik.json".
-                Eg. --name my-great-app`,
-			default: "",
-		},
-	});
+	return yargs
+		.options({
+			server: {
+				alias: "s",
+				describe: "Eik server address, if different from configuration file",
+			},
+			version: {
+				alias: "v",
+				describe:
+					'Specify the semver version field in "eik.json". Eg. --version 1.0.0',
+				default: "1.0.0",
+			},
+			name: {
+				alias: "n",
+				describe:
+					'Specify the app name field in "eik.json". Eg. --name my-great-app',
+			},
+		})
+		.example("eik init")
+		.example(
+			"eik init --server https://assets.myserver.com --version 2.0.0 --name my-app",
+		);
 };
 
-const handler = async (argv) => {
-	let { name, version } = argv;
-	const { server, cwd, debug } = argv;
-	const pathname = join(cwd, "./eik.json");
+const handler = commandHandler({ command }, async (argv, log) => {
+	let { cwd, server, name, version } = argv;
 
-	const spinner = ora({ stream: process.stdout }).start("working...");
-	const log = logger(spinner, debug);
+	const pathname = join(cwd, "./eik.json");
+	log.debug(`Checking for existing ${pathname}`);
 
+	let eikJsonExists = false;
 	try {
-		log.debug(`Checking for existing ${pathname}`);
+		const st = fs.statSync(pathname);
+		if (st.isFile()) {
+			eikJsonExists = true;
+		}
+	} catch (err) {
+		// noop
+	}
+	if (eikJsonExists) {
+		throw new Error(
+			`An "eik.json" file already exists in directory. File will not be written`,
+		);
+	}
 
-		let eikJsonExists = false;
+	if (!name || !version || version === "1.0.0") {
+		log.debug("Looking for default from package.json");
 		try {
-			const st = fs.statSync(pathname);
-			if (st.isFile()) {
-				eikJsonExists = true;
+			let packageJson = fs.readFileSync(join(cwd, "package.json"), "utf-8");
+			packageJson = JSON.parse(packageJson);
+			if (!name) {
+				name = packageJson.name;
+				log.debug(`Using ${name} from package.json as default name`);
 			}
-		} catch (err) {
-			// noop
-		}
-		if (eikJsonExists) {
-			throw new Error(
-				`An "eik.json" file already exists in directory. File will not be written`,
-			);
-		}
-
-		if (!name || !version || version === "1.0.0") {
-			log.debug("Looking for default from package.json");
-			try {
-				let packageJson = fs.readFileSync(join(cwd, "package.json"), "utf-8");
-				packageJson = JSON.parse(packageJson);
-				if (!name) {
-					name = packageJson.name;
-					log.debug(`Using ${name} from package.json as default name`);
-				}
-				if (!version || version === "1.0.0") {
-					version = packageJson.version;
-					log.debug(`Using ${version} from package.json as default version`);
-				}
-			} catch (e) {
-				// noop
+			if (!version || version === "1.0.0") {
+				version = packageJson.version;
+				log.debug(`Using ${version} from package.json as default version`);
 			}
-		} else {
-			log.debug(`Got ${name} and ${version}, skipping package.json`);
+		} catch (e) {
+			// noop
 		}
+	} else {
+		log.debug(`Got ${name} and ${version}, skipping package.json`);
+	}
 
-		log.debug(`Writing to ${pathname}`);
-
-		const output = JSON.stringify(
-			{
-				$schema:
-					"https://raw.githubusercontent.com/eik-lib/common/main/lib/schemas/eikjson.schema.json",
-				name,
-				version,
-				server,
-				files: "./public",
-				"import-map": [],
-			},
-			null,
-			2,
-		);
-		fs.writeFileSync(pathname, output);
+	log.debug(`Writing to ${pathname}`);
+
+	const output = JSON.stringify(
+		{
+			$schema:
+				"https://raw.githubusercontent.com/eik-lib/common/main/lib/schemas/eikjson.schema.json",
+			name,
+			version,
+			server,
+			files: "./public",
+			"import-map": [],
+		},
+		null,
+		2,
+	);
+	fs.writeFileSync(pathname, output);
 
-		log.info(`Wrote to ${pathname}
+	log.info(`Wrote to ${pathname}
 
 ${output}
 
 Read more about configuring Eik on https://eik.dev/docs/reference/eik-json`);
-	} catch (err) {
-		log.warn(err.message);
-	}
-	spinner.text = "";
-	spinner.stopAndPersist();
-};
+});
 
 export { command, aliases, describe, builder, handler };

package/commands/integrity.js

@@ -1,42 +1,34 @@
 import { join } from "path";
-import ora from "ora";
 import Integrity from "../classes/integrity.js";
-import { logger, getDefaults } from "../utils/index.js";
 import json from "../utils/json/index.js";
+import { commandHandler } from "../utils/command-handler.js";
 
 export const command = "integrity [name] [version]";
 
 export const aliases = ["int"];
 
-export const describe = `Retrieve file integrity information for package name and version defined in eik.json, then populate integrity.json file with this information`;
+export const describe = "Get file integrity information";
 
+/** @type {import('yargs').CommandBuilder} */
 export const builder = (yargs) => {
-	const defaults = getDefaults(yargs.argv.config || yargs.argv.cwd);
-
-	yargs.options({
-		server: {
-			alias: "s",
-			describe: "Specify location of asset server.",
-			// @ts-expect-error
-			default: defaults.server,
-		},
-	});
-
-	yargs.example(`eik integrity`);
-	yargs.example(`eik integrity --debug`);
+	return yargs
+		.options({
+			server: {
+				alias: "s",
+				describe: "Eik server address, if different from configuration file",
+			},
+		})
+		.example("eik integrity")
+		.example("eik integrity --server https://assets.myserver.com");
 };
 
-export const handler = async (argv) => {
-	const spinner = ora({ stream: process.stdout }).start("working...");
-	let integrity = false;
-	const { debug, cwd, config } = argv;
-	const l = logger(spinner, debug);
-	// @ts-expect-error
-	const { name, version, server, out, type } = getDefaults(config || cwd);
+export const handler = commandHandler(
+	{ command, options: ["server"] },
+	async (argv, log, spinner) => {
+		const { name, version, server, out, type, cwd, debug } = argv;
 
-	try {
-		integrity = await new Integrity({
-			logger: l,
+		const integrity = await new Integrity({
+			logger: log,
 			name,
 			version,
 			server,
@@ -53,10 +45,5 @@ export const handler = async (argv) => {
 			);
 			process.stdout.write("\n");
 		}
-	} catch (err) {
-		spinner.text = "";
-		spinner.stopAndPersist();
-		l.warn(err.message);
-		process.exit(1);
-	}
-};
+	},
+);

package/commands/login.js

@@ -1,9 +1,8 @@
 import os from "os";
 import readline from "readline";
-import ora from "ora";
 import Login from "../classes/login.js";
-import { logger, getDefaults } from "../utils/index.js";
 import json from "../utils/json/index.js";
+import { commandHandler } from "../utils/command-handler.js";
 
 const homedir = os.homedir();
 
@@ -11,72 +10,67 @@ export const command = "login";
 
 export const aliases = [];
 
-export const describe = `Authenticate against an Eik server and save the returned token to an .eikrc file in the users home directory. You can specify key and server values to authenticate against using the --key and --server flags which will then bypass login prompts. It is possible to be authenticated against multiple asset servers simultaneously. Simply call "eik login" multiple times.`;
+export const describe = "Log in to an Eik server";
 
+/** @type {import('yargs').CommandBuilder} */
 export const builder = (yargs) => {
-	yargs.example("eik login --server https://assets.myserver.com");
-	yargs.example("eik login --server https://assets.myserver.com --key ######");
-	yargs.example("eik login --server https://assets.myserver.com --debug");
-
-	const defaults = getDefaults(yargs.argv.config || yargs.argv.cwd);
-
-	yargs.options({
-		server: {
-			alias: "s",
-			describe: `Eik server address. Specify location of the Eik asset server to authenticate against. If an eik.json file is present in the current working directory, the files server value will be used as default. If no eik.json file is present in the current working directory and this flag is not specified, a prompt will be presented to ask for the server address to be input. Eg. --server https://assets.myeikserver.com`,
-			type: "string",
-			default: defaults.server,
-		},
-		key: {
-			alias: "k",
-			describe: `Login access key. This is a passkey for a given user account and needs to be configured on the server. If this flag is not specifed, a prompt will be used to ask for the key to be input. Eg. --key ########`,
-			type: "string",
-			default: "",
-		},
-	});
+	return yargs
+		.options({
+			server: {
+				alias: "s",
+				describe: "Eik server address, if different from configuration file",
+				type: "string",
+			},
+			key: {
+				alias: "k",
+				describe: "Login access key",
+				type: "string",
+			},
+		})
+		.example("eik login --server https://assets.myserver.com")
+		.example("eik login --server https://assets.myserver.com --key yourkey");
 };
 
-export const handler = async (argv) => {
-	let success = false;
-	const { debug, key, server } = argv;
-	let k = key;
-	let s = server;
-	let rl = null;
+export const handler = commandHandler(
+	{ command, options: ["server"] },
+	async (argv, logger) => {
+		const { key, server } = argv;
 
-	if (!s || !k) {
-		rl = readline.createInterface({
-			input: process.stdin,
-			output: process.stdout,
-		});
-	}
+		let k = key;
+		let s = server;
+		let rl = null;
 
-	if (!s) {
-		await new Promise((resolve) => {
-			rl?.question("Enter Eik server address > ", (input) => {
-				s = input;
-				// @ts-expect-error
-				resolve();
+		if (!s || !k) {
+			rl = readline.createInterface({
+				input: process.stdin,
+				output: process.stdout,
 			});
-		});
-	}
+		}
 
-	if (!k) {
-		await new Promise((resolve) => {
-			rl?.question(`Enter login key for ${s} > `, (input) => {
-				k = input;
-				// @ts-expect-error
-				resolve();
+		if (!s) {
+			await new Promise((resolve) => {
+				rl?.question("Enter Eik server address > ", (input) => {
+					s = input;
+					// @ts-expect-error
+					resolve();
+				});
 			});
-		});
-	}
+		}
 
-	if (rl) rl.close();
+		if (!k) {
+			await new Promise((resolve) => {
+				rl?.question(`Enter login key for ${s} > `, (input) => {
+					k = input;
+					// @ts-expect-error
+					resolve();
+				});
+			});
+		}
 
-	const spinner = ora({ stream: process.stdout }).start("working...");
+		if (rl) rl.close();
 
-	try {
 		const token = await new Login({
-			logger: logger(spinner, debug),
+			logger,
 			key: k,
 			server: s,
 		}).run();
@@ -91,19 +85,6 @@ export const handler = async (argv) => {
 			meta.tokens = Array.from(tokens);
 
 			await json.write(meta, { cwd: homedir, filename: ".eikrc" });
-			success = true;
 		}
-	} catch (err) {
-		// @ts-expect-error
-		logger.warn(err.message);
-	}
-
-	if (success) {
-		spinner.text = "";
-		spinner.stopAndPersist();
-	} else {
-		spinner.text = "";
-		spinner.stopAndPersist();
-		process.exit(1);
-	}
-};
+	},
+);