@abcnews/aunty 16.0.1 → 17.0.0-next.2

package/src/cli/constants.js

@@ -1,114 +0,0 @@
-// Ours
-const { createLogo } = require('../utils/branding');
-const { cmd, dim, hvy, opt, req, sec } = require('../utils/color');
-
-const COMMAND_ALIASES = (module.exports.COMMAND_ALIASES = {
-  b: 'build',
-  c: 'clean',
-  d: 'deploy',
-  g: 'generate',
-  r: 'release',
-  s: 'serve',
-  sc: 'sign-cert',
-  t: 'test'
-});
-
-module.exports.COMMANDS = new Set(Object.values(COMMAND_ALIASES));
-
-module.exports.DEFAULTS = {
-  name: '__command__',
-  options: {
-    '--': true,
-    boolean: ['dry', 'force', 'help', 'quiet'],
-    string: [],
-    alias: {
-      dry: 'd',
-      force: 'f',
-      help: 'h',
-      quiet: 'q'
-    }
-  },
-  usage: name => `Usage: ${cmd('aunty')} ${cmd(name)} ${opt('[options]')}
-`
-};
-
-module.exports.DRY_VARIATIONS = ['--dry', '-d'];
-module.exports.HELP_VARIATIONS = ['--help', '-h', 'h', 'help'];
-module.exports.VERSION_VARIATIONS = ['--version', '-v'];
-
-module.exports.MESSAGES = {
-  version: versionNumber => `
-${cmd('aunty')} v${versionNumber}`,
-  unrecognised: commandName => `Unrecognised command: ${req(commandName)}`,
-  usage: isProject => `${createLogo()}
-
-Usage: ${cmd('aunty')} ${req('<command>')} ${opt('[options]')} ${opt('[command_options]')}
-
-${sec('Options')}
-
-  ${opt('-v')}, ${opt('--version')}  Print ${hvy('aunty')}'s version
-
-${sec('Project creation commands')}
-
-  ${
-    !isProject
-      ? `${cmd('aunty new')} ${req('<project_name>')}
-    Create a project in a new directory
-
-  ${cmd('aunty init')}
-    Create a project in the current directory`
-      : dim(`[available outside project directory]`)
-  }
-
-${sec('Development commands')}
-
-  ${
-    isProject
-      ? `${cmd('aunty generate')} ${req('<generator>')}
-    Generate code for your project or Core Media
-
-  ${cmd('aunty clean')}
-    Delete the current project's build output directories.
-
-  ${cmd('aunty build')}
-    Clean & build the current project.
-
-  ${cmd('aunty serve')}
-    Build & serve the current project, re-building as files change
-
-  ${cmd('aunty test')}
-    Run any tests in the current project.`
-      : dim(`[available inside project directory]`)
-  }
-
-${sec('Deployment commands')}
-
-  ${
-    isProject
-      ? `${cmd('aunty deploy')}
-    Deploy the current project.
-
-  ${cmd('aunty release')}
-    Build, version bump, then deploy the current project.`
-      : dim(`[available inside project directory]`)
-  }
-
-${sec('Helper commands')}
-
-  ${cmd('aunty help')} ${req('<command>')}
-    Display complete help for this ${req('command')}.
-
-  ${cmd('aunty sign-cert')} # Mac OS only (for now)
-    Create a consistent SSL certificate for the dev server
-`
-};
-
-const NEW_SHORTHAND_EXPANSION = ['generate', 'project', '--'];
-const INIT_SHORTHAND_EXPANSION = NEW_SHORTHAND_EXPANSION.concat(['--here']);
-
-module.exports.SHORTHANDS = {
-  i: INIT_SHORTHAND_EXPANSION,
-  init: INIT_SHORTHAND_EXPANSION,
-  n: NEW_SHORTHAND_EXPANSION,
-  new: NEW_SHORTHAND_EXPANSION
-};

package/src/cli/deploy/constants.js

@@ -1,40 +0,0 @@
-// Ours
-const { cmd, hvy, opt, req, sec } = require('../../utils/color');
-const { styleLastSegment } = require('../../utils/text');
-
-const VALID_TYPES = (module.exports.VALID_TYPES = new Map());
-VALID_TYPES.set('ftp', {
-  REQUIRED_PROPERTIES: ['from', 'to', 'type', 'username', 'password', 'host']
-});
-VALID_TYPES.set('ssh', {
-  REQUIRED_PROPERTIES: ['from', 'to', 'type', 'username', 'host']
-});
-
-module.exports.MESSAGES = {
-  deploy: ({ from, host, to, type }) => `Deploy (${hvy(type)}):
-  ┣ ${hvy('from')}: ${styleLastSegment(from, req)}
-  ┣ ${hvy('to')}: ${styleLastSegment(to, req)}
-  ┗ ${hvy('host')}: ${req(host)}`,
-  deployed: publicPath => `Deployed at ${sec(publicPath)}`,
-  deploying: 'Deploying',
-  missingProperty: prop => `Missing required property: '${hvy(prop)}'`,
-  noDeployConfigFile:
-    'No deploy configuration file was found, or its format was unrecognisable. Please re-build the project.',
-  noFromDirectory: from => `Directory specified by 'from' property does not exist: ${hvy(from)}`,
-  publicURL: url => `Public URL: ${hvy(url)}`,
-  unrecognisedType: type =>
-    `${type ? 'Unrecognised' : 'No'} deploy type${type ? `: ${hvy(type)}` : ''}. Acceptable types are: ${Array.from(
-      VALID_TYPES.keys()
-    )
-      .map(x => hvy(x))
-      .join(', ')}`,
-
-  // TODO: Add aunty config section to usage
-  usage: name => `Usage: ${cmd(`aunty ${name}`)} ${opt('[options]')}
-
-${sec('Options')}
-
-  ${opt('-d')}, ${opt('--dry')}    Output the deploy configuration, then exit
-  ${opt('-f')}, ${opt('--force')}  Do not prompt to overwrite ftp deploy directory ${opt('[default: false]')}
-`
-};

package/src/cli/deploy/index.js

@@ -1,151 +0,0 @@
-// Native
-const { existsSync, statSync } = require('fs');
-const { join } = require('path');
-
-// External
-const importLazy = require('import-lazy')(require);
-const loadJsonFile = importLazy('load-json-file');
-const { deploymentExists } = require('../../utils/ftp');
-const { to: wrap } = require('await-to-js');
-const cliSelect = importLazy('cli-select');
-
-// Ours
-const { command } = require('../');
-const { addProfileProperties } = require('../../config/deploy');
-const { getProjectConfig } = require('../../config/project');
-const { DEPLOY_FILE_NAME, OUTPUT_DIRECTORY_NAME } = require('../../constants');
-const { throws } = require('../../utils/async');
-const { dry, info, spin, warn, log, error } = require('../../utils/logging');
-const { ftp, rsync } = require('../../utils/remote');
-const { MESSAGES, VALID_TYPES } = require('./constants');
-const { dim, opt, hvy, req } = require('../../utils/color');
-
-module.exports = command(
-  {
-    name: 'deploy',
-    usage: MESSAGES.usage
-  },
-  async argv => {
-    const { root } = getProjectConfig();
-    let deployConfig;
-
-    // 1) Load the deploy configuration (created by the build process)
-
-    try {
-      deployConfig = loadJsonFile.sync(join(root, OUTPUT_DIRECTORY_NAME, DEPLOY_FILE_NAME));
-    } catch (err) {
-      throw new Error(MESSAGES.noDeployConfigFile);
-    }
-
-    let { id, targets } = deployConfig;
-
-    if (!Array.isArray(targets)) {
-      throw new Error(MESSAGES.noDeployConfigFile);
-    }
-
-    // 2) Add profile properties (type, host, port, username, password) to each target
-
-    targets = targets.map(addProfileProperties);
-
-    // 3) Validate the deploy configuration
-
-    for (let target of targets) {
-      const { from, type } = target;
-
-      // 3.1) Check profile's 'type' is valid
-      if (!VALID_TYPES.has(type)) {
-        throw MESSAGES.unrecognisedType(type);
-      }
-
-      // 3.2) Check all required properties are present
-      VALID_TYPES.get(type).REQUIRED_PROPERTIES.forEach(prop => {
-        if (target[prop] == null) {
-          throw MESSAGES.missingProperty(prop);
-        }
-      });
-
-      // 3.3) Check 'from' directory exists
-      if (!existsSync(from) || !statSync(from).isDirectory()) {
-        throw MESSAGES.noFromDirectory(from);
-      }
-
-      // 3.4) For SSH targets, give the `to` directory a trailing slash
-      if (target.type === 'ssh') {
-        target.to = target.to.replace(/\/?$/, '/');
-      }
-    }
-
-    // 4a) Log config
-
-    if (argv.dry) {
-      return dry({
-        'Deploy config': { id, targets }
-      });
-    }
-
-    // 4b) Deploy
-
-    for (let target of targets) {
-      const { publicPath, type, to } = target;
-      let shouldOverwrite = false;
-
-      // Check if the deployment already exists
-      if (argv.force) shouldOverwrite = true;
-      else if (type === 'ftp') {
-        const [checkErr] = await wrap(deploymentExists(to));
-
-        if (checkErr) {
-          if (checkErr.code === 550) {
-            // Directory doesn't exist. This is actually good though. OK to write.
-            shouldOverwrite = true;
-          } else {
-            error('An FTP error ocurred');
-          }
-        } else {
-          warn('Destination directory exists. OK to overwrite?');
-          log(`  ┗ ${hvy('dir')}: ${req(to)}`);
-
-          const overwriteSelection = (
-            await cliSelect({
-              defaultValue: 1,
-              selected: opt('❯'),
-              unselected: ' ',
-              values: [
-                { label: 'Yes', choice: true },
-                { label: 'No', choice: false }
-              ],
-              valueRenderer: ({ label }, selected) => (selected ? opt(label) : label)
-            })
-          ).value;
-          shouldOverwrite = overwriteSelection.choice;
-          log(`${dim(`Destination overwrite: ${shouldOverwrite}`)}\n`);
-        }
-      }
-
-      // Overwrite by default if ssh for now
-      if (type === 'ssh') shouldOverwrite = true;
-
-      if (shouldOverwrite) {
-        info(MESSAGES.deploy(target));
-
-        const spinner = spin('Deploying');
-
-        try {
-          if (type === 'ftp') {
-            throws(await ftp(target, spinner));
-          } else if (type === 'ssh') {
-            throws(await rsync(target));
-          }
-        } catch (err) {
-          spinner.fail('Deployment failed');
-
-          throw err;
-        }
-
-        spinner.succeed(MESSAGES.deployed(publicPath));
-      } else {
-        log('Exiting');
-      }
-    }
-  }
-);

package/src/cli/generate/constants.js

@@ -1,39 +0,0 @@
-// Ours
-const { cmd, hvy, opt, req, sec } = require('../../utils/color');
-
-module.exports.OPTIONS = {
-  boolean: ['announce'],
-  alias: {
-    announce: 'a'
-  }
-};
-
-const GENERATOR_ALIASES = (module.exports.GENERATOR_ALIASES = {
-  c: 'component',
-  p: 'project'
-});
-
-module.exports.GENERATORS = new Set(Object.values(GENERATOR_ALIASES));
-
-module.exports.MESSAGES = {
-  generatorDoesNotExist: name => `The generator '${name}' does not exist.`,
-  noDryRuns: `Generators don't have dry runs (yet). Please run without the ${opt('--dry')} flag.`,
-  usage: `Usage: ${cmd('aunty generate')} ${req('<generator>')} ${opt('[options]')} -- ${opt('[generator_options]')}
-
-${sec('Options')}
-
-  ${opt('-h')}, ${opt('--help')}  Output the available generators, and exit.
-
-${sec('Generators')}
-
-  ${hvy('Project creation')}
-
-  ${req('project')}     Create a new project (aliased by ${cmd('aunty new')} and ${cmd('aunty init')}).
-
-  ${hvy('Project additions')}
-
-  ${req('component')}   Add a component (and tests) to ${req('src/components/')} for your project type.
-
-  Run ${cmd('aunty generate')} ${req('<generator>')} ${opt('--help')} for details of each generator's options/arguments.
-`
-};

package/src/cli/generate/index.js

@@ -1,72 +0,0 @@
-// External
-const importLazy = require('import-lazy')(require);
-const yeoman = importLazy('yeoman-environment');
-
-// Ours
-const { pack } = require('../../utils/async');
-const { announce } = require('../../utils/audio');
-const { createCommandLogo } = require('../../utils/branding');
-const { log } = require('../../utils/logging');
-const { command } = require('../');
-const { GENERATOR_ALIASES, GENERATORS, MESSAGES, OPTIONS } = require('./constants');
-
-const generate = async argv => {
-  if (argv.dry) {
-    throw MESSAGES.noDryRuns;
-  }
-
-  const generatorName = GENERATOR_ALIASES[argv._[0]] || argv._[0];
-
-  // If we didn't supply a known generator name, blow up, unless we wanted
-  // the generate command's usage message (in which case, print it, then exit).
-
-  if (!GENERATORS.has(generatorName)) {
-    if (!generatorName || generatorName.indexOf('-') === 0 || argv.help) {
-      return log(MESSAGES.usage);
-    }
-
-    throw MESSAGES.generatorDoesNotExist(generatorName);
-  }
-
-  log(createCommandLogo(`generate ${generatorName}`));
-
-  // If we're in a test environment, insert the auto adapter with the provided answers
-  const env = global.auntyYeomanAnswers
-    ? yeoman.createEnv([], {}, new (require('yeoman-automation-adapter').AutoAdapter)(global.auntyYeomanAnswers, true))
-    : yeoman.createEnv();
-
-  // Register the generator
-
-  const generatorPath = require.resolve(`../../generators/${generatorName}`);
-
-  env.register(generatorPath, generatorName);
-
-  // Run the generator, including known arguments
-
-  const runArgs = [generatorName]
-    .concat(argv['--'])
-    .concat(argv.help ? ['--help'] : [])
-    .join(' ');
-
-  const [err] = await pack(env.run(runArgs));
-
-  if (err) {
-    throw err;
-  }
-
-  if (argv.announce) {
-    announce();
-  }
-};
-
-module.exports = command(
-  {
-    name: 'generate',
-    hasSubcommands: true,
-    options: OPTIONS
-  },
-  generate
-);
-
-// Expose this for the tests
-module.exports._testGenerate = generate;

package/src/cli/index.js

@@ -1,154 +0,0 @@
-// Env
-require('dotenv').config();
-
-// Native
-const { resolve } = require('path');
-
-// External
-const importLazy = require('import-lazy')(require);
-const minimist = importLazy('minimist');
-
-// Ours
-const pkg = require('../../package');
-const { getProjectConfig } = require('../config/project');
-const { pack, packs, throws } = require('../utils/async');
-const { createCommandLogo } = require('../utils/branding');
-const { log, timer } = require('../utils/logging');
-const { merge } = require('../utils/structures');
-const {
-  COMMAND_ALIASES,
-  COMMANDS,
-  DEFAULTS,
-  DRY_VARIATIONS,
-  HELP_VARIATIONS,
-  MESSAGES,
-  SHORTHANDS,
-  VERSION_VARIATIONS
-} = require('./constants');
-
-module.exports.cli = packs(async args => {
-  const __DEBUG__stopTimer = timer('CLI');
-
-  const updateNotifier = (await import('update-notifier')).default;
-
-  updateNotifier({ pkg, updateCheckInterval: 36e5 }).notify();
-
-  // If we just want aunty's version number, print it, then exit
-
-  if (args.some(arg => VERSION_VARIATIONS.includes(arg))) {
-    return log(MESSAGES.version(pkg.version));
-  }
-
-  // Normalise the arguments (see function) and split them
-
-  args = normalise(args);
-  const [commandName, ...commandArgs] = args;
-
-  // If we didn't supply a known command name, blow up, unless we wanted
-  // aunty's usage message (in which case, print it, then exit).
-
-  if (!COMMANDS.has(commandName)) {
-    if (!commandName || args.includes(HELP_VARIATIONS[0])) {
-      let isProject = true;
-
-      try {
-        const { type } = getProjectConfig();
-
-        isProject = !!type;
-      } catch (e) {
-        isProject = false;
-      }
-
-      return log(MESSAGES.usage(isProject));
-    }
-
-    throw MESSAGES.unrecognised(commandName);
-  }
-
-  // Import the command
-
-  const __DEBUG__stopImportTimer = timer(`CLI.import(${commandName})`);
-
-  const commandFn = require(resolve(__dirname, `./${commandName}`));
-
-  if (process.env.AUNTY_DEBUG) {
-    __DEBUG__stopImportTimer();
-  }
-
-  // Execute the command with the remaining arguments
-
-  const __DEBUG__stopExecuteTimer = timer(`CLI.execute(${commandName})`);
-
-  throws(await commandFn(commandArgs, true));
-
-  if (process.env.AUNTY_DEBUG) {
-    __DEBUG__stopExecuteTimer();
-    __DEBUG__stopTimer();
-  }
-});
-
-const normalise = args => {
-  // 1) Move any dry argument variation to second position, as '--dry'
-
-  const dryArgIndex = args.findIndex(arg => DRY_VARIATIONS.includes(arg));
-
-  if (dryArgIndex > -1) {
-    args.splice(dryArgIndex, 1);
-    args.splice(1, 0, DRY_VARIATIONS[0]);
-  }
-
-  // 2) Move any help argument variation to second position, as '--help'
-
-  const helpArgIndex = args.findIndex(arg => HELP_VARIATIONS.includes(arg));
-
-  if (helpArgIndex > -1) {
-    args.splice(helpArgIndex, 1);
-    args.splice(1, 0, HELP_VARIATIONS[0]);
-  }
-
-  // 3) If the first argument is a command alias, expand it
-
-  args[0] = COMMAND_ALIASES[args[0]] || args[0];
-
-  // 4) If the first argument is a shorthand, expand it
-
-  const shorthand = SHORTHANDS[args[0]];
-
-  if (shorthand) {
-    args.splice.apply(args, [0, 1].concat(shorthand));
-  }
-
-  // 5) Return the normalised arguments
-
-  return args;
-};
-
-module.exports.command = ({ name, nodeEnv, options, usage, hasSubcommands }, fn) => {
-  name = name || DEFAULTS.name;
-  options = merge(DEFAULTS.options, options);
-  usage = usage || DEFAULTS.usage;
-
-  return packs(async (args = [], isEntryCommand) => {
-    const argv = minimist(args, options);
-
-    if (!hasSubcommands) {
-      if (argv.help) {
-        return log(typeof usage === 'function' ? usage(name) : usage);
-      }
-
-      if (isEntryCommand) {
-        log(createCommandLogo(name, argv.dry));
-      }
-    }
-
-    if (!process.env.NODE_ENV && nodeEnv) {
-      process.env.NODE_ENV = nodeEnv;
-    }
-
-    let [err] = await pack(fn(argv));
-
-    if (err) {
-      throw err;
-    }
-  });
-};

package/src/cli/release/constants.js

@@ -1,67 +0,0 @@
-// Ours
-const { cmd, hvy, ok, opt, sec } = require('../../utils/color');
-
-const FORCE_REMINDER = `Use the ${opt('--force')} option to ignore warnings or release without tagging.`;
-const VALID_BUMPS = (module.exports.VALID_BUMPS = new Set(['major', 'minor', 'patch', 'prerelease']));
-
-const OPTIONS = (module.exports.OPTIONS = {
-  string: ['bump', 'git-remote'],
-  default: {
-    'git-remote': 'origin'
-  }
-});
-
-module.exports.MESSAGES = {
-  bumpQuestion: dry =>
-    `${ok('?')} ${hvy(`What package version bump ${dry ? 'would this release have been' : 'is this release'}?`)}`,
-  changes: (tag, tags, changelog) =>
-    changelog.length
-      ? `${tags.length ? `Here's what's changed since ${hvy(tag)}` : 'Here are the initial changes'}:
-
-${changelog.join('\n')}
-`
-      : `${cmd('ℹ')} Nothing has changed since ${hvy(tag)}\n`,
-  createCommit: (from, to) => `Bump version ${hvy(from)} → ${hvy(to)}`,
-  createTag: tag => `Create tag ${hvy(tag)}`,
-  forceReminder: FORCE_REMINDER,
-  hasChanges: `You shouldn't release builds which may contain un-committed changes! ${FORCE_REMINDER}`,
-  hasTag: (tag, isTagOnHead) =>
-    `The tag ${hvy(tag)} already exists${
-      isTagOnHead ? '' : ` and your current HEAD doesn't point to it`
-    }! ${FORCE_REMINDER}`,
-  invalidBump: bump =>
-    `You supplied an invalid bump value ${hvy(bump)}. It can be: ${hvy(Array.from(VALID_BUMPS).join('|'))}`,
-  notDefaultBranch: (label, defaultBranch) =>
-    `You are trying to release from ${hvy(label)}. You should only release from ${hvy(defaultBranch)}`,
-  notRepo: `You can't tag a release or deploy using a tag name becase this project isn't a git repo.`,
-  pushCommit: remote => `Push version bump to remote ${hvy(remote)}`,
-  pushTag: (tag, remote) => `Push tag ${hvy(tag)} to remote ${hvy(remote)}`,
-  usage: name => `Usage: ${cmd(`aunty ${name}`)} ${opt('[options]')}
-
-${sec('Options')}
-
-  ${opt(`--bump={${Array.from(VALID_BUMPS).join('|')}}`)}  Preselect the package version bump for this release ${opt(
-    '[default: PROMPT]'
-  )}
-  ${opt('--git-remote')}                Git remote to push release tags to (if it exists) ${opt(
-    `[default: "${OPTIONS.default['git-remote']}"]`
-  )}
-  ${opt('-d')}, ${opt('--dry')}                   Output the release version & git remote, then exit
-  ${opt('-f')}, ${opt('--force')}                 Ignore warnings & don't bump version ${opt('[default: false]')}
-
-${sec('Examples')}
-
-  ${cmd('aunty release')}
-    1. Ensure working directory is in a deployable state
-    2. Prompt for version bump choice and determine release version
-    3. Run \`${cmd('aunty build')} ${opt('--id=<version>')}\`
-    4. Commit & tag new version, pushing to existing git remote
-    5. Run \`${cmd('aunty deploy')}\`
-    
-  ${cmd(`aunty release ${opt('--bump=major')}`)}
-    As above, skipping (2).
-
-  ${cmd(`aunty release ${opt('--force')}`)}
-    As above, skipping (1, 2 & 4).
-`
-};