@eik/cli 3.0.0-next.1 → 3.0.0-next.2

package/CHANGELOG.md

@@ -1,3 +1,20 @@
+# [3.0.0-next.2](https://github.com/eik-lib/cli/compare/v3.0.0-next.1...v3.0.0-next.2) (2022-08-17)
+
+
+### Bug Fixes
+
+* incorrect version number displayed on alias when updating with a cache layer infront ([8c468d6](https://github.com/eik-lib/cli/commit/8c468d670f6f10f25ae4decdab7a6950a1093d6a))
+
+
+### Features
+
+* **!:** new alias command for all types of packages ([e482880](https://github.com/eik-lib/cli/commit/e48288002e9e8942f71d8f8dd0583395152aff49))
+
+
+### BREAKING CHANGES
+
+* **!:** New alias command that is to be used for creating package, npm and import map aliases. Old alias commands have been removed.
+
 # [3.0.0-next.1](https://github.com/eik-lib/cli/compare/v2.0.22...v3.0.0-next.1) (2022-08-17)
 
 

package/classes/alias.js

@@ -59,7 +59,9 @@ module.exports = class Alias {
 
             data.org = message.org || '';
             data.integrity = message.integrity || '';
-            data.version = message.version || this.version;
+            // We'll use message.version when the cache has been properly purged
+            // data.version = message.version || this.version;
+            data.version = this.version;
             data.name = message.name || this.name;
             data.files = message.files || [];
 
@@ -68,10 +70,6 @@ module.exports = class Alias {
             let status = err.statusCode;
 
             if (status === 409) {
-                this.log.debug(
-                    'Alias already exists on server, performing update',
-                );
-
                 try {
                     const { message: msg } = await request({
                         host: this.server,
@@ -83,7 +81,9 @@ module.exports = class Alias {
 
                     data.org = msg.org || '';
                     data.integrity = msg.integrity || '';
-                    data.version = msg.version || this.version;
+                    // We'll use msg.version when the cache has been properly purged
+                    // data.version = msg.version || this.version;
+                    data.version = this.version;
                     data.name = msg.name || this.name;
                     data.files = msg.files || [];
                     data.update = true;

package/commands/alias.js

@@ -0,0 +1,125 @@
+/* eslint-disable no-nested-ternary */
+const ora = require('ora');
+const { configStore, getDefaults } = require('@eik/common-config-loader');
+const { getCWD, logger } = require('../utils');
+
+const Alias = require('../classes/alias');
+const { Alias: AliasFormatter } = require('../formatters');
+
+exports.command = 'alias <name> <version> <alias>';
+
+exports.aliases = [
+    'ma',
+    'pa',
+    'pkg-alias',
+    'na',
+    'dep-alias',
+    'dependency-alias',
+];
+
+exports.describe = `Create a semver major alias for a package or an import map as identified by its name and version.
+    A package or import map with the given name and version must already exist on the Eik server
+    Alias should be the semver major part of the version.
+    Eg. For a package or import map of version 5.4.3, you should use 5 as the alias`;
+
+exports.builder = (yargs) => {
+    const cwd = getCWD();
+    const defaults = getDefaults(cwd);
+
+    yargs
+        .positional('name', {
+            describe: `Name of package or map that is to be aliased`,
+            type: 'string',
+        })
+        .positional('version', {
+            describe: `Version for package or map that is to be aliased`,
+            type: 'string',
+        })
+        .positional('alias', {
+            describe: `Alias for a semver version. Should be the semver major component of version.`,
+            type: 'string',
+        });
+
+    yargs.options({
+        server: {
+            alias: 's',
+            describe: 'Specify location of Eik server.',
+            default: defaults.server,
+        },
+        cwd: {
+            alias: 'c',
+            describe: 'Alter current working directory.',
+            default: defaults.cwd,
+        },
+        debug: {
+            describe: 'Log additional messages',
+            default: false,
+            type: 'boolean',
+        },
+        token: {
+            describe:
+                'Provide a jwt token to be used to authenticate with the Eik server.',
+            default: '',
+            alias: 't',
+        },
+    });
+
+    yargs.default('token', defaults.token, defaults.token ? '######' : '');
+
+    yargs.example(`eik alias my-app 1.6.2 1`);
+    yargs.example(`eik alias my-map 1.0.1 1`);
+    yargs.example(`eik alias lodash 4.17.19 4`);
+    yargs.example(
+        `eik alias my-map 6.3.1 6 --server https://assets.myeikserver.com`,
+    );
+    yargs.example(`eik alias my-map 4.2.2 4 --debug`);
+};
+
+exports.handler = async (argv) => {
+    const spinner = ora({ stream: process.stdout }).start('working...');
+    let success = false;
+    const { cwd, type: typeFromArgs, debug } = argv;
+    const config = configStore.findInDirectory(cwd);
+    const { server, type } = config;
+
+    const typeOverride = typeFromArgs || type;
+    const log = logger(spinner, debug);
+
+    const isPackage = ['package', 'npm'].includes(typeOverride);
+
+    try {
+        const data = await new Alias({
+            type:
+                typeOverride === 'package'
+                    ? 'pkg'
+                    : typeOverride === 'npm'
+                    ? 'npm'
+                    : typeOverride === 'map'
+                    ? 'map'
+                    : 'pkg',
+            logger: log,
+            ...argv,
+        }).run();
+
+        const createdOrUpdated = data.update ? 'Updated' : 'Created';
+        log.info(
+            `${createdOrUpdated} alias for ${isPackage ? 'package' : 'map'} "${
+                data.name
+            }". ("${data.version}" => "v${data.alias}")`,
+        );
+        success = true;
+
+        spinner.text = '';
+        spinner.stopAndPersist();
+        if (success) {
+            new AliasFormatter(data).format(server);
+        } else {
+            process.exit(1);
+        }
+    } catch (err) {
+        spinner.warn(err.message);
+        spinner.text = '';
+        spinner.stopAndPersist();
+        process.exit(1);
+    }
+};

package/formatters/alias.js

@@ -55,6 +55,12 @@ class Alias {
 
         if (this.update) {
             write(`${chalk.bgMagenta.white(' UPDATED \n\n')}`);
+
+            write(
+                `${chalk.yellow.bold(
+                    '! It may take up to 40 minutes before this alias updates due to caching.',
+                )}\n\n`,
+            );
         } else {
             write(`${chalk.bgGreen.white(' NEW ')}\n\n`);
         }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eik/cli",
-  "version": "3.0.0-next.1",
+  "version": "3.0.0-next.2",
   "description": "Cli tool for publishing assets",
   "main": "./classes/index.js",
   "bin": {

package/commands/map-alias.js

@@ -1,105 +0,0 @@
-'use strict';
-
-const ora = require('ora');
-const { getDefaults } = require('@eik/common-config-loader');
-const Alias = require('../classes/alias');
-const { logger, getCWD } = require('../utils');
-const { Alias: AliasFormatter } = require('../formatters');
-
-exports.command = 'map-alias <name> <version> <alias>';
-
-exports.aliases = ['ma'];
-
-exports.describe = `Create a semver major alias for an import map as identified by its name and version.
-    An import map with the given name and version must already exist on asset server
-    Alias should be the semver major part of the import map version.
-    Eg. For an import map of version 5.4.3, you should use 5 as the alias`;
-
-exports.builder = (yargs) => {
-    const cwd = getCWD();
-    const defaults = getDefaults(cwd);
-
-    yargs
-        .positional('name', {
-            describe: `Import map name for import map that is to be aliased`,
-            type: 'string',
-        })
-        .positional('version', {
-            describe: `Import map version for import map that is to be aliased`,
-            type: 'string',
-        })
-        .positional('alias', {
-            describe: `Alias for a semver version. Should be the semver major component of version.`,
-            type: 'string',
-        });
-
-    yargs.options({
-        server: {
-            alias: 's',
-            describe: 'Specify location of asset server.',
-            default: defaults.server,
-        },
-        cwd: {
-            alias: 'c',
-            describe: 'Alter current working directory.',
-            default: defaults.cwd,
-        },
-        debug: {
-            describe: 'Logs additional messages',
-            default: false,
-            type: 'boolean',
-        },
-        token: {
-            describe:
-                'Provide a jwt token to be used to authenticate with the Eik server.',
-            default: '',
-            alias: 't',
-        },
-    });
-
-    yargs.default('token', defaults.token, defaults.token ? '######' : '');
-
-    yargs.example(`eik map-alias my-map 1.0.0 1`);
-    yargs.example(`eik map-alias my-map 1.7.3 1`);
-    yargs.example(`eik map-alias my-map 6.3.1 6`);
-    yargs.example(
-        `eik map-alias my-map 6.3.1 6 --server https://assets.myeikserver.com`,
-    );
-    yargs.example(`eik map-alias my-map 4.2.2 4 --debug`);
-};
-
-exports.handler = async (argv) => {
-    const spinner = ora({ stream: process.stdout }).start('working...');
-    let success = false;
-    const { debug, name, version, server } = argv;
-    const log = logger(spinner, debug);
-    let data = {};
-
-    try {
-        data = await new Alias({
-            type: 'map',
-            logger: log,
-            ...argv,
-        }).run();
-
-        data.name = name;
-        data.version = version;
-        data.files = [];
-
-        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);
-    }
-};

package/commands/npm-alias.js

@@ -1,100 +0,0 @@
-'use strict';
-
-const ora = require('ora');
-const { getDefaults } = require('@eik/common-config-loader');
-const Alias = require('../classes/alias');
-const { logger, getCWD } = require('../utils');
-const { Alias: AliasFormatter } = require('../formatters');
-
-exports.command = 'npm-alias <name> <version> <alias>';
-
-exports.aliases = ['na', 'dep-alias', 'dependency-alias'];
-
-exports.describe = `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`;
-
-exports.builder = (yargs) => {
-    const cwd = getCWD();
-    const defaults = getDefaults(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.',
-            default: defaults.server,
-        },
-        cwd: {
-            alias: 'c',
-            describe: 'Alter current working directory.',
-            default: defaults.cwd,
-        },
-        debug: {
-            describe: 'Logs additional messages',
-            default: false,
-            type: 'boolean',
-        },
-        token: {
-            describe:
-                'Provide a jwt token to be used to authenticate with the Eik server.',
-            default: '',
-            alias: 't',
-        },
-    });
-
-    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`,
-    );
-};
-
-exports.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);
-    }
-};

package/commands/package-alias.js

@@ -1,109 +0,0 @@
-'use strict';
-
-const ora = require('ora');
-const semver = require('semver');
-const { getDefaults } = require('@eik/common-config-loader');
-const Alias = require('../classes/alias');
-const { logger, getCWD } = require('../utils');
-const { Alias: AliasFormatter } = require('../formatters');
-
-exports.command = 'package-alias [name] [version] [alias]';
-
-exports.aliases = ['pkg-alias', 'pa'];
-
-exports.describe = `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`;
-
-exports.builder = (yargs) => {
-    const cwd = getCWD();
-    const defaults = getDefaults(cwd);
-
-    yargs
-        .positional('name', {
-            describe: 'Name matching existing name for a package on Eik server',
-            type: 'string',
-            default: defaults.name,
-        })
-        .positional('version', {
-            describe:
-                'Version matching existing version for a package on Eik server',
-            type: 'string',
-            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',
-            default: defaults.version ? semver.major(defaults.version) : null,
-        });
-
-    yargs.options({
-        server: {
-            alias: 's',
-            describe: 'Specify location of Eik asset server.',
-            default: defaults.server,
-        },
-        cwd: {
-            alias: 'c',
-            describe: 'Alter the current working directory.',
-            default: defaults.cwd,
-        },
-        debug: {
-            describe: 'Logs additional messages',
-            default: false,
-            type: 'boolean',
-        },
-        token: {
-            describe:
-                'Provide a jwt token to be used to authenticate with the Eik server.',
-            default: '',
-            alias: 't',
-        },
-    });
-
-    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`);
-};
-
-exports.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);
-    }
-};