@eik/cli 3.1.3 → 3.1.5

package/formatters/version.js

@@ -1,61 +1,59 @@
-import { join } from 'path';
-import chalk from 'chalk';
-import { formatDistance } from 'date-fns/formatDistance';
-import File from './file.js';
+import { join } from "path";
+import chalk from "chalk";
+import { formatDistance } from "date-fns/formatDistance";
+import File from "./file.js";
 
 class Version {
-    constructor({
-        version = '',
-        integrity = '',
-        author = {},
-        created = null,
-        type = '',
-        name = '',
-        org = '',
-        files = [],
-        meta = [],
-    } = {}) {
-        this.version = version;
-        this.integrity = integrity;
-        this.author = author;
-        this.created = created;
-        this.type = type;
-        this.name = name;
-        this.org = org;
-        this.files = files;
-        this.meta = meta;
-    }
+	constructor({
+		version = "",
+		integrity = "",
+		author = {},
+		created = null,
+		type = "",
+		name = "",
+		org = "",
+		files = [],
+		meta = [],
+	} = {}) {
+		this.version = version;
+		this.integrity = integrity;
+		this.author = author;
+		this.created = created;
+		this.type = type;
+		this.name = name;
+		this.org = org;
+		this.files = files;
+		this.meta = meta;
+	}
 
-    format(baseURL = '') {
-        const write = process.stdout.write.bind(process.stdout);
-        const url = new URL(baseURL);
-        const bURL = new URL(join(url.pathname, this.version), url.origin);
+	format(baseURL = "") {
+		const write = process.stdout.write.bind(process.stdout);
+		const url = new URL(baseURL);
+		const bURL = new URL(join(url.pathname, this.version), url.origin);
 
-        write(`   - ${chalk.green(this.version)}\n`);
-        write(`     ${chalk.bold('url:')} ${chalk.cyan(bURL.href)}\n`);
-        write(`     ${chalk.bold('integrity:')} ${this.integrity}\n`);
+		write(`   - ${chalk.green(this.version)}\n`);
+		write(`     ${chalk.bold("url:")} ${chalk.cyan(bURL.href)}\n`);
+		write(`     ${chalk.bold("integrity:")} ${this.integrity}\n`);
 
-        if (this.files && this.files.length) {
-            write(`\n     ${chalk.bold('files:')}\n`);
-            for (const file of this.files) {
-                new File(file).format(bURL.href);
-                write(`\n`);
-            }
-        }
+		if (this.files && this.files.length) {
+			write(`\n     ${chalk.bold("files:")}\n`);
+			for (const file of this.files) {
+				new File(file).format(bURL.href);
+				write(`\n`);
+			}
+		}
 
-        if (this.created) {
-            const d = formatDistance(
-                new Date(this.created * 1000),
-                new Date(),
-                { addSuffix: true },
-            );
-            write(`     ${chalk.bold('published')} ${chalk.yellow(d)}`);
-        }
+		if (this.created) {
+			const d = formatDistance(new Date(this.created * 1000), new Date(), {
+				addSuffix: true,
+			});
+			write(`     ${chalk.bold("published")} ${chalk.yellow(d)}`);
+		}
 
-        if (this.author && this.author.name) {
-            write(` ${chalk.bold('by')} ${chalk.yellow(this.author.name)}`);
-        }
-    }
+		if (this.author && this.author.name) {
+			write(` ${chalk.bold("by")} ${chalk.yellow(this.author.name)}`);
+		}
+	}
 }
 
 export default Version;

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 yargs from "yargs";
+import { hideBin } from "yargs/helpers";
+import { join } from "path";
+import { readFileSync } from "fs";
+import { fileURLToPath } from "url";
+import { dirname } from "path";
+
+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(
-    readFileSync(join(__dirname, './package.json'), { encoding: 'utf-8' }),
+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')
+	process.argv.includes("-v") ||
+	// last position only to avoid conflict with publish command
+	process.argv[process.argv.length - 1].includes("--version")
 ) {
-    console.log(version);
-    process.exit(0);
+	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))
-    .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.',
-        },
-        cwd: {
-            describe: 'Alter the current working directory.',
-            default: process.cwd(),
-        },
-        debug: {
-            describe: 'Logs additional messages',
-            default: false,
-            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)
-    .demandCommand()
-    .wrap(150)
-    .version(false)
-    .help()
-    .parse();
+	.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: "Path to Eik configuration file (eik.json or package.json)",
+		},
+		cwd: {
+			describe: "Path to a different working directory than the current",
+		},
+		debug: {
+			describe: "Show additional logs",
+			type: "boolean",
+		},
+	})
+	.command([
+		alias,
+		init,
+		integrity,
+		login,
+		map,
+		mapAlias,
+		meta,
+		npmAlias,
+		packageAlias,
+		ping,
+		publish,
+		version,
+	])
+	.demandCommand()
+	.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.3",
+  "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,14 +40,13 @@
   "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",
     "form-data": "4.0.0",
     "gzip-size": "7.0.0",
     "make-dir": "5.0.0",
-    "ora": "8.0.1",
+    "ora": "8.1.0",
     "rimraf": "6.0.1",
     "semver": "7.6.3",
     "ssri": "10.0.6",
@@ -57,10 +56,12 @@
   },
   "devDependencies": {
     "@eik/eslint-config": "1.0.2",
+    "@eik/prettier-config": "1.0.1",
     "@eik/semantic-release-config": "1.0.0",
     "@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;
@@ -57,4 +57,4 @@ export type AliasResult = {
     org: string;
     integrity: string;
 };
-import abslog from 'abslog';
+import abslog from "abslog";

package/types/classes/integrity.d.ts

@@ -32,4 +32,4 @@ export type IntegrityOptions = {
     cwd?: string;
     debug?: boolean;
 };
-import abslog from 'abslog';
+import abslog from "abslog";

package/types/classes/login.d.ts

@@ -22,4 +22,4 @@ export type LoginOptions = {
     server: string;
     key: string;
 };
-import abslog from 'abslog';
+import abslog from "abslog";

package/types/classes/meta.d.ts

@@ -25,4 +25,4 @@ export type MetaOptions = {
     name: string;
     version: string;
 };
-import abslog from 'abslog';
+import abslog from "abslog";

package/types/classes/ping.d.ts

@@ -20,4 +20,4 @@ export type PingOptions = {
     server?: string;
     logger?: import("abslog").AbstractLoggerOptions;
 };
-import abslog from 'abslog';
+import abslog from "abslog";

package/types/classes/publish/map.d.ts

@@ -48,4 +48,4 @@ export type PublishMapResult = {
     version: string;
     type: string;
 };
-import abslog from 'abslog';
+import abslog from "abslog";

package/types/classes/publish/package/index.d.ts

@@ -81,14 +81,14 @@ export type PublishResult = {
         type: string;
     }>;
 };
-import abslog from 'abslog';
-import { EikConfig } from '@eik/common';
-import ValidateInput from './tasks/validate-input.js';
-import CreateTempDirectory from './tasks/create-temp-directory.js';
-import CreateZipFile from './tasks/create-zip-file.js';
-import CheckBundleSizes from './tasks/check-bundle-sizes.js';
-import DryRun from './tasks/dry-run.js';
-import CheckIfAlreadyPublished from './tasks/check-if-already-published.js';
-import UploadFiles from './tasks/upload-files.js';
-import SaveMetafile from './tasks/save-metafile.js';
-import Cleanup from './tasks/cleanup.js';
+import abslog from "abslog";
+import { EikConfig } from "@eik/common";
+import ValidateInput from "./tasks/validate-input.js";
+import CreateTempDirectory from "./tasks/create-temp-directory.js";
+import CreateZipFile from "./tasks/create-zip-file.js";
+import CheckBundleSizes from "./tasks/check-bundle-sizes.js";
+import DryRun from "./tasks/dry-run.js";
+import CheckIfAlreadyPublished from "./tasks/check-if-already-published.js";
+import UploadFiles from "./tasks/upload-files.js";
+import SaveMetafile from "./tasks/save-metafile.js";
+import Cleanup from "./tasks/cleanup.js";

package/types/classes/publish/package/tasks/check-bundle-sizes.d.ts

@@ -1,4 +1,4 @@
 export default class CheckBundleSizes extends Task {
     process(): Promise<void>;
 }
-import Task from './task.js';
+import Task from "./task.js";

package/types/classes/publish/package/tasks/check-if-already-published.d.ts

@@ -1,4 +1,4 @@
 export default class CheckIfAlreadyPublished extends Task {
     process(): Promise<string>;
 }
-import Task from './task.js';
+import Task from "./task.js";

package/types/classes/publish/package/tasks/cleanup.d.ts

@@ -1,4 +1,4 @@
 export default class Cleanup extends Task {
     process(): Promise<void>;
 }
-import Task from './task.js';
+import Task from "./task.js";

package/types/classes/publish/package/tasks/create-temp-directory.d.ts

@@ -1,4 +1,4 @@
 export default class CreateTempDir extends Task {
     process(): Promise<void>;
 }
-import Task from './task.js';
+import Task from "./task.js";

package/types/classes/publish/package/tasks/create-zip-file.d.ts

@@ -1,4 +1,4 @@
 export default class CreateZipFile extends Task {
     process(): Promise<string>;
 }
-import Task from './task.js';
+import Task from "./task.js";

package/types/classes/publish/package/tasks/dry-run.d.ts

@@ -4,4 +4,4 @@ export default class DryRun extends Task {
         type: string;
     }[]>;
 }
-import Task from './task.js';
+import Task from "./task.js";

package/types/classes/publish/package/tasks/save-metafile.d.ts

@@ -1,4 +1,4 @@
 export default class SaveMetaFile extends Task {
     process(response: any): Promise<void>;
 }
-import Task from './task.js';
+import Task from "./task.js";

package/types/classes/publish/package/tasks/task.d.ts

@@ -5,4 +5,4 @@ export default class Task {
     path: any;
     config: any;
 }
-import abslog from 'abslog';
+import abslog from "abslog";

package/types/classes/publish/package/tasks/upload-files.d.ts

@@ -1,4 +1,4 @@
 export default class UploadFiles extends Task {
     process(zipFile: any): Promise<any>;
 }
-import Task from './task.js';
+import Task from "./task.js";

package/types/classes/publish/package/tasks/validate-input.d.ts

@@ -1,4 +1,4 @@
 export default class ValidateInput extends Task {
     process(): void;
 }
-import Task from './task.js';
+import Task from "./task.js";

package/types/classes/version.d.ts

@@ -38,6 +38,6 @@ export type VersionOptions = {
     out?: string;
     files: string | Record<string, string>;
 };
-import abslog from 'abslog';
-import { EikConfig } from '@eik/common';
-import semver from 'semver';
+import abslog from "abslog";
+import { EikConfig } from "@eik/common";
+import semver from "semver";

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/hash/index.d.ts

@@ -4,6 +4,6 @@ declare namespace _default {
     export { compare };
 }
 export default _default;
-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";

package/types/utils/http/index.d.ts

@@ -5,8 +5,8 @@ declare namespace _default {
     export { request };
 }
 export default _default;
-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 { latestVersion, versions, integrity, request };

package/types/utils/index.d.ts

@@ -1,6 +1,6 @@
-import logger from './logger.js';
-export const getDefaults: typeof helpers.getDefaults;
+import logger from "./logger.js";
+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 };
+import typeTitle from "./type-title.js";
+import { helpers } from "@eik/common";
+export { logger, getArgsOrDefaults, typeTitle };

package/types/utils/json/index.d.ts

@@ -4,6 +4,6 @@ declare namespace _default {
     export { writeEik };
 }
 export default _default;
-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";