@eik/cli 3.0.0-next.2 → 3.0.2

package/commands/alias.js

@@ -1,60 +1,51 @@
-/* eslint-disable no-nested-ternary */
-const ora = require('ora');
-const { configStore, getDefaults } = require('@eik/common-config-loader');
-const { getCWD, logger } = require('../utils');
+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';
 
-const Alias = require('../classes/alias');
-const { Alias: AliasFormatter } = require('../formatters');
+export const command = 'alias [name] [version] [alias]';
 
-exports.command = 'alias <name> <version> <alias>';
+export const aliases = ['a'];
 
-exports.aliases = [
-    'ma',
-    'pa',
-    'pkg-alias',
-    'na',
-    'dep-alias',
-    'dependency-alias',
-];
+export const describe = `Create or update a semver major alias for a package, NPM package or import map as identified by its name and version. A package with the given name and version must already exist on the Eik server. The 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. The alias type (npm, map, package) is detected from eik.json in the current working directory.`;
 
-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);
+export const builder = (yargs) => {
+    const defaults = getDefaults(yargs.argv.config || yargs.argv.cwd);
 
     yargs
         .positional('name', {
-            describe: `Name of package or map that is to be aliased`,
+            describe: 'Name matching a package or import map on the Eik server',
             type: 'string',
+            // @ts-expect-error
+            default: defaults.name,
         })
         .positional('version', {
-            describe: `Version for package or map that is to be aliased`,
+            describe: 'The version the alias should redirect to',
             type: 'string',
+            // @ts-expect-error
+            default: defaults.version,
         })
         .positional('alias', {
-            describe: `Alias for a semver version. Should be the semver major component of version.`,
+            describe:
+                'Alias, should be the semver major component of version. Eg. 1.0.0 should be given the alias 1',
             type: 'string',
+            // @ts-expect-error
+            default: defaults.version ? semver.major(defaults.version) : null,
         });
 
     yargs.options({
         server: {
             alias: 's',
-            describe: 'Specify location of Eik server.',
+            describe: 'Specify location of Eik asset server.',
+            // @ts-expect-error
             default: defaults.server,
         },
-        cwd: {
-            alias: 'c',
-            describe: 'Alter current working directory.',
-            default: defaults.cwd,
-        },
-        debug: {
-            describe: 'Log additional messages',
-            default: false,
-            type: 'boolean',
+        type: {
+            describe:
+                'Alter the alias type. Default is detected from eik.json. Valid values are `package`, `npm`, or `map` Eg. --type npm',
+            // @ts-expect-error
+            default: defaults.type,
         },
         token: {
             describe:
@@ -64,62 +55,51 @@ exports.builder = (yargs) => {
         },
     });
 
+    // @ts-expect-error
     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-app 1.0.0 1`);
+    yargs.example(`eik alias my-app 1.7.3 1`);
+    yargs.example(`eik alias my-app 6.3.1 6`);
     yargs.example(
-        `eik alias my-map 6.3.1 6 --server https://assets.myeikserver.com`,
+        `eik alias my-app 6.3.1 6 --server https://assets.myeikserver.com`,
     );
-    yargs.example(`eik alias my-map 4.2.2 4 --debug`);
+    yargs.example(`eik alias my-app 4.2.2 4 --debug`);
+    yargs.example(`eik alias my-app 4.2.2 4 --type package`);
 };
 
-exports.handler = async (argv) => {
+export const 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 { debug, server, type } = argv;
     const log = logger(spinner, debug);
-
-    const isPackage = ['package', 'npm'].includes(typeOverride);
+    let af;
 
     try {
         const data = await new Alias({
-            type:
-                typeOverride === 'package'
-                    ? 'pkg'
-                    : typeOverride === 'npm'
-                    ? 'npm'
-                    : typeOverride === 'map'
-                    ? 'map'
-                    : 'pkg',
+            type,
             logger: log,
             ...argv,
         }).run();
 
+        // TODO: get rid of this rediculous formatter class idea that past me put here to irk present and future me.
+        // Smells like DRY silliness
+        af = new AliasFormatter(data);
+
         const createdOrUpdated = data.update ? 'Updated' : 'Created';
         log.info(
-            `${createdOrUpdated} alias for ${isPackage ? 'package' : 'map'} "${
-                data.name
-            }". ("${data.version}" => "v${data.alias}")`,
+            `${createdOrUpdated} alias for "${type}" "${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();
+        log.warn(err.message);
+    }
+
+    spinner.text = '';
+    spinner.stopAndPersist();
+    if (success) {
+        af?.format(server);
+    } else {
         process.exit(1);
     }
 };

package/commands/index.js

@@ -0,0 +1,27 @@
+import * as init from './init.js';
+import * as integrity from './integrity.js';
+import * as login from './login.js';
+import * as mapAlias from './map-alias.js';
+import * as map from './map.js';
+import * as meta from './meta.js';
+import * as npmAlias from './npm-alias.js';
+import * as packageAlias from './package-alias.js';
+import * as ping from './ping.js';
+import * as publish from './publish.js';
+import * as version from './version.js';
+import * as alias from './alias.js';
+
+export const commands = [
+    init,
+    integrity,
+    login,
+    mapAlias,
+    map,
+    meta,
+    npmAlias,
+    packageAlias,
+    ping,
+    publish,
+    version,
+    alias,
+];

package/commands/init.js

@@ -1,41 +1,28 @@
-'use strict';
+import { join } from 'path';
+import fs from 'fs';
+import ora from 'ora';
+import { logger } from '../utils/index.js';
 
-const { join } = require('path');
-const fs = require('fs');
-const ora = require('ora');
-const { logger } = require('../utils');
+const command = 'init';
 
-exports.command = 'init';
+const aliases = ['i'];
 
-exports.aliases = ['i'];
+const describe = `Creates an eik.json file and saves it to the current working directory. If package.json exists in the directory its name and version will be used as the default. Override defaults using command line flags.`;
 
-exports.describe = `Creates a new default "eik.json" file and saves it to the current working directory
-    Override default "eik.json" fields using command line flags --server, --name, --major, --js and --css`;
-
-exports.builder = (yargs) => {
+const builder = (yargs) => {
     yargs.example('eik init');
     yargs.example('eik init --cwd /path/to/dir');
     yargs.example(
-        'eik init --server https://assets.myserver.com --major 2 --name my-app --js ./scripts.js --css ./styles.css',
+        'eik init --server https://assets.myserver.com --version 2.0.0 --name my-app --files "./public"',
     );
     yargs.example('eik init --debug');
 
     yargs.options({
         server: {
             alias: 's',
-            describe: `Specify asset server field in "eik.json".
-                This the URL to an Eik asset server
-                Eg. --server https://assets.myeikserver.com`,
+            describe: `Specify asset server field in "eik.json". This the URL to an Eik asset server Eg. --server https://assets.myeikserver.com`,
             default: '',
         },
-        cwd: {
-            alias: 'c',
-            describe: `Alter the current working directory
-                Defaults to the directory where the command is being run.
-                This affects where the generated "eik.json" file will be saved.
-                Eg. --cwd /path/to/save/to`,
-            default: process.cwd(),
-        },
         version: {
             alias: 'v',
             describe: `Specify the semver version field in "eik.json". Eg. --version 1.0.0`,
@@ -47,59 +34,89 @@ exports.builder = (yargs) => {
                 Eg. --name my-great-app`,
             default: '',
         },
-        debug: {
-            describe: 'Logs additional messages during command run',
-            default: false,
-            type: 'boolean',
-        },
     });
 };
 
-exports.handler = async (argv) => {
-    const spinner = ora({ stream: process.stdout }).start('working...');
-    const { name, version, server, cwd, debug } = argv;
+const handler = async (argv) => {
+    let { name, version } = argv;
+    const { server, cwd, debug } = argv;
     const pathname = join(cwd, './eik.json');
+
+    const spinner = ora({ stream: process.stdout }).start('working...');
     const log = logger(spinner, debug);
-    let assetFileExists = false;
 
     try {
-        log.debug(
-            `Checking for existing "eik.json" file in directory (${cwd})`,
-        );
+        log.debug(`Checking for existing ${pathname}`);
+
+        let eikJsonExists = false;
         try {
             const st = fs.statSync(pathname);
             if (st.isFile()) {
-                assetFileExists = true;
+                eikJsonExists = true;
             }
         } catch (err) {
             // noop
         }
-
-        if (assetFileExists) {
+        if (eikJsonExists) {
             throw new Error(
                 `An "eik.json" file already exists in directory. File will not be written`,
             );
         }
 
-        log.debug(`Writing "eik.json" to directory (${cwd})`);
-        fs.writeFileSync(
-            pathname,
-            JSON.stringify(
-                {
-                    name,
-                    version,
-                    server,
-                    files: {},
-                },
-                null,
-                2,
-            ),
+        if (!name || !version || version === '1.0.0') {
+            log.debug('Looking for default from package.json');
+            try {
+                let packageJson = fs.readFileSync(
+                    join(cwd, 'package.json'),
+                    'utf-8',
+                );
+                packageJson = JSON.parse(packageJson);
+                if (!name) {
+                    name = packageJson.name;
+                    log.debug(
+                        `Using ${name} from package.json as default name`,
+                    );
+                }
+                if (!version || version === '1.0.0') {
+                    version = packageJson.version;
+                    log.debug(
+                        `Using ${version} from package.json as default version`,
+                    );
+                }
+            } catch (e) {
+                // noop
+            }
+        } else {
+            log.debug(`Got ${name} and ${version}, skipping package.json`);
+        }
+
+        log.debug(`Writing to ${pathname}`);
+
+        const output = JSON.stringify(
+            {
+                $schema:
+                    'https://raw.githubusercontent.com/eik-lib/common/main/lib/schemas/eikjson.schema.json',
+                name,
+                version,
+                server,
+                files: './public',
+                'import-map': [],
+            },
+            null,
+            2,
         );
+        fs.writeFileSync(pathname, output);
+
+        log.info(`Wrote to ${pathname}
 
-        log.info(`"eik.json" successfully written to directory`);
+${output}
+
+Read more about configuring Eik on https://eik.dev/docs/reference/eik-json`);
     } catch (err) {
         log.warn(err.message);
     }
     spinner.text = '';
     spinner.stopAndPersist();
 };
+
+export { command, aliases, describe, builder, handler };

package/commands/integrity.js

@@ -1,55 +1,38 @@
-/* eslint-disable prefer-template */
-/* eslint-disable no-restricted-properties */
-/* eslint-disable one-var */
+import { join } from 'path';
+import ora from 'ora';
+import Integrity from '../classes/integrity.js';
+import { logger, getDefaults } from '../utils/index.js';
+import json from '../utils/json/index.js';
 
-'use strict';
+export const command = 'integrity [name] [version]';
 
-const { join } = require('path');
-const ora = require('ora');
-const { configStore, getDefaults } = require('@eik/common-config-loader');
-const Integrity = require('../classes/integrity');
-const { logger, getCWD } = require('../utils');
-const json = require('../utils/json');
+export const aliases = ['int'];
 
-exports.command = 'integrity [name] [version]';
+export const describe = `Retrieve file integrity information for package name and version defined in eik.json, then populate integrity.json file with this information`;
 
-exports.aliases = ['int'];
-
-exports.describe = `Retrieve file integrity information for package name and version defined in eik.json, then populate integrity.json file with this information`;
-
-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({
         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 integrity`);
     yargs.example(`eik integrity --debug`);
 };
 
-exports.handler = async (argv) => {
+export const handler = async (argv) => {
     const spinner = ora({ stream: process.stdout }).start('working...');
     let integrity = false;
-    const { debug, cwd } = argv;
+    const { debug, cwd, config } = argv;
     const l = logger(spinner, debug);
-    const config = configStore.findInDirectory(cwd);
-    const { name, server, version, type, out } = config;
+    // @ts-expect-error
+    const { name, version, server, out, type } = getDefaults(config || cwd);
 
     try {
         integrity = await new Integrity({

package/commands/login.js

@@ -1,60 +1,44 @@
-'use strict';
+import os from 'os';
+import readline from 'readline';
+import ora from 'ora';
+import Login from '../classes/login.js';
+import { logger, getDefaults } from '../utils/index.js';
+import json from '../utils/json/index.js';
 
-const homedir = require('os').homedir();
-const { getDefaults } = require('@eik/common-config-loader');
-const readline = require('readline');
-const ora = require('ora');
-const Login = require('../classes/login');
-const { logger, getCWD } = require('../utils');
-const json = require('../utils/json');
+const homedir = os.homedir();
 
-exports.command = 'login';
+export const command = 'login';
 
-exports.aliases = [];
+export const aliases = [];
 
-exports.describe = `Authenticate against an Eik server and save the returned token to an .eikrc file in the users home directory.
-    You can specify key and server values to authenticate against using the --key and --server flags which will then bypass login prompts
-    It is possible to be authenticated against multiple asset servers simultaneously. Simply call "eik login" multiple times.`;
+export const describe = `Authenticate against an Eik server and save the returned token to an .eikrc file in the users home directory. You can specify key and server values to authenticate against using the --key and --server flags which will then bypass login prompts. It is possible to be authenticated against multiple asset servers simultaneously. Simply call "eik login" multiple times.`;
 
-exports.builder = (yargs) => {
+export const builder = (yargs) => {
     yargs.example('eik login --server https://assets.myserver.com');
     yargs.example(
         'eik login --server https://assets.myserver.com --key ######',
     );
     yargs.example('eik login --server https://assets.myserver.com --debug');
 
-    const cwd = getCWD();
-    const defaults = getDefaults(cwd);
+    const defaults = getDefaults(yargs.argv.config || yargs.argv.cwd);
 
     yargs.options({
         server: {
             alias: 's',
-            describe: `Eik server address
-                Specify location of the Eik asset server to authenticate against.
-                If an eik.json file is present in the current working directory, the files server value will be used as default.
-                If no eik.json file is present in the current working directory and this flag is not specified, a prompt will be presented to ask for the server address to be input
-                Eg. --server https://assets.myeikserver.com`,
+            describe: `Eik server address. Specify location of the Eik asset server to authenticate against. If an eik.json file is present in the current working directory, the files server value will be used as default. If no eik.json file is present in the current working directory and this flag is not specified, a prompt will be presented to ask for the server address to be input. Eg. --server https://assets.myeikserver.com`,
             type: 'string',
             default: defaults.server,
         },
         key: {
             alias: 'k',
-            describe: `Login access key. 
-                This is a passkey for a given user account and needs to be configured on the server.
-                If this flag is not specifed, a prompt will be used to ask for the key to be input.
-                Eg. --key ########`,
+            describe: `Login access key. This is a passkey for a given user account and needs to be configured on the server. If this flag is not specifed, a prompt will be used to ask for the key to be input. Eg. --key ########`,
             type: 'string',
             default: '',
         },
-        debug: {
-            describe: 'Logs additional messages',
-            default: false,
-            type: 'boolean',
-        },
     });
 };
 
-exports.handler = async (argv) => {
+export const handler = async (argv) => {
     let success = false;
     const { debug, key, server } = argv;
     let k = key;
@@ -70,8 +54,9 @@ exports.handler = async (argv) => {
 
     if (!s) {
         await new Promise((resolve) => {
-            rl.question('Enter Eik server address > ', (input) => {
+            rl?.question('Enter Eik server address > ', (input) => {
                 s = input;
+                // @ts-expect-error
                 resolve();
             });
         });
@@ -79,8 +64,9 @@ exports.handler = async (argv) => {
 
     if (!k) {
         await new Promise((resolve) => {
-            rl.question('Enter login key > ', (input) => {
+            rl?.question(`Enter login key for ${s} > `, (input) => {
                 k = input;
+                // @ts-expect-error
                 resolve();
             });
         });
@@ -93,13 +79,14 @@ exports.handler = async (argv) => {
     try {
         const token = await new Login({
             logger: logger(spinner, debug),
-            debug,
             key: k,
             server: s,
         }).run();
 
         if (token) {
-            const meta = await json.read({ cwd: homedir, filename: '.eikrc' });
+            const meta = /** @type {{ tokens: any }} */ (
+                await json.read({ cwd: homedir, filename: '.eikrc' })
+            );
 
             const tokens = new Map(meta.tokens);
             tokens.set(s, token);
@@ -109,6 +96,7 @@ exports.handler = async (argv) => {
             success = true;
         }
     } catch (err) {
+        // @ts-expect-error
         logger.warn(err.message);
     }
 

package/commands/map-alias.js

@@ -0,0 +1,95 @@
+// @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 = 'map-alias <name> <version> <alias>';
+
+export const aliases = ['ma'];
+
+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 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`;
+
+export const builder = (yargs) => {
+    const defaults = getDefaults(yargs.argv.config || yargs.argv.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.',
+            // @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-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`);
+};
+
+export const 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);
+    }
+};
+
+export const deprecated =
+    '"map-alias" will be removed in a future version. Please use "alias" instead';