@eik/cli 3.1.3 → 3.1.5

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;
+}

package/utils/error.js

@@ -0,0 +1,42 @@
+export const errors = {
+	ERR_MISSING_CONFIG: "ERR_MISSING_CONFIG",
+	ERR_WRONG_TYPE: "ERR_WRONG_TYPE",
+	ERR_VERSION_EXISTS: "ERR_VERSION_EXISTS",
+	ERR_NOT_GIT: "ERR_NOT_GIT",
+	ERR_GIT_COMMIT: "ERR_GIT_COMMIT",
+};
+
+export class EikCliError extends Error {
+	#errorCode;
+	#exitCode;
+
+	/**
+	 * @param {string} errorCode
+	 * @param {string} message
+	 * @param {Error} [cause]
+	 */
+	constructor(errorCode, message, cause) {
+		super(message);
+
+		this.name = "EikCliError";
+		this.cause = cause;
+
+		this.#errorCode = errorCode;
+
+		switch (errorCode) {
+			case errors.ERR_VERSION_EXISTS:
+				this.#exitCode = 0;
+				break;
+			default:
+				this.#exitCode = 1;
+		}
+	}
+
+	get errorCode() {
+		return this.#errorCode;
+	}
+
+	get exitCode() {
+		return this.#exitCode;
+	}
+}

package/utils/hash/file.js

@@ -1,5 +1,5 @@
-import ssri from 'ssri';
-import fs from 'fs';
+import ssri from "ssri";
+import fs from "fs";
 
 /**
  * Reads a file from a given path and produces and returns an integrity hash from its contents
@@ -11,6 +11,6 @@ import fs from 'fs';
  * @example hash.file('/path/to/file.js');
  */
 export default async (path) => {
-    const integrity = await ssri.fromStream(fs.createReadStream(path));
-    return integrity.toString();
+	const integrity = await ssri.fromStream(fs.createReadStream(path));
+	return integrity.toString();
 };

package/utils/hash/files.js

@@ -1,5 +1,5 @@
-import ssri from 'ssri';
-import fileHash from './file.js';
+import ssri from "ssri";
+import fileHash from "./file.js";
 
 /**
  * Reads files from given paths and produces and returns an integrity hash from all files contents
@@ -11,11 +11,11 @@ import fileHash from './file.js';
  * @example hash.files(['/path/to/file1.js', '/path/to/file2.js']);
  */
 export default async (files) => {
-    const hashes = await Promise.all(files.map(fileHash));
-    const hasher = ssri.create();
-    for (const hash of hashes.sort()) {
-        hasher.update(hash);
-    }
-    const integrity = hasher.digest();
-    return integrity.toString();
+	const hashes = await Promise.all(files.map(fileHash));
+	const hasher = ssri.create();
+	for (const hash of hashes.sort()) {
+		hasher.update(hash);
+	}
+	const integrity = hasher.digest();
+	return integrity.toString();
 };

package/utils/hash/index.js

@@ -1,5 +1,5 @@
-import file from './file.js';
-import files from './files.js';
-import compare from './compare.js';
+import file from "./file.js";
+import files from "./files.js";
+import compare from "./compare.js";
 
 export default { file, files, compare };

package/utils/http/index.js

@@ -1,7 +1,7 @@
-import latestVersion from './latest-version.js';
-import versions from './versions.js';
-import integrity from './integrity.js';
-import request from './request.js';
+import latestVersion from "./latest-version.js";
+import versions from "./versions.js";
+import integrity from "./integrity.js";
+import request from "./request.js";
 
 export default { latestVersion, versions, integrity, request };
 export { latestVersion, versions, integrity, request };

package/utils/http/integrity.js

@@ -1,4 +1,4 @@
-import { join } from 'path';
+import { join } from "path";
 
 /**
  * Fetches package integrity string by name and version from a given Eik asset server.
@@ -12,24 +12,24 @@ import { join } from 'path';
  * @throws Error
  */
 export default async (server, type, name, version) => {
-    const url = new URL(join(type, name, version), server);
-    url.search = `?t=${Date.now()}`;
+	const url = new URL(join(type, name, version), server);
+	url.search = `?t=${Date.now()}`;
 
-    const res = await fetch(url);
+	const res = await fetch(url);
 
-    if (!res.ok) {
-        if (res.status === 404) {
-            return null;
-        }
-        throw new Error('Server responded with non 200 status code.');
-    }
+	if (!res.ok) {
+		if (res.status === 404) {
+			return null;
+		}
+		throw new Error("Server responded with non 200 status code.");
+	}
 
-    try {
-        const body = await res.json();
-        return body.integrity;
-    } catch (err) {
-        throw new Error(
-            'An error occurred while attempting to parse json response from server.',
-        );
-    }
+	try {
+		const body = await res.json();
+		return body.integrity;
+	} catch (err) {
+		throw new Error(
+			"An error occurred while attempting to parse json response from server.",
+		);
+	}
 };

package/utils/http/latest-version.js

@@ -1,4 +1,4 @@
-import { join } from 'path';
+import { join } from "path";
 
 /**
  * Fetches the latest version from an Eik server of a package by name, optionally restricting the lookup to a specified semver major version
@@ -12,44 +12,44 @@ import { join } from 'path';
  * @throws Error
  */
 export default async (server, type, name, major) => {
-    const url = new URL(`${join(type, name)}?t=${Date.now()}`, server);
-    const res = await fetch(url);
-    if (!res.ok) {
-        if (res.status === 404) {
-            return null;
-        }
-        throw new Error('Server responded with non 200 status code.');
-    }
+	const url = new URL(`${join(type, name)}?t=${Date.now()}`, server);
+	const res = await fetch(url);
+	if (!res.ok) {
+		if (res.status === 404) {
+			return null;
+		}
+		throw new Error("Server responded with non 200 status code.");
+	}
 
-    let body;
-    try {
-        body = await res.json();
-    } catch (err) {
-        throw new Error(
-            'An error occurred while attempting to parse json response from server.',
-        );
-    }
+	let body;
+	try {
+		body = await res.json();
+	} catch (err) {
+		throw new Error(
+			"An error occurred while attempting to parse json response from server.",
+		);
+	}
 
-    let versions;
-    try {
-        versions = new Map(body.versions);
-    } catch (err) {
-        throw new Error(
-            'An error occurred while attempting to create an internal versions map. The JSON returned from the server is most likely invalid.',
-        );
-    }
+	let versions;
+	try {
+		versions = new Map(body.versions);
+	} catch (err) {
+		throw new Error(
+			"An error occurred while attempting to create an internal versions map. The JSON returned from the server is most likely invalid.",
+		);
+	}
 
-    const highestMajor = Math.max(...versions.keys());
-    if (Number.isNaN(highestMajor)) {
-        throw new Error(
-            'An error occurred while attempting to get the highest major version from the internal versions map.',
-        );
-    }
+	const highestMajor = Math.max(...versions.keys());
+	if (Number.isNaN(highestMajor)) {
+		throw new Error(
+			"An error occurred while attempting to get the highest major version from the internal versions map.",
+		);
+	}
 
-    try {
-        const entry = versions.get(Number(major || highestMajor));
-        return entry.version;
-    } catch (err) {
-        return null;
-    }
+	try {
+		const entry = versions.get(Number(major || highestMajor));
+		return entry.version;
+	} catch (err) {
+		return null;
+	}
 };

package/utils/http/request.js

@@ -1,4 +1,4 @@
-import { readFile } from 'node:fs/promises';
+import { readFile } from "node:fs/promises";
 
 /**
  * @typedef {object} RequestOptions
@@ -21,54 +21,54 @@ import { readFile } from 'node:fs/promises';
  * @throws Error
  */
 async function request(options) {
-    const { method = 'POST', host, pathname, data, file, map, token } = options;
-    const body = new FormData();
-    const headers = new Headers();
+	const { method = "POST", host, pathname, data, file, map, token } = options;
+	const body = new FormData();
+	const headers = new Headers();
 
-    if (data) {
-        for (const [key, value] of Object.entries(data)) {
-            body.set(key, value);
-        }
-    }
+	if (data) {
+		for (const [key, value] of Object.entries(data)) {
+			body.set(key, value);
+		}
+	}
 
-    if (file) {
-        const fileData = await readFile(file);
-        body.set('package', new Blob([fileData]));
-    }
+	if (file) {
+		const fileData = await readFile(file);
+		body.set("package", new Blob([fileData]));
+	}
 
-    if (map) {
-        const mapData = await readFile(map);
-        body.set('map', new Blob([mapData]));
-    }
+	if (map) {
+		const mapData = await readFile(map);
+		body.set("map", new Blob([mapData]));
+	}
 
-    if (token) {
-        headers.set('Authorization', `Bearer ${token}`);
-    }
+	if (token) {
+		headers.set("Authorization", `Bearer ${token}`);
+	}
 
-    try {
-        const url = new URL(pathname, host);
-        url.search = `?t=${Date.now()}`;
+	try {
+		const url = new URL(pathname, host);
+		url.search = `?t=${Date.now()}`;
 
-        const res = await fetch(url, { method, body, headers });
+		const res = await fetch(url, { method, body, headers });
 
-        if (!res.ok) {
-            const err = new Error(
-                `Server responded with a non 200 ok status code. Response: ${res.status}`,
-            );
-            // @ts-ignore
-            err.statusCode = res.status;
-            throw err;
-        }
-        if (res?.headers?.get('content-type')?.includes('application/json')) {
-            return { message: await res.json(), status: res.status };
-        }
-        return { message: await res.text(), status: res.status };
-    } catch (err) {
-        if (!err.statusCode) {
-            err.statusCode = 500;
-        }
-        throw err;
-    }
+		if (!res.ok) {
+			const err = new Error(
+				`Server responded with a non 200 ok status code. Response: ${res.status}`,
+			);
+			// @ts-ignore
+			err.statusCode = res.status;
+			throw err;
+		}
+		if (res?.headers?.get("content-type")?.includes("application/json")) {
+			return { message: await res.json(), status: res.status };
+		}
+		return { message: await res.text(), status: res.status };
+	} catch (err) {
+		if (!err.statusCode) {
+			err.statusCode = 500;
+		}
+		throw err;
+	}
 }
 
 export default request;

package/utils/http/versions.js

@@ -1,4 +1,4 @@
-import { join } from 'path';
+import { join } from "path";
 
 /**
  * Fetches package versions by name from a given Eik asset server.
@@ -11,27 +11,27 @@ import { join } from 'path';
  * @throws Error
  */
 export default async (server, type, name) => {
-    const pkg = join(type, name);
-    const url = new URL(pkg, server);
-    url.search = `?t=${Date.now()}`;
+	const pkg = join(type, name);
+	const url = new URL(pkg, server);
+	url.search = `?t=${Date.now()}`;
 
-    const res = await fetch(url);
+	const res = await fetch(url);
 
-    if (!res.ok) {
-        if (res.status === 404) {
-            return null;
-        }
-        throw new Error('Server responded with non 200 status code.');
-    }
+	if (!res.ok) {
+		if (res.status === 404) {
+			return null;
+		}
+		throw new Error("Server responded with non 200 status code.");
+	}
 
-    let body;
-    try {
-        body = await res.json();
-    } catch (err) {
-        throw new Error(
-            'An error occurred while attempting to parse json response from server.',
-        );
-    }
+	let body;
+	try {
+		body = await res.json();
+	} catch (err) {
+		throw new Error(
+			"An error occurred while attempting to parse json response from server.",
+		);
+	}
 
-    return body.versions;
+	return body.versions;
 };

package/utils/index.js

@@ -1,7 +1,8 @@
-import { helpers } from '@eik/common';
-import logger from './logger.js';
-import typeTitle from './type-title.js';
+import { helpers } from "@eik/common";
+import logger from "./logger.js";
+import typeTitle from "./type-title.js";
+import { getArgsOrDefaults } from "./defaults.js";
 
-const { getDefaults, typeSlug } = helpers;
+const { typeSlug } = helpers;
 
-export { logger, getDefaults, typeSlug, typeTitle };
+export { logger, getArgsOrDefaults, typeSlug, typeTitle };

package/utils/json/index.js

@@ -1,5 +1,5 @@
-import read from './read.js';
-import write from './write.js';
-import writeEik from './write-eik.js';
+import read from "./read.js";
+import write from "./write.js";
+import writeEik from "./write-eik.js";
 
 export default { read, write, writeEik };

package/utils/json/read.js

@@ -1,6 +1,6 @@
-import assert from 'assert';
-import fs from 'node:fs/promises';
-import { join, isAbsolute } from 'path';
+import assert from "assert";
+import fs from "node:fs/promises";
+import { join, isAbsolute } from "path";
 
 /**
  * Reads a file at a given location, assumes the contents to be JSON and then deserializes into a JavaScript object
@@ -17,27 +17,27 @@ import { join, isAbsolute } from 'path';
  * @example json.read({ filename: './relative/path/to/file.json', cwd: '/path/to/cwd });
  */
 export default async (location) => {
-    if (typeof location !== 'string') {
-        assert(
-            location.filename,
-            'When "location" is not of type "string" then it must be an "object" with property "filename"',
-        );
-    }
-    let cwd = process.cwd();
-    let filename = '';
-    if (typeof location === 'string') {
-        filename = location;
-    } else {
-        filename = location.filename;
-        if (location.cwd) {
-            cwd = location.cwd;
-        }
-    }
-    const path = isAbsolute(filename) ? filename : join(cwd, filename);
-    try {
-        const meta = await fs.readFile(path, 'utf8');
-        return JSON.parse(meta);
-    } catch (err) {
-        return {};
-    }
+	if (typeof location !== "string") {
+		assert(
+			location.filename,
+			'When "location" is not of type "string" then it must be an "object" with property "filename"',
+		);
+	}
+	let cwd = process.cwd();
+	let filename = "";
+	if (typeof location === "string") {
+		filename = location;
+	} else {
+		filename = location.filename;
+		if (location.cwd) {
+			cwd = location.cwd;
+		}
+	}
+	const path = isAbsolute(filename) ? filename : join(cwd, filename);
+	try {
+		const meta = await fs.readFile(path, "utf8");
+		return JSON.parse(meta);
+	} catch (err) {
+		return {};
+	}
 };