@eik/cli 3.1.4 → 3.1.5

package/commands/publish.js

@@ -1,63 +1,63 @@
 import { join } from "path";
-import ora from "ora";
 import chalk from "chalk";
 import PublishPackage from "../classes/publish/package/index.js";
-import { logger, getDefaults, typeSlug, typeTitle } from "../utils/index.js";
+import { typeSlug, typeTitle } from "../utils/index.js";
 import { Artifact } from "../formatters/index.js";
+import { EikCliError, errors } from "../utils/error.js";
+import { commandHandler } from "../utils/command-handler.js";
 
 export const command = "publish";
 
 export const aliases = ["pkg", "package", "pub"];
 
-export const describe = `Publish an app package to an Eik server. Reads configuration from eik.json or package.json files. See https://eik.dev for more details.`;
+export const describe = "Publish an app package to an Eik server";
 
+/** @type {import('yargs').CommandBuilder} */
 export const builder = (yargs) => {
-	const defaults = getDefaults(yargs.argv.config || yargs.argv.cwd);
-
-	yargs.options({
-		dryRun: {
-			alias: "d",
-			describe:
-				"Terminates the publish early (before upload) and provides information about created bundles for inspection.",
-			default: false,
-			type: "boolean",
-		},
-		token: {
-			describe: `Provide a jwt token to be used to authenticate with the Eik server. Automatically determined if authenticated (via eik login)`,
-			type: "string",
-			alias: "t",
-		},
-	});
-
-	// @ts-expect-error
-	yargs.default("token", defaults.token, defaults.token ? "######" : "");
-
-	yargs.example(`eik publish`);
-	yargs.example(`eik package`);
-	yargs.example(`eik pub --dry-run`);
-	yargs.example(`eik pkg --token ######`);
-	yargs.example(`eik pkg --debug`);
+	return yargs
+		.options({
+			dryRun: {
+				alias: "d",
+				describe: "Log details about the operation and skip upload",
+				type: "boolean",
+			},
+			token: {
+				describe: "JWT used for authentication, if not using eik login",
+				type: "string",
+				alias: "t",
+			},
+		})
+		.example("eik publish")
+		.example("eik publish --dry-run")
+		.example("eik publish --token yourtoken");
 };
 
-export const handler = async (argv) => {
-	const spinner = ora({ stream: process.stdout }).start("working...");
-	const { debug, dryRun, cwd, token, config } = argv;
-	// @ts-expect-error
-	const { name, version, server, map, out, files, type } = getDefaults(
-		config || cwd,
-	);
-
-	if (type === "map") {
-		spinner.warn(
-			'"type" is set to "map", which is not supported by the publish command. Please use the "eik map" command instead',
-		);
-		process.stdout.write("\n");
-		process.exit(0);
-	}
-
-	try {
+export const handler = commandHandler(
+	{ command, options: ["server"] },
+	async (argv, log, spinner) => {
+		const {
+			debug,
+			dryRun,
+			cwd,
+			token,
+			name,
+			version,
+			server,
+			map,
+			out,
+			files,
+			type,
+		} = argv;
+
+		if (type === "map") {
+			throw new EikCliError(
+				errors.ERR_WRONG_TYPE,
+				'"type" is set to "map", which is not supported by the publish command. Please use the "eik map" command instead',
+			);
+		}
+
 		const options = {
-			logger: logger(spinner, debug),
+			logger: log,
 			cwd,
 			token,
 			dryRun,
@@ -74,11 +74,10 @@ export const handler = async (argv) => {
 		const publish = await new PublishPackage(options).run();
 
 		if (!publish) {
-			spinner.warn(
+			throw new EikCliError(
+				errors.ERR_VERSION_EXISTS,
 				"Version in eik.json has not changed since last publish, publishing is not necessary",
 			);
-			process.stdout.write("\n");
-			process.exit(0);
 		}
 
 		const { files: fls } = publish;
@@ -121,10 +120,5 @@ export const handler = async (argv) => {
 				`   ${chalk.bold("No files were published to remote server")}\n\n`,
 			);
 		}
-	} catch (err) {
-		spinner.warn(err.message);
-		spinner.text = "";
-		spinner.stopAndPersist();
-		process.exit(1);
-	}
-};
+	},
+);

package/commands/version.js

@@ -1,44 +1,40 @@
 import { execSync } from "child_process";
 import { join } from "path";
-import ora from "ora";
 import VersionPackage from "../classes/version.js";
-import { logger, getDefaults } from "../utils/index.js";
 import json from "../utils/json/index.js";
+import { EikCliError, errors } from "../utils/error.js";
+import { commandHandler } from "../utils/command-handler.js";
 
 export const command = "version [level]";
 
-export const describe = `Compares local files with files on server and increments "version" field in eik.json if necessary.`;
+export const describe =
+	'Compare local files with files on server and increment "version" field if different';
 
+/** @type {import('yargs').CommandBuilder} */
 export const builder = (yargs) => {
-	yargs.positional("level", {
-		describe: "Semver level to increment version by",
-		default: "patch",
-		type: "string",
-		choices: ["major", "minor", "patch"],
-	});
-
-	yargs.options({
-		dryRun: {
-			alias: "d",
-			describe:
-				"Terminates the publish early (before upload) and provides information about created bundles for inspection.",
-			default: false,
-			type: "boolean",
-		},
-	});
-
-	yargs.example(`eik version`);
-	yargs.example(`eik version minor`);
+	return yargs
+		.positional("level", {
+			describe: "Semver level to increment version by",
+			default: "patch",
+			type: "string",
+			choices: ["major", "minor", "patch"],
+		})
+		.options({
+			dryRun: {
+				alias: "d",
+				describe: "Log details about the operation and skip upload",
+				type: "boolean",
+			},
+		})
+		.example("eik version")
+		.example("eik version minor")
+		.example("eik version --dry-run");
 };
 
-export const handler = async (argv) => {
-	const spinner = ora({ stream: process.stdout }).start("working...");
-	const { level, debug, dryRun, cwd, config } = argv;
-	// @ts-expect-error
-	const { name, version, server, map, out, files } = getDefaults(config || cwd);
-
-	try {
-		const log = logger(spinner, debug);
+export const handler = commandHandler(
+	{ command, options: ["server"] },
+	async (argv, log) => {
+		const { level, dryRun, cwd, name, version, server, map, out, files } = argv;
 
 		const options = {
 			logger: log,
@@ -68,8 +64,10 @@ export const handler = async (argv) => {
 				execSync(`git add ${join(cwd, "eik.json")}`);
 				log.debug(`  ==> stage: ${join(cwd, "eik.json")}`);
 			} catch (err) {
-				throw new Error(
+				throw new EikCliError(
+					errors.ERR_NOT_GIT,
 					'Failed to stage file "eik.json". Is this directory (or any parent directories) a git repository?',
+					err,
 				);
 			}
 
@@ -90,16 +88,12 @@ export const handler = async (argv) => {
 
 				log.info(`New version ${newVersion} written back to eik.json`);
 			} catch (err) {
-				throw new Error('Failed to commit changes to file "eik.json".');
+				throw new EikCliError(
+					errors.ERR_GIT_COMMIT,
+					'Failed to commit changes to file "eik.json".',
+					err,
+				);
 			}
 		}
-
-		spinner.text = "";
-		spinner.stopAndPersist();
-		process.exit();
-	} catch (err) {
-		spinner.warn(err.message);
-		spinner.text = "";
-		spinner.stopAndPersist();
-	}
-};
+	},
+);

package/index.js

@@ -1,84 +1,88 @@
 #!/usr/bin/env node
-import chalk from "chalk";
 import yargs from "yargs";
 import { hideBin } from "yargs/helpers";
-import boxen from "boxen";
 import { join } from "path";
 import { readFileSync } from "fs";
 import { fileURLToPath } from "url";
 import { dirname } from "path";
-import { commands } from "./commands/index.js";
+
+import * as alias from "./commands/alias.js";
+import * as init from "./commands/init.js";
+import * as integrity from "./commands/integrity.js";
+import * as login from "./commands/login.js";
+import * as mapAlias from "./commands/map-alias.js";
+import * as map from "./commands/map.js";
+import * as meta from "./commands/meta.js";
+import * as npmAlias from "./commands/npm-alias.js";
+import * as packageAlias from "./commands/package-alias.js";
+import * as ping from "./commands/ping.js";
+import * as publish from "./commands/publish.js";
+import * as version from "./commands/version.js";
 
 const __filename = fileURLToPath(import.meta.url);
 const __dirname = dirname(__filename);
 
-const { version } = JSON.parse(
+const { version: cliVersion } = JSON.parse(
 	readFileSync(join(__dirname, "./package.json"), { encoding: "utf-8" }),
 );
 
-// short circuit and provide a -v and --version flag
+// Short circuit and provide a -v and --version flag.
+// It's a known limitation in yargs that you can't have both a command
+// and an option named version https://github.com/yargs/yargs/issues/2064
+// We use the version name as a command in yargs, so handle the version
+// option before using yargs.
 if (
 	process.argv.includes("-v") ||
 	// last position only to avoid conflict with publish command
 	process.argv[process.argv.length - 1].includes("--version")
 ) {
-	console.log(version);
+	console.log(cliVersion);
 	process.exit(0);
 }
 
-const greeting = chalk.white.bold(`Eik CLI (v${version})`);
-
-const boxenOptions = {
-	padding: 1,
-	margin: 1,
-	borderStyle: "round",
-	borderColor: "green",
-	backgroundColor: "#555555",
-};
-// @ts-expect-error
-const msgBox = boxen(greeting, boxenOptions);
-
-console.log(msgBox);
-
 yargs(hideBin(process.argv))
+	.scriptName("eik")
+	// inspired by git
+	.usage(
+		`usage: $0 [-v | --version] [-h | --help] [-c <path> | --config <path>]
+           [--cwd <path>] [--debug] <command> [<args>]`,
+	)
+	.epilogue(
+		`Run $0 <command> --help to read more about a specific subcommand.
+
+For a more detailed description of commands and options, see the reference documentation:
+  https://eik.dev/cli`,
+	)
 	.options({
 		config: {
 			alias: "c",
-			describe:
-				"Provide an exact path to an eik.json or package.json file to use as config. Default is eik.json in the current working directory.",
+			describe: "Path to Eik configuration file (eik.json or package.json)",
 		},
 		cwd: {
-			describe: "Alter the current working directory.",
-			default: process.cwd(),
+			describe: "Path to a different working directory than the current",
 		},
 		debug: {
-			describe: "Logs additional messages",
-			default: false,
+			describe: "Show additional logs",
 			type: "boolean",
 		},
 	})
-	// @ts-expect-error
-	.example("eik init")
-	// @ts-expect-error
-	.example("eik login --server https://assets.myserver.com --key ######")
-	// @ts-expect-error
-	.example("eik publish")
-	// @ts-expect-error
-	.example("eik meta my-app --server https://assets.myserver.com")
-	.example(
-		// @ts-expect-error
-		"eik npm-alias lit-html 1.0.0 1 --server https://assets.myserver.com --token ######",
-	)
-	.example(
-		// @ts-expect-error
-		"eik map my-map 1.0.0 ./import-map.json --server https://assets.myserver.com --token ######",
-	)
-	// @ts-expect-error
-	.example("eik map-alias my-map 1.0.0 1")
-	// @ts-expect-error
-	.command(commands)
+	.command([
+		alias,
+		init,
+		integrity,
+		login,
+		map,
+		mapAlias,
+		meta,
+		npmAlias,
+		packageAlias,
+		ping,
+		publish,
+		version,
+	])
 	.demandCommand()
-	.wrap(150)
-	.version(false)
+	.wrap(null)
+	.version(false) // Turn off the built-in version option to not conflict with the version command
 	.help()
+	.alias("h", "help")
 	.parse();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eik/cli",
-  "version": "3.1.4",
+  "version": "3.1.5",
   "description": "CLI tool for publishing assets to an Eik server",
   "main": "./classes/index.js",
   "types": "./types/classes/index.d.ts",
@@ -21,7 +21,7 @@
   ],
   "scripts": {
     "clean": "rimraf .tap node_modules types",
-    "test": "cross-env HTTP_PORT=0 LOG_LEVEL=fatal tap --timeout 0 --disable-coverage test/**/*.test.mjs",
+    "test": "cross-env HTTP_PORT=0 LOG_LEVEL=fatal tap --timeout 0 --disable-coverage",
     "test:integration": "cross-env HTTP_PORT=0 LOG_LEVEL=fatal tap --timeout 0 --disable-coverage test/integration/**/*.test.mjs",
     "test:unit": "cross-env HTTP_PORT=0 LOG_LEVEL=fatal tap --timeout 0 --disable-coverage test/*.test.mjs",
     "test:tasks": "cross-env HTTP_PORT=0 LOG_LEVEL=fatal tap --timeout 0 --disable-coverage test/tasks/*.test.mjs",
@@ -40,7 +40,6 @@
   "dependencies": {
     "@eik/common": "4.1.1",
     "abslog": "2.4.4",
-    "boxen": "8.0.1",
     "bytes": "3.1.2",
     "chalk": "5.3.0",
     "date-fns": "3.6.0",
@@ -62,6 +61,7 @@
     "@eik/service": "2.3.1",
     "@eik/sink-memory": "1.1.2",
     "@eik/typescript-config": "1.0.0",
+    "@types/yargs": "17.0.33",
     "cross-env": "7.0.3",
     "eslint": "9.8.0",
     "fastify": "4.28.1",

package/readme.md

@@ -18,4 +18,4 @@ eik --version
 
 ## Usage
 
-See [the CLI reference documentation](https://eik.dev/docs/reference/at-eik-cli) to learn about the available commands.
+See [the CLI reference documentation](https://eik.dev/cli) to learn about the available commands.

package/types/classes/alias.d.ts

@@ -2,7 +2,7 @@
  * @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
@@ -40,7 +40,7 @@ export default class Alias {
 export type AliasOptions = {
     logger?: import("abslog").AbstractLoggerOptions;
     server: string;
-    type?: "package" | "npm" | "map";
+    type?: "package" | "npm" | "image" | "map";
     name: string;
     version: string;
     alias: string;

package/types/utils/defaults.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Get defaults for things like server, name and version from Eik config.
+ * If a specific argument is given for it, that takes precedence.
+ * @template [T=Record<string, unknown>]
+ * @param {any} argv
+ * @param {{ command: string; options?: string[] }} opts
+ * @returns {import('@eik/common').EikConfig & typeof defaults & T}
+ */
+export function getArgsOrDefaults<T = Record<string, unknown>>(argv: any, opts: {
+    command: string;
+    options?: string[];
+}): import("@eik/common").EikConfig & typeof defaults & T;
+declare const defaults: {
+    name: string;
+    type: string;
+    version: string;
+    server: string;
+    out: string;
+    files: string;
+    "import-map": any[];
+};
+export {};

package/types/utils/error.d.ts

@@ -0,0 +1,19 @@
+export namespace errors {
+    let ERR_MISSING_CONFIG: string;
+    let ERR_WRONG_TYPE: string;
+    let ERR_VERSION_EXISTS: string;
+    let ERR_NOT_GIT: string;
+    let ERR_GIT_COMMIT: string;
+}
+export class EikCliError extends Error {
+    /**
+     * @param {string} errorCode
+     * @param {string} message
+     * @param {Error} [cause]
+     */
+    constructor(errorCode: string, message: string, cause?: Error);
+    cause: Error;
+    get errorCode(): string;
+    get exitCode(): number;
+    #private;
+}

package/types/utils/index.d.ts

@@ -1,6 +1,6 @@
 import logger from "./logger.js";
-export const getDefaults: typeof helpers.getDefaults;
+import { getArgsOrDefaults } from "./defaults.js";
 export const typeSlug: typeof helpers.typeSlug;
 import typeTitle from "./type-title.js";
 import { helpers } from "@eik/common";
-export { logger, typeTitle };
+export { logger, getArgsOrDefaults, typeTitle };

package/utils/command-handler.js

@@ -0,0 +1,72 @@
+import ora from "ora";
+import logger from "./logger.js";
+import { EikCliError } from "./error.js";
+import { getArgsOrDefaults } from "./defaults.js";
+
+/**
+ * @typedef {ReturnType<import('./defaults.js').getArgsOrDefaults>} Argv
+ * @typedef {ReturnType<import('./logger.js').default>} Logger
+ * @typedef {import('ora').Ora} Spinner
+ */
+
+/**
+ * @template [T=Record<string, unknown>]
+ * @callback HandlerFunction
+ * @param {Argv & T} argv
+ * @param {Logger} log
+ * @param {Spinner} spinner Can we remove this?
+ * @returns {Promise<void>}
+ */
+
+/**
+ * @param {{ command: string; options?: string[] }} opts
+ * @param {HandlerFunction} handlerFunction
+ * @returns {import('yargs').CommandModule["handler"]}
+ */
+export function commandHandler(opts, handlerFunction) {
+	return async (argv) => {
+		const spinner = ora({ stream: process.stdout }).start();
+		const log = logger(spinner, argv.debug);
+
+		try {
+			const args = getArgsOrDefaults(argv, opts);
+
+			if (argv.debug) {
+				log.debug(`command inputs:
+${JSON.stringify(args, null, 2)}`);
+			}
+
+			await handlerFunction(args, log, spinner);
+
+			spinner.text = "";
+			spinner.stopAndPersist();
+		} catch (e) {
+			if (e instanceof EikCliError) {
+				log.error(e.message);
+
+				if (argv.debug) {
+					log.debug(e.stack);
+					if (e.cause) {
+						log.debug(`Caused by ${e.cause.message}`);
+						log.debug(e.cause.stack);
+					}
+				}
+
+				spinner.text = "";
+				spinner.stopAndPersist();
+				return process.exit(e.exitCode);
+			}
+
+			const error = /** @type {Error} */ (e);
+			log.error(`${error.name}: ${error.message}`);
+
+			if (argv.debug) {
+				log.debug(error.stack);
+			}
+
+			spinner.text = "";
+			spinner.stopAndPersist();
+			process.exit(1);
+		}
+	};
+}

package/utils/defaults.js

@@ -0,0 +1,79 @@
+import fs from "fs";
+import { join, isAbsolute } from "path";
+import { helpers } from "@eik/common";
+import { EikCliError, errors } from "./error.js";
+
+const defaults = {
+	name: "",
+	type: "package",
+	version: "1.0.0",
+	server: "",
+	out: "./.eik",
+	files: "./public",
+	"import-map": [],
+};
+
+/**
+ * Get defaults for things like server, name and version from Eik config.
+ * If a specific argument is given for it, that takes precedence.
+ * @template [T=Record<string, unknown>]
+ * @param {any} argv
+ * @param {{ command: string; options?: string[] }} opts
+ * @returns {import('@eik/common').EikConfig & typeof defaults & T}
+ */
+export function getArgsOrDefaults(argv, opts) {
+	let { cwd, config: configPath } = argv;
+	if (!cwd) {
+		cwd = process.cwd();
+	}
+
+	let config = {};
+	if (!opts.command.startsWith("init")) {
+		let path = cwd;
+		if (configPath) {
+			path = isAbsolute(configPath) ? configPath : join(cwd, configPath);
+		}
+		try {
+			const stats = fs.statSync(path);
+			if (stats.isDirectory()) {
+				config = helpers.configStore.findInDirectory(path).toJSON();
+			} else {
+				config = helpers.configStore.loadFromPath(path).toJSON();
+			}
+		} catch (error) {
+			const e = /** @type {Error} */ (error);
+			if (e.constructor.name === "MissingConfigError") {
+				if (!hasOptionsOnArgv(argv, opts.options)) {
+					throw new EikCliError(
+						errors.ERR_MISSING_CONFIG,
+						`No eik.json or package.json with eik configuration in ${cwd}, and did not get required fields as options`,
+						error,
+					);
+				}
+			}
+		}
+	}
+
+	const result = {
+		...defaults,
+		...config,
+		...argv,
+		cwd,
+	};
+
+	return result;
+}
+
+/**
+ * @param {any} argv
+ * @param {string[]} options
+ * @returns {boolean}
+ */
+function hasOptionsOnArgv(argv, options = []) {
+	for (const arg of options) {
+		if (typeof argv[arg] === "undefined") {
+			return false;
+		}
+	}
+	return true;
+}