@eik/cli 3.0.0-next.1 → 3.0.2

package/commands/npm-alias.js

@@ -1,23 +1,18 @@
-'use strict';
+// @deprecated in favor of `alias` command
 
-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');
+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';
 
-exports.command = 'npm-alias <name> <version> <alias>';
+export const command = 'npm-alias <name> <version> <alias>';
 
-exports.aliases = ['na', 'dep-alias', 'dependency-alias'];
+export const 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`;
+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`;
 
-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', {
@@ -38,18 +33,9 @@ exports.builder = (yargs) => {
         server: {
             alias: 's',
             describe: 'Specify location of asset server.',
+            // @ts-expect-error
             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.',
@@ -58,6 +44,7 @@ exports.builder = (yargs) => {
         },
     });
 
+    // @ts-expect-error
     yargs.default('token', defaults.token, defaults.token ? '######' : '');
 
     yargs.example(`eik npm lit-html 1.0.0 1`);
@@ -67,7 +54,7 @@ exports.builder = (yargs) => {
     );
 };
 
-exports.handler = async (argv) => {
+export const handler = async (argv) => {
     const spinner = ora({ stream: process.stdout }).start('working...');
     let success = false;
     const { debug, server } = argv;
@@ -98,3 +85,6 @@ exports.handler = async (argv) => {
         process.exit(1);
     }
 };
+
+export const deprecated =
+    '"npm-alias" will be removed in a future version. Please use "alias" instead';

package/commands/package-alias.js

@@ -1,41 +1,39 @@
-'use strict';
+// @deprecated in favor of `alias` command
 
-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');
+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';
 
-exports.command = 'package-alias [name] [version] [alias]';
+export const command = 'package-alias [name] [version] [alias]';
 
-exports.aliases = ['pkg-alias', 'pa'];
+export const 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`;
+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`;
 
-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: '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,
         });
 
@@ -43,18 +41,9 @@ exports.builder = (yargs) => {
         server: {
             alias: 's',
             describe: 'Specify location of Eik asset server.',
+            // @ts-expect-error
             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.',
@@ -63,6 +52,7 @@ exports.builder = (yargs) => {
         },
     });
 
+    // @ts-expect-error
     yargs.default('token', defaults.token, defaults.token ? '######' : '');
 
     yargs.example(`eik package-alias my-app 1.0.0 1`);
@@ -74,7 +64,7 @@ exports.builder = (yargs) => {
     yargs.example(`eik package-alias my-app 4.2.2 4 --debug`);
 };
 
-exports.handler = async (argv) => {
+export const handler = async (argv) => {
     const spinner = ora({ stream: process.stdout }).start('working...');
     let success = false;
     const { debug, server } = argv;
@@ -102,8 +92,11 @@ exports.handler = async (argv) => {
     spinner.text = '';
     spinner.stopAndPersist();
     if (success) {
-        af.format(server);
+        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);

package/commands/version.js

@@ -1,23 +1,15 @@
-'use strict';
+import { execSync } from 'child_process';
+import { join } from 'path';
+import ora from 'ora';
+import VersionPackage from '../classes/version.js';
+import { logger, getDefaults } from '../utils/index.js';
+import json from '../utils/json/index.js';
 
-const { execSync } = require('child_process');
-const { join } = require('path');
-const ora = require('ora');
-const { configStore, getDefaults } = require('@eik/common-config-loader');
-const VersionPackage = require('../classes/version');
-const { logger, getCWD } = require('../utils');
-const json = require('../utils/json');
+export const command = 'version [level]';
 
-exports.command = 'version [level]';
-
-exports.aliases = ['v'];
-
-exports.describe = `Compares local files with files on server and increments "version" field in eik.json if necessary.`;
-
-exports.builder = (yargs) => {
-    const cwd = getCWD();
-    const defaults = getDefaults(cwd);
+export const describe = `Compares local files with files on server and increments "version" field in eik.json if necessary.`;
 
+export const builder = (yargs) => {
     yargs.positional('level', {
         describe: 'Semver level to increment version by',
         default: 'patch',
@@ -26,12 +18,6 @@ exports.builder = (yargs) => {
     });
 
     yargs.options({
-        cwd: {
-            alias: 'c',
-            describe: 'Alter the current working directory.',
-            default: defaults.cwd,
-            type: 'string',
-        },
         dryRun: {
             alias: 'd',
             describe:
@@ -39,23 +25,19 @@ exports.builder = (yargs) => {
             default: false,
             type: 'boolean',
         },
-        debug: {
-            describe: 'Logs additional messages',
-            default: false,
-            type: 'boolean',
-        },
     });
 
     yargs.example(`eik version`);
     yargs.example(`eik version minor`);
-    yargs.example(`eik v`);
 };
 
-exports.handler = async (argv) => {
+export const handler = async (argv) => {
     const spinner = ora({ stream: process.stdout }).start('working...');
-    const { level, debug, dryRun, cwd } = argv;
-    const config = configStore.findInDirectory(cwd);
-    const { name, version, server, map, out, files } = config;
+    const { level, debug, dryRun, cwd, config } = argv;
+    // @ts-expect-error
+    const { name, version, server, map, out, files } = getDefaults(
+        config || cwd,
+    );
 
     try {
         const log = logger(spinner, debug);
@@ -80,6 +62,7 @@ exports.handler = async (argv) => {
             );
         } else {
             log.debug(`Writing new version ${newVersion} to eik.json`);
+            // @ts-expect-error
             await json.writeEik({ version: newVersion }, { cwd });
 
             log.debug(`Committing eik.json to local git repository`);

package/formatters/alias.js

@@ -1,10 +1,6 @@
-/* eslint-disable no-underscore-dangle */
-
-'use strict';
-
-const { join } = require('path');
-const chalk = require('chalk');
-const File = require('./file');
+import { join } from 'path';
+import chalk from 'chalk';
+import File from './file.js';
 
 function colorType(type) {
     if (type === 'npm') {
@@ -79,4 +75,4 @@ class Alias {
     }
 }
 
-module.exports = Alias;
+export default Alias;

package/formatters/artifact.js

@@ -1,10 +1,6 @@
-/* eslint-disable no-underscore-dangle */
-
-'use strict';
-
-const { join } = require('path');
-const chalk = require('chalk');
-const Version = require('./version');
+import { join } from 'path';
+import chalk from 'chalk';
+import Version from './version.js';
 
 const _name = Symbol('name');
 const _type = Symbol('type');
@@ -86,4 +82,4 @@ class Artifact {
     }
 }
 
-module.exports = Artifact;
+export default Artifact;

package/formatters/file.js

@@ -1,12 +1,5 @@
-/* eslint-disable no-restricted-properties */
-/* eslint-disable prefer-template */
-/* eslint-disable one-var */
-/* eslint-disable no-underscore-dangle */
-
-'use strict';
-
-const { join } = require('path');
-const chalk = require('chalk');
+import { join } from 'path';
+import chalk from 'chalk';
 
 function readableBytes(bytes) {
     const i = Math.floor(Math.log(bytes) / Math.log(1024)),
@@ -39,4 +32,4 @@ class File {
     }
 }
 
-module.exports = File;
+export default File;

package/formatters/index.js

@@ -1,6 +1,6 @@
-const Artifact = require('./artifact');
-const Alias = require('./alias');
-const File = require('./file');
-const Version = require('./version');
+import Artifact from './artifact.js';
+import Alias from './alias.js';
+import File from './file.js';
+import Version from './version.js';
 
-module.exports = { Artifact, Alias, Version, File };
+export { Artifact, Alias, Version, File };