@gkalpak/aliases 0.9.4 → 0.10.1

package/lib/alias.js

@@ -1,8 +1,7 @@
 /* eslint-disable max-classes-per-file */
-'use strict';
-
 // Imports
-const utils = require('./utils');
+import {getPlatform} from './utils.js';
+
 
 // Interfaces
 /*
@@ -38,7 +37,7 @@ class Alias/* implements IAlias */ {
       filter(platform => platform !== 'default');
   }
 
-  getSpec(platform = utils.getPlatform())/* IAliasSpec */ {
+  getSpec(platform = getPlatform())/* IAliasSpec */ {
     return this._specPerPlatform[platform] || this._specPerPlatform.default;
   }
 }
@@ -79,7 +78,7 @@ class AliasSpecDefault extends AliasSpec {
 }
 
 // Exports
-module.exports = {
+export {
   Alias,
   AliasDefault,
   AliasSpec,

package/lib/constants.js

@@ -1,16 +1,22 @@
-'use strict';
-
 // Imports
-const path = require('path');
-const pkg = require('../package.json');
-const {Alias, AliasDefault, AliasSpec, AliasSpecDefault, AliasUnknown} = require('./alias');
-const {PR_LOCAL_BRANCH_PREFIX, PR_REMOTE_ALIAS_PREFIX} = require('./alias-scripts/gcoghpr');
-const utils = require('./utils');
+import {join, resolve as pathResolve} from 'node:path';
+import {fileURLToPath} from 'node:url';
+
+import {Alias, AliasDefault, AliasSpec, AliasSpecDefault, AliasUnknown} from './alias.js';
+import {loadJson, stripIndentation} from './utils.js';
+
 
 // Constants
-const VERSION_STAMP = `${pkg.name} v${pkg.version}`;
-const ROOT_DIR = path.resolve(__dirname, '..');
-const BIN_DIR = path.join(ROOT_DIR, 'bin');
+const __dirname = fileURLToPath(new URL('.', import.meta.url));
+const ROOT_DIR = pathResolve(__dirname, '..');
+const BIN_DIR = join(ROOT_DIR, 'bin');
+
+const __pkg = loadJson(join(ROOT_DIR, 'package.json'));
+const VERSION_STAMP = `${__pkg.name} v${__pkg.version}`;
+
+const PR_REMOTE_ALIAS_PREFIX = 'gcoghpr';
+const PR_LOCAL_BRANCH_PREFIX = 'gcoghpr';
+
 const SOURCE_NVM_CMD = '. $NVM_DIR/nvm.sh';
 const GIT_GET_DEFAULT_BRANCH_CMD =
     `${['master', 'main'].map(b => `(git show-ref --heads --quiet ${b} && echo ${b})`).join(' || ')} || ` +
@@ -42,14 +48,14 @@ const DESC_REPLACEMENTS = {
   '::__g-pick-commit --gkcu-returnOutput=1': '(interactively pick a commit)',
 };
 
-const DEF_CODE = AliasSpecDefault.DEF_CODE = (cmd, cfg = {}) => utils.stripIndentation(`
+const DEF_CODE = AliasSpecDefault.DEF_CODE = (cmd, cfg = {}) => stripIndentation(`
   #!/usr/bin/env node
-  'use strict';
+  import {commandUtils} from '@gkalpak/cli-utils';
+  import {isMain, onError} from '../../lib/utils.js';
   // eslint-disable-next-line max-len
-  const cmd = module.exports = '${cmd.replace(/'/g, '\\\'')}';
-  if (require.main === module) {
-    const {commandUtils} = require('@gkalpak/cli-utils');
-    const {onError} = require('../../lib/utils');
+  const cmd = '${cmd.replace(/'/g, '\\\'')}';
+  export default cmd;
+  if (isMain(import.meta.url)) {
     const {args, config} = commandUtils.preprocessArgs(process.argv.slice(2));
     // eslint-disable-next-line quotes
     commandUtils.run(cmd, args, Object.assign(${JSON.stringify(cfg)}, config)).catch(onError);
@@ -58,12 +64,11 @@ const DEF_CODE = AliasSpecDefault.DEF_CODE = (cmd, cfg = {}) => utils.stripInden
 
 const CFGBASH_SPEC = isWsl => new AliasSpec(
     /* eslint-disable max-len */
-    utils.stripIndentation(`
+    stripIndentation(`
       #!/usr/bin/env node
-      'use strict';
-      const utils = require('../../lib/utils');
+      import {stripIndentation} from '../../lib/utils.js';
       /* eslint-disable max-len */
-      console.log(utils.stripIndentation(\`
+      console.log(stripIndentation(\`
         ### [Generated by: ${VERSION_STAMP}]
         ### Copy the following into '~/.bashrc':
 
@@ -86,11 +91,10 @@ const CFGBASH_SPEC = isWsl => new AliasSpec(
     'Show configuration instructions for `bash`.');
 
 const CFGGIT_SPEC_WITH_CRED_HELPER = credHelper => new AliasSpec(
-    utils.stripIndentation(`
+    stripIndentation(`
       #!/usr/bin/env node
-      'use strict';
-      const utils = require('../../lib/utils');
-      console.log(utils.stripIndentation(\`
+      import {stripIndentation} from '../../lib/utils.js';
+      console.log(stripIndentation(\`
         ### [Generated by: ${VERSION_STAMP}]
         ### Run the following commands:
 
@@ -111,16 +115,14 @@ const CFGGIT_SPEC_WITH_CRED_HELPER = credHelper => new AliasSpec(
     `),
     'Show configuration instructions for `git`.');
 
-const SCRIPT_BACKED_CODE = (scriptName, desc) => utils.stripIndentation(`
+const SCRIPT_BACKED_CODE = (scriptName, desc) => stripIndentation(`
   #!/usr/bin/env node
-  'use strict';
-  module.exports = '${desc.replace(/'/g, '\\\'')}';
-  if (require.main === module) {
-    const {commandUtils} = require('@gkalpak/cli-utils');
-    const {onError} = require('../../lib/utils');
+  import {commandUtils} from '@gkalpak/cli-utils';
+  import {main} from '../../lib/alias-scripts/${scriptName}.js';
+  import {isMain, onError} from '../../lib/utils.js';
+  export default '${desc.replace(/'/g, '\\\'')}';
+  if (isMain(import.meta.url)) {
     const {args, config} = commandUtils.preprocessArgs(process.argv.slice(2));
-
-    const {main} = require('../../lib/alias-scripts/${scriptName}');
     main(args, config).catch(onError);
   }
 `);
@@ -302,7 +304,7 @@ const ALIASES = {
     gcp: new AliasDefault('git cherry-pick $*'),
     gcpc: new AliasDefault('git cherry-pick --continue'),
     gcpa: new AliasDefault('git cherry-pick --abort'),
-    gcpx: new AliasDefault(utils.stripIndentation(`
+    gcpx: new AliasDefault(stripIndentation(`
       echo "  Cherry-picking SHA: $1  " &&
       echo "----------------------------------------------------------------" &&
       echo "                                                                " &&
@@ -471,18 +473,20 @@ const ALIASES = {
     cfggit: new Alias({
       default: CFGGIT_SPEC_WITH_CRED_HELPER('manager'),
       wsl: CFGGIT_SPEC_WITH_CRED_HELPER(
-          '/mnt/c/Program\\\\ Files/Git/mingw64/bin/git-credential-manager-core.exe'),
+          '/mnt/c/Program\\\\ Files/Git/mingw64/bin/git-credential-manager.exe'),
     }),
 
 
     // VIM
     cfgvim: new Alias(new AliasSpec(
-        utils.stripIndentation(`
+        stripIndentation(`
           #!/usr/bin/env node
-          'use strict';
+          import {readFileSync} from 'node:fs';
+          import {fileURLToPath} from 'node:url';
+          const __dirname = fileURLToPath(new URL('.', import.meta.url));
           console.log('""" [Generated by: ${VERSION_STAMP}]');
           console.log('""" Copy the following into \\'~/.vimrc\\':\\n');
-          console.log(require('fs').readFileSync(\`\${__dirname}/../../lib/assets/vimrc.txt\`, 'utf8').trim() + '\\n');
+          console.log(readFileSync(\`\${__dirname}/../../lib/assets/vimrc.txt\`, 'utf8').trim() + '\\n');
         `),
         'Show configuration instructions for `vim`.')),
   },
@@ -508,25 +512,24 @@ const ALIASES = {
 
 
     // SELF-UPDATE
-    salfup: new AliasDefault(`npm install --global ${pkg.name} $*`),
+    salfup: new AliasDefault(`npm install --global ${__pkg.name} $*`),
 
     // VERSION
     alv: new Alias(new AliasSpec(
-        utils.stripIndentation(`
+        stripIndentation(`
           #!/usr/bin/env node
-          'use strict';
           console.log('${VERSION_STAMP}');
         `),
-        `Display the installed version of ${pkg.name}.`)),
+        `Display the installed version of ${__pkg.name}.`)),
 
     // HELP
     halp: new Alias(new AliasSpec(
-        utils.stripIndentation(`
+        stripIndentation(`
           #!/usr/bin/env node
-          'use strict';
-          require('../../lib/helper').help(...process.argv.slice(2));
+          import {help} from '../../lib/helper.js';
+          help(...process.argv.slice(2));
         `),
-        utils.stripIndentation(`
+        stripIndentation(`
           Display this message. Variations:
           - Pass a category name to list aliases of the specified category only.
             (Example: \`halp node\`)
@@ -537,13 +540,31 @@ const ALIASES = {
         `))),
   },
 };
+const internal = {
+  _getDescReplacements,
+};
 
 // Exports
-module.exports = {
+export {
   ALIASES,
   BIN_DIR,
   DEF_CODE,
-  DESC_REPLACEMENTS,
+  PR_REMOTE_ALIAS_PREFIX,
+  PR_LOCAL_BRANCH_PREFIX,
   ROOT_DIR,
   VERSION_STAMP,
+
+  getDescReplacements,
+
+  // Exposed for testing purposes only.
+  internal as _testing,
 };
+
+// Helpers
+function _getDescReplacements() {
+  return DESC_REPLACEMENTS;
+}
+
+function getDescReplacements() {
+  return internal._getDescReplacements();
+}

package/lib/helper.js

@@ -1,13 +1,18 @@
-'use strict';
-
 // Imports
-const chalk = require('chalk');
-const {AliasUnknown} = require('./alias');
-const constants = require('./constants');
-const utils = require('./utils');
+import chalk from 'chalk';
+
+import {AliasUnknown} from './alias.js';
+import {ALIASES, getDescReplacements, VERSION_STAMP} from './constants.js';
+import {capitalize, hasOwnProperty, onError, padRight, wrapLine} from './utils.js';
+
+
+// Constants
+const internal = {
+  _helpForCategory,
+};
 
 // Exports
-const helper = module.exports = {
+export {
   /**
    * @function help
    *
@@ -32,67 +37,33 @@ const helper = module.exports = {
    *
    * @return {Promise<void>} - A promise that resolves once the message has been printed.
    */
-  help: _help,
+  help,
 
-  /** Exposed for testing purposes only. */
-  _helpForCategory: helpForCategory,
+  // Exposed for testing purposes only.
+  internal as _testing,
 };
 
-// Functions - Definitions
-function _help(...names) {
-  const showAll = !names.length;
-  const showCategory = (names.length === 1) && constants.ALIASES.hasOwnProperty(names[0]);
-  const showAliases = !showAll && !showCategory;
+// Helpers
+function _helpForCategory(category, joiner) {
+  const publicAliases = Object.keys(category.spec).filter(aliasName => !/^__/.test(aliasName));
+  const maxNameLen = Math.max(...publicAliases.map(a => a.length));
+  const indent1 = ' '.repeat(2);
+  const indent2 = ' '.repeat(indent1.length + maxNameLen + joiner.length);
 
-  return Promise.resolve().
-    then(() => {
-      const sep = '~'.repeat(75);
-      const joiner = '  -->  ';
-
-      const matchedCategories = showAliases ?
-        createCategoriesOnTheFly(names) :
-        Object.keys(constants.ALIASES).
-          filter(categoryName => showAll || (categoryName === names[0])).
-          map(categoryName => ({name: categoryName, spec: constants.ALIASES[categoryName]}));
-
-      const header = !showAll ? `${constants.VERSION_STAMP}\n` : [
-        '',
-        versionHeader(),
-        '',
-        ' Available aliases',
-        '===================',
-        '',
-      ].join('\n');
-      const mainSection = matchedCategories.
-        filter(category => Object.keys(category.spec).length).
-        map(category => helper._helpForCategory(category, joiner)).
-        join(`\n\n${chalk.gray(sep)}\n\n`) || chalk.yellowBright('  Nothing to see here :(');
-      const footer = showAliases ? '' : [
-        '',
-        chalk.magenta(sep),
-        '',
-        'All aliases also accept the following arguments:',
-        '--gkcu-debug:       Produce verbose, debug-friendly output.',
-        '--gkcu-dryrun:      Print the command instead of actually running it. (Still experimental.)',
-        '--gkcu-sapVersion:  Choose a different implementation for the command runner. (Default: 2)',
-        '--gkcu-suppressTbj: Suppress the "Terminate batch job (Y/N)?" confirmation on Windows. (Still experimental.)',
-        '                    Does not work with certain types of commands (e.g. `vim`).',
-        '',
-        utils.wrapLine(
-            '(NOTE: All arguments starting with `--gkcu-` will be ignored when substituting input arguments or ' +
-            'determining their index.)'),
-        '',
-      ].join('\n');
-
-      const message = [
-        chalk.magenta(header),
-        mainSection,
-        chalk.gray(footer),
-      ].join('\n');
-
-      console.log(message);
-    }).
-    catch(utils.onError);
+  const headerStyle = category.problematic ? chalk.yellowBright : chalk.cyan;
+  const aliasStyle = category.problematic ? chalk.red : chalk.green;
+
+  const headerText = `${category.name} aliases${category.partial ? ' subset' : ''}:`;
+
+  return [
+    headerStyle(capitalize(headerText)),
+    '',
+    publicAliases.
+      map(aliasName => [aliasName, getDescription(category.spec[aliasName])]).
+      map(([aliasName, aliasDesc]) => [padRight(aliasName, maxNameLen), wrapMultiline(aliasDesc, indent2)]).
+      map(([aliasName, aliasDesc]) => `${indent1}${aliasStyle(aliasName)}${chalk.gray(joiner)}${aliasDesc}`).
+      join('\n'),
+  ].join('\n');
 }
 
 function createCategoriesOnTheFly(aliasNames) {
@@ -117,11 +88,11 @@ function createCategoriesOnTheFly(aliasNames) {
   const foundNames = [];
 
   // For each category...
-  Object.keys(constants.ALIASES).
+  Object.keys(ALIASES).
     // ...create a partial category...
     map(categoryName => addNewPartialCategory(categoryName)).
     // ...retrieve the original spec...
-    map(partialCategory => [partialCategory.spec, constants.ALIASES[partialCategory.name]]).
+    map(partialCategory => [partialCategory.spec, ALIASES[partialCategory.name]]).
     // ...get all aliases in the category...
     forEach(([partialSpec, originalSpec]) => Object.keys(originalSpec).
       // ...find the ones we are interested in (if any)...
@@ -146,38 +117,75 @@ function createCategoriesOnTheFly(aliasNames) {
 function getDescription(alias) {
   let desc = alias.getSpec().description;
 
-  Object.keys(constants.DESC_REPLACEMENTS).forEach(original => {
-    const repl = constants.DESC_REPLACEMENTS[original];
+  Object.entries(getDescReplacements()).forEach(([original, repl]) => {
     desc = desc.split(original).join(repl);
   });
 
   return desc;
 }
 
-function helpForCategory(category, joiner) {
-  const publicAliases = Object.keys(category.spec).filter(aliasName => !/^__/.test(aliasName));
-  const maxNameLen = Math.max(...publicAliases.map(a => a.length));
-  const indent1 = ' '.repeat(2);
-  const indent2 = ' '.repeat(indent1.length + maxNameLen + joiner.length);
-
-  const headerStyle = category.problematic ? chalk.yellowBright : chalk.cyan;
-  const aliasStyle = category.problematic ? chalk.red : chalk.green;
+async function help(...names) {
+  const showAll = !names.length;
+  const showCategory = (names.length === 1) && hasOwnProperty(ALIASES, names[0]);
+  const showAliases = !showAll && !showCategory;
 
-  const headerText = `${category.name} aliases${category.partial ? ' subset' : ''}:`;
+  try {
+    const sep = '~'.repeat(75);
+    const joiner = '  -->  ';
+
+    const matchedCategories = showAliases ?
+      createCategoriesOnTheFly(names) :
+      Object.entries(ALIASES).
+        filter(([categoryName]) => showAll || (categoryName === names[0])).
+        map(([name, spec]) => ({name, spec}));
+
+    const header = !showAll ? `${VERSION_STAMP}\n` : [
+      '',
+      versionHeader(),
+      '',
+      ' Available aliases',
+      '===================',
+      '',
+    ].join('\n');
+    const mainSection = matchedCategories.
+      filter(category => Object.keys(category.spec).length).
+      map(category => helpForCategory(category, joiner)).
+      join(`\n\n${chalk.gray(sep)}\n\n`) || chalk.yellowBright('  Nothing to see here :(');
+    const footer = showAliases ? '' : [
+      '',
+      chalk.magenta(sep),
+      '',
+      'All aliases also accept the following arguments:',
+      '--gkcu-debug:       Produce verbose, debug-friendly output.',
+      '--gkcu-dryrun:      Print the command instead of actually running it. (Still experimental.)',
+      '--gkcu-sapVersion:  Choose a different implementation for the command runner. (Default: 2)',
+      '--gkcu-suppressTbj: Suppress the "Terminate batch job (Y/N)?" confirmation on Windows. (Still experimental.)',
+      '                    Does not work with certain types of commands (e.g. `vim`).',
+      '',
+      wrapLine(
+          '(NOTE: All arguments starting with `--gkcu-` will be ignored when substituting input arguments or ' +
+          'determining their index.)'),
+      '',
+    ].join('\n');
+
+    const message = [
+      chalk.magenta(header),
+      mainSection,
+      chalk.gray(footer),
+    ].join('\n');
+
+    console.log(message);
+  } catch (err) {
+    await onError(err);
+  }
+}
 
-  return [
-    headerStyle(utils.capitalize(headerText)),
-    '',
-    publicAliases.
-      map(aliasName => [aliasName, getDescription(category.spec[aliasName])]).
-      map(([aliasName, aliasDesc]) => [utils.padRight(aliasName, maxNameLen), wrapMultiline(aliasDesc, indent2)]).
-      map(([aliasName, aliasDesc]) => `${indent1}${aliasStyle(aliasName)}${chalk.gray(joiner)}${aliasDesc}`).
-      join('\n'),
-  ].join('\n');
+function helpForCategory(category, joiner) {
+  return internal._helpForCategory(category, joiner);
 }
 
 function versionHeader() {
-  const versionLine = `|  ${constants.VERSION_STAMP}  |`;
+  const versionLine = `|  ${VERSION_STAMP}  |`;
   const len = versionLine.length - 2;
   const outerLine = ` ${'-'.repeat(len)} `;
   const innerLine = `|${' '.repeat(len)}|`;
@@ -194,7 +202,7 @@ function versionHeader() {
 function wrapMultiline(input, wrapIndent) {
   return input.
     split('\n').
-    map(l => utils.wrapLine(l, wrapIndent)).
+    map(l => wrapLine(l, wrapIndent)).
     map((l, i) => (i === 0) ? l : `${wrapIndent}${l}`).
     join('\n');
 }