@eik/cli 3.1.3 → 3.1.5

package/commands/init.js

@@ -1,122 +1,102 @@
-import { join } from 'path';
-import fs from 'fs';
-import ora from 'ora';
-import { logger } from '../utils/index.js';
+import { join } from "path";
+import fs from "fs";
+import { commandHandler } from "../utils/command-handler.js";
 
-const command = 'init';
+const command = "init";
 
-const aliases = ['i'];
+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 spinner = ora({ stream: process.stdout }).start('working...');
-    const log = logger(spinner, debug);
-
-    try {
-        log.debug(`Checking for existing ${pathname}`);
-
-        let eikJsonExists = false;
-        try {
-            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`,
-            );
-        }
-
-        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
-            }
-        } 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.info(`Wrote to ${pathname}
+const handler = commandHandler({ command }, async (argv, log) => {
+	let { cwd, server, name, version } = argv;
+
+	const pathname = join(cwd, "./eik.json");
+	log.debug(`Checking for existing ${pathname}`);
+
+	let eikJsonExists = false;
+	try {
+		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`,
+		);
+	}
+
+	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
+		}
+	} 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.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,62 +1,49 @@
-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 { join } from "path";
+import Integrity from "../classes/integrity.js";
+import json from "../utils/json/index.js";
+import { commandHandler } from "../utils/command-handler.js";
 
-export const command = 'integrity [name] [version]';
+export const command = "integrity [name] [version]";
 
-export const aliases = ['int'];
+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);
-
-    try {
-        integrity = await new Integrity({
-            logger: l,
-            name,
-            version,
-            server,
-            debug,
-            cwd,
-            type,
-        }).run();
-
-        if (integrity) {
-            const filename = join(out, 'integrity.json');
-            await json.write(integrity, { cwd, filename });
-            spinner.succeed(
-                `integrity information for package "${name}" (v${version}) saved to "${filename}"`,
-            );
-            process.stdout.write('\n');
-        }
-    } catch (err) {
-        spinner.text = '';
-        spinner.stopAndPersist();
-        l.warn(err.message);
-        process.exit(1);
-    }
-};
+export const handler = commandHandler(
+	{ command, options: ["server"] },
+	async (argv, log, spinner) => {
+		const { name, version, server, out, type, cwd, debug } = argv;
+
+		const integrity = await new Integrity({
+			logger: log,
+			name,
+			version,
+			server,
+			debug,
+			cwd,
+			type,
+		}).run();
+
+		if (integrity) {
+			const filename = join(out, "integrity.json");
+			await json.write(integrity, { cwd, filename });
+			spinner.succeed(
+				`integrity information for package "${name}" (v${version}) saved to "${filename}"`,
+			);
+			process.stdout.write("\n");
+		}
+	},
+);

package/commands/login.js

@@ -1,111 +1,90 @@
-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 os from "os";
+import readline from "readline";
+import Login from "../classes/login.js";
+import json from "../utils/json/index.js";
+import { commandHandler } from "../utils/command-handler.js";
 
 const homedir = os.homedir();
 
-export const command = 'login';
+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;
-
-    if (!s || !k) {
-        rl = readline.createInterface({
-            input: process.stdin,
-            output: process.stdout,
-        });
-    }
-
-    if (!s) {
-        await new Promise((resolve) => {
-            rl?.question('Enter Eik server address > ', (input) => {
-                s = input;
-                // @ts-expect-error
-                resolve();
-            });
-        });
-    }
-
-    if (!k) {
-        await new Promise((resolve) => {
-            rl?.question(`Enter login key for ${s} > `, (input) => {
-                k = input;
-                // @ts-expect-error
-                resolve();
-            });
-        });
-    }
-
-    if (rl) rl.close();
-
-    const spinner = ora({ stream: process.stdout }).start('working...');
-
-    try {
-        const token = await new Login({
-            logger: logger(spinner, debug),
-            key: k,
-            server: s,
-        }).run();
-
-        if (token) {
-            const meta = /** @type {{ tokens: any }} */ (
-                await json.read({ cwd: homedir, filename: '.eikrc' })
-            );
-
-            const tokens = new Map(meta.tokens);
-            tokens.set(s, token);
-            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);
-    }
-};
+export const handler = commandHandler(
+	{ command, options: ["server"] },
+	async (argv, logger) => {
+		const { key, server } = argv;
+
+		let k = key;
+		let s = server;
+		let rl = null;
+
+		if (!s || !k) {
+			rl = readline.createInterface({
+				input: process.stdin,
+				output: process.stdout,
+			});
+		}
+
+		if (!s) {
+			await new Promise((resolve) => {
+				rl?.question("Enter Eik server address > ", (input) => {
+					s = input;
+					// @ts-expect-error
+					resolve();
+				});
+			});
+		}
+
+		if (!k) {
+			await new Promise((resolve) => {
+				rl?.question(`Enter login key for ${s} > `, (input) => {
+					k = input;
+					// @ts-expect-error
+					resolve();
+				});
+			});
+		}
+
+		if (rl) rl.close();
+
+		const token = await new Login({
+			logger,
+			key: k,
+			server: s,
+		}).run();
+
+		if (token) {
+			const meta = /** @type {{ tokens: any }} */ (
+				await json.read({ cwd: homedir, filename: ".eikrc" })
+			);
+
+			const tokens = new Map(meta.tokens);
+			tokens.set(s, token);
+			meta.tokens = Array.from(tokens);
+
+			await json.write(meta, { cwd: homedir, filename: ".eikrc" });
+		}
+	},
+);