@eik/cli 3.0.0-next.2 → 3.1.0

package/commands/map.js

@@ -0,0 +1,90 @@
+import { join } from 'path';
+import ora from 'ora';
+import PublishMap from '../classes/publish/map.js';
+import { logger, getDefaults } from '../utils/index.js';
+import { Artifact } from '../formatters/index.js';
+
+export const command = 'map <name> <version> <file>';
+
+export const aliases = ['m'];
+
+export const describe = `Upload an import map file to the server under a given name and version. A name/version combination must be unique and a version must be semver compliant. Subsquent published versions must increase. Eg. 1.0.0 1.0.1, 1.1.0, 2.0.0 etc.`;
+
+export const builder = (yargs) => {
+    const defaults = getDefaults(yargs.argv.config || yargs.argv.cwd);
+
+    yargs
+        .positional('name', {
+            describe: 'Import map name.',
+            type: 'string',
+        })
+        .positional('version', {
+            describe: 'Import map version.',
+            type: 'string',
+        })
+        .positional('file', {
+            describe:
+                'Path to import map file on local disk relative to the current working directory.',
+            type: 'string',
+            normalize: true,
+        });
+
+    yargs.options({
+        server: {
+            alias: 's',
+            describe: 'Specify location of asset server.',
+            // @ts-expect-error
+            default: defaults.server,
+        },
+        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 map my-map 1.0.0 ./import-map.json`);
+    yargs.example(`eik map my-map 2.1.0 ./import-map.json --debug`);
+    yargs.example(
+        `eik map my-map 2.1.1 ./import-map.json --server https://assets.myeikserver.com`,
+    );
+};
+
+export const handler = async (argv) => {
+    const spinner = ora({ stream: process.stdout }).start('working...');
+    const { debug, server, name, version } = argv;
+
+    try {
+        const log = logger(spinner, debug);
+
+        await new PublishMap({ logger: log, ...argv }).run();
+
+        let url = new URL(join('map', name), server);
+        let res = await fetch(url);
+        const pkgMeta = await res.json();
+
+        url = new URL(join('map', name, version), server);
+        res = await fetch(url);
+
+        log.info(`Published import map "${name}" at version "${version}"`);
+
+        spinner.text = '';
+        spinner.stopAndPersist();
+
+        const artifact = new Artifact(pkgMeta);
+        const versions = new Map(pkgMeta.versions);
+        artifact.versions = Array.from(versions.values());
+        artifact.format(server);
+
+        process.stdout.write('\n');
+    } catch (err) {
+        spinner.warn(err.message);
+        spinner.text = '';
+        spinner.stopAndPersist();
+        process.exit(1);
+    }
+};

package/commands/meta.js

@@ -1,25 +1,16 @@
-/* eslint-disable prefer-template */
-/* eslint-disable no-restricted-properties */
-/* eslint-disable one-var */
+import ora from 'ora';
+import Meta from '../classes/meta.js';
+import { Artifact } from '../formatters/index.js';
+import { logger, getDefaults } from '../utils/index.js';
 
-'use strict';
+export const command = 'meta <name>';
 
-const ora = require('ora');
-const { getDefaults } = require('@eik/common-config-loader');
-const Meta = require('../classes/meta');
-const { Artifact } = require('../formatters');
-const { logger, getCWD } = require('../utils');
+export const aliases = ['show'];
 
-exports.command = 'meta <name>';
+export const describe = `Retrieve meta information by package, map or npm name.If a given name exists in several types (package and map for example), results will be returned and displayed from all matching types`;
 
-exports.aliases = ['show'];
-
-exports.describe = `Retrieve meta information by package, map or npm name
-    If a given name exists in several types (package and map for example), results will be returned and displayed from all matching types`;
-
-exports.builder = (yargs) => {
-    const cwd = getCWD();
-    const defaults = getDefaults(cwd);
+export const builder = (yargs) => {
+    const defaults = getDefaults(yargs.argv.config || yargs.argv.cwd);
 
     yargs.positional('name', {
         describe:
@@ -31,18 +22,9 @@ exports.builder = (yargs) => {
         server: {
             alias: 's',
             describe: 'Specify location of asset server.',
+            // @ts-expect-error
             default: defaults.server,
         },
-        debug: {
-            describe: 'Logs additional messages',
-            default: false,
-            type: 'boolean',
-        },
-        cwd: {
-            alias: 'c',
-            describe: 'Alter current working directory.',
-            default: defaults.cwd,
-        },
     });
 
     yargs.example(`eik meta lit-html`);
@@ -50,13 +32,14 @@ exports.builder = (yargs) => {
     yargs.example(`eik meta my-app --server https://assets.myeikserver.com`);
 };
 
-exports.handler = async (argv) => {
+export const handler = async (argv) => {
     const spinner = ora({ stream: process.stdout }).start('working...');
     let meta = false;
     const { debug, server } = argv;
     const l = logger(spinner, debug);
 
     try {
+        // @ts-expect-error
         meta = await new Meta({ logger: l, ...argv }).run();
         spinner.text = '';
         spinner.stopAndPersist();

package/commands/npm-alias.js

@@ -0,0 +1,90 @@
+// @deprecated in favor of `alias` command
+
+import ora from 'ora';
+import Alias from '../classes/alias.js';
+import { logger, getDefaults } from '../utils/index.js';
+import { Alias as AliasFormatter } from '../formatters/index.js';
+
+export const command = 'npm-alias <name> <version> <alias>';
+
+export const aliases = ['na', 'dep-alias', 'dependency-alias'];
+
+export const describe = `DEPRECATED: This command has been replaced by the alias command and will be removed in a future version. Create a semver major alias for an NPM package as identified by its name and version. An NPM package with the given name and version must already exist on the asset server. Alias should be the semver major part of the NPM package version. Eg. For an NPM package of version 5.4.3, you should use 5 as the alias`;
+
+export const builder = (yargs) => {
+    const defaults = getDefaults(yargs.argv.config || yargs.argv.cwd);
+
+    yargs
+        .positional('name', {
+            describe: 'Name matching NPM package name.',
+            type: 'string',
+        })
+        .positional('version', {
+            describe: 'Version matching NPM package version.',
+            type: 'string',
+        })
+        .positional('alias', {
+            describe:
+                'Alias for a semver version. Must be the semver major component of version.',
+            type: 'string',
+        });
+
+    yargs.options({
+        server: {
+            alias: 's',
+            describe: 'Specify location of asset server.',
+            // @ts-expect-error
+            default: defaults.server,
+        },
+        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 npm lit-html 1.0.0 1`);
+    yargs.example(`eik npm lit-html 1.3.5 1 --debug`);
+    yargs.example(
+        `eik npm lit-html 5.3.2 5 --server https://assets.myeikserver.com`,
+    );
+};
+
+export const handler = async (argv) => {
+    const spinner = ora({ stream: process.stdout }).start('working...');
+    let success = false;
+    const { debug, server } = argv;
+    const log = logger(spinner, debug);
+    let data = {};
+
+    try {
+        data = await new Alias({
+            type: 'npm',
+            logger: log,
+            ...argv,
+        }).run();
+
+        const createdOrUpdated = data.update ? 'Updated' : 'Created';
+        log.info(
+            `${createdOrUpdated} alias for package "${data.name}". ("${data.version}" => "v${data.alias}")`,
+        );
+        success = true;
+    } catch (err) {
+        log.warn(err.message);
+    }
+
+    spinner.text = '';
+    spinner.stopAndPersist();
+    if (success) {
+        new AliasFormatter(data).format(server);
+    } else {
+        process.exit(1);
+    }
+};
+
+export const deprecated =
+    '"npm-alias" will be removed in a future version. Please use "alias" instead';

package/commands/package-alias.js

@@ -0,0 +1,102 @@
+// @deprecated in favor of `alias` command
+
+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';
+
+export const command = 'package-alias [name] [version] [alias]';
+
+export const aliases = ['pkg-alias', 'pa'];
+
+export const describe = `DEPRECATED: This command has been replaced by the alias command and will be removed in a future version. Create a semver major alias for a package as identified by its name and version. A package with the given name and version must already exist on asset server. 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`;
+
+export const builder = (yargs) => {
+    const defaults = getDefaults(yargs.argv.config || yargs.argv.cwd);
+
+    yargs
+        .positional('name', {
+            describe: 'Name matching existing name for a package on Eik server',
+            type: 'string',
+            // @ts-expect-error
+            default: defaults.name,
+        })
+        .positional('version', {
+            describe:
+                'Version matching existing version for a package on Eik server',
+            type: 'string',
+            // @ts-expect-error
+            default: defaults.version,
+        })
+        .positional('alias', {
+            describe:
+                'Alias for a semver version. Must be the semver major component of version. Eg. 1.0.0 should be given as 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,
+        },
+        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 package-alias my-app 1.0.0 1`);
+    yargs.example(`eik package-alias my-app 1.7.3 1`);
+    yargs.example(`eik package-alias my-app 6.3.1 6`);
+    yargs.example(
+        `eik package-alias my-app 6.3.1 6 --server https://assets.myeikserver.com`,
+    );
+    yargs.example(`eik package-alias my-app 4.2.2 4 --debug`);
+};
+
+export const handler = async (argv) => {
+    const spinner = ora({ stream: process.stdout }).start('working...');
+    let success = false;
+    const { debug, server } = argv;
+    const log = logger(spinner, debug);
+    let af;
+
+    try {
+        const data = await new Alias({
+            type: 'pkg',
+            logger: log,
+            ...argv,
+        }).run();
+
+        af = new AliasFormatter(data);
+
+        const createdOrUpdated = data.update ? 'Updated' : 'Created';
+        log.info(
+            `${createdOrUpdated} alias for package "${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);
+    }
+};
+
+export const deprecated =
+    '"package-alias" will be removed in a future version. Please use "alias" instead';

package/commands/ping.js

@@ -1,45 +1,35 @@
-'use strict';
+import ora from 'ora';
+import Ping from '../classes/ping.js';
+import { logger, getDefaults } from '../utils/index.js';
 
-const ora = require('ora');
-const { getDefaults } = require('@eik/common-config-loader');
-const Ping = require('../classes/ping');
-const { logger, getCWD } = require('../utils');
+export const command = 'ping [server]';
 
-exports.command = 'ping [server]';
+export const aliases = [];
 
-exports.aliases = [];
+export const describe = `Ping an Eik server to check that it is responding.`;
 
-exports.describe = `Ping an Eik server to check that it is responding.`;
-
-exports.builder = (yargs) => {
-    const cwd = getCWD();
-    const defaults = getDefaults(cwd);
+export const builder = (yargs) => {
+    const defaults = getDefaults(yargs.argv.config || yargs.argv.cwd);
 
     yargs.positional('server', {
         describe: 'Specify location of Eik server to ping.',
+        // @ts-expect-error
         default: defaults.server,
     });
 
-    yargs.options({
-        debug: {
-            describe: 'Logs additional messages',
-            default: false,
-            type: 'boolean',
-        },
-    });
-
     yargs.example(`eik ping`);
     yargs.example(`eik ping http://assets.myeikserver.com`);
     yargs.example(`eik ping http://assets.myeikserver.com --debug`);
 };
 
-exports.handler = async (argv) => {
+export const handler = async (argv) => {
     const spinner = ora({ stream: process.stdout }).start('working...');
     const { debug, server } = argv;
 
     try {
         await new Ping({ logger: logger(spinner, debug), server }).run();
     } catch (err) {
+        // @ts-expect-error
         logger.warn(err.message);
     }
 

package/commands/publish.js

@@ -1,35 +1,20 @@
-'use strict';
+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 { Artifact } from '../formatters/index.js';
 
-const { join } = require('path');
-const fetch = require('node-fetch');
-const ora = require('ora');
-const chalk = require('chalk');
-const { configStore, getDefaults } = require('@eik/common-config-loader');
-const { typeSlug, typeTitle } = require('@eik/common-utils');
+export const command = 'publish';
 
-const PublishPackage = require('../classes/publish/package/index');
-const { logger, getCWD } = require('../utils');
+export const aliases = ['pkg', 'package', 'pub'];
 
-const { Artifact } = require('../formatters');
-const PublishMap = require('../classes/publish/map');
+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.`;
 
-exports.command = 'publish';
-
-exports.aliases = ['pkg', 'package', 'pub'];
-
-exports.describe = `Publish files to an Eik server. Reads configuration from eik.json or package.json files. See https://eik.dev for more details.`;
-
-exports.builder = (yargs) => {
-    const cwd = getCWD();
-    const defaults = getDefaults(cwd);
+export const builder = (yargs) => {
+    const defaults = getDefaults(yargs.argv.config || yargs.argv.cwd);
 
     yargs.options({
-        cwd: {
-            alias: 'c',
-            describe: 'Alter the current working directory.',
-            default: defaults.cwd,
-            type: 'string',
-        },
         dryRun: {
             alias: 'd',
             describe:
@@ -37,31 +22,14 @@ exports.builder = (yargs) => {
             default: false,
             type: 'boolean',
         },
-        debug: {
-            describe: 'Logs additional messages',
-            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)`,
+            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',
         },
-        type: {
-            describe:
-                'Optional flag to define the type of asset you wish to publish. This can be "package", "map" or "npm". Default reads from eik configuration "type" field.',
-            default: '',
-            type: 'string',
-        },
-        file: {
-            describe:
-                'Path to import map file on local disk relative to the current working directory. Default reads the "files" in the eik config.',
-            type: 'string',
-            normalize: true,
-        },
     });
 
+    // @ts-expect-error
     yargs.default('token', defaults.token, defaults.token ? '######' : '');
 
     yargs.example(`eik publish`);
@@ -71,115 +39,91 @@ exports.builder = (yargs) => {
     yargs.example(`eik pkg --debug`);
 };
 
-exports.handler = async (argv) => {
+export const handler = async (argv) => {
     const spinner = ora({ stream: process.stdout }).start('working...');
-    const { debug, dryRun, cwd, token, type: typeFromArgs } = argv;
-    const config = configStore.findInDirectory(cwd);
-    const { name, server, version, type, map, out, files } = config;
-
-    const typeOverride = typeFromArgs || type;
+    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 {
-        if (['package', 'npm'].includes(typeOverride)) {
-            const options = {
-                logger: logger(spinner, debug),
-                cwd,
-                token,
-                dryRun,
-                debug,
-                name,
-                server,
-                version,
-                type,
-                map,
-                out,
-                files,
-            };
-
-            const publish = await new PublishPackage(options).run();
-
-            if (!publish) {
-                spinner.warn(
-                    '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;
-
-            if (!dryRun) {
-                let url = new URL(join(typeSlug(type), name), server);
-                let res = await fetch(url);
-                const pkgMeta = await res.json();
-
-                url = new URL(join(typeSlug(type), name, version), server);
-                res = await fetch(url);
-                const pkgVersionMeta = await res.json();
-
-                const artifact = new Artifact(pkgMeta);
-                artifact.versions = [pkgVersionMeta];
-
-                spinner.text = '';
-                spinner.stopAndPersist();
+        const options = {
+            logger: logger(spinner, debug),
+            cwd,
+            token,
+            dryRun,
+            debug,
+            name,
+            server,
+            version,
+            type,
+            map,
+            out,
+            files,
+        };
+
+        const publish = await new PublishPackage(options).run();
+
+        if (!publish) {
+            spinner.warn(
+                'Version in eik.json has not changed since last publish, publishing is not necessary',
+            );
+            process.stdout.write('\n');
+            process.exit(0);
+        }
 
-                artifact.format(server);
-                process.stdout.write('\n');
-            } else {
-                spinner.text = '';
-                spinner.stopAndPersist();
+        const { files: fls } = publish;
 
-                process.stdout.write(
-                    `:: ${chalk.bgYellow.white.bold(
-                        typeTitle(type),
-                    )} > ${chalk.green(name)} | ${chalk.bold('dry run')}`,
-                );
-                process.stdout.write('\n\n');
-                process.stdout.write('   files (local temporary):\n');
-                for (const file of fls) {
-                    process.stdout.write(
-                        `   - ${chalk.bold('type')}: ${file.type}\n`,
-                    );
-                    process.stdout.write(
-                        `     ${chalk.bold('path')}: ${file.pathname}\n\n`,
-                    );
-                }
-                process.stdout.write(
-                    `   ${chalk.bold(
-                        'No files were published to remote server',
-                    )}\n\n`,
-                );
-            }
-        } else if (typeOverride === 'map') {
-            const log = logger(spinner, debug);
-
-            await new PublishMap({
-                logger: log,
-                name,
-                version,
-                server,
-                file: files,
-                ...argv,
-            }).run();
-
-            let url = new URL(join('map', name), server);
+        if (!dryRun) {
+            let url = new URL(join(typeSlug(type), name), server);
             let res = await fetch(url);
             const pkgMeta = await res.json();
 
-            url = new URL(join('map', name, version), server);
+            url = new URL(join(typeSlug(type), name, version), server);
             res = await fetch(url);
+            const pkgVersionMeta = await res.json();
 
-            log.info(`Published import map "${name}" at version "${version}"`);
+            const artifact = new Artifact(pkgMeta);
+            artifact.versions = [pkgVersionMeta];
 
             spinner.text = '';
             spinner.stopAndPersist();
 
-            const artifact = new Artifact(pkgMeta);
-            const versions = new Map(pkgMeta.versions);
-            artifact.versions = Array.from(versions.values());
             artifact.format(server);
-
             process.stdout.write('\n');
+        } else {
+            spinner.text = '';
+            spinner.stopAndPersist();
+
+            process.stdout.write(
+                `:: ${chalk.bgYellow.white.bold(
+                    typeTitle(type),
+                )} > ${chalk.green(name)} | ${chalk.bold('dry run')}`,
+            );
+            process.stdout.write('\n\n');
+            process.stdout.write('   files (local temporary):\n');
+            for (const file of fls) {
+                process.stdout.write(
+                    `   - ${chalk.bold('type')}: ${file.type}\n`,
+                );
+                process.stdout.write(
+                    `     ${chalk.bold('path')}: ${file.pathname}\n\n`,
+                );
+            }
+            process.stdout.write(
+                `   ${chalk.bold(
+                    'No files were published to remote server',
+                )}\n\n`,
+            );
         }
     } catch (err) {
         spinner.warn(err.message);