@abcnews/aunty 14.0.0 → 14.0.2

package/README.md

@@ -120,7 +120,7 @@ If you don't need to override any of the project defaults, your entire aunty con
 | `hasBundleAnalysis` | `false`       | Setting this to true will spin up a second server on another port, allowing you to inspect your bundle. The address will be logged to the console when the dev server starts.                                                                  |
 | `host`              | `"localhost"` | The hostname of your dev server. If you're on the ABC internal network, the default will change to your machine's hostname (`ws<number>.aus.aunty.abc.net.au`). The `AUNTY_HOST` environment variable, if present, will override this setting. |
 | `hot`               | `true`        | Should the dev server enable hot reloading. If `NODE_ENV !== "development"`, the default will change to `false`.                                                                                                                               |
-| `https`             | `true`        | Should the dev server use SSL (with a self-signed certificate matching the `host`). You can alternatively supply your own `{cert: string, key: string` object if you've generated your certificate some other way.                             |
+| `https`             | `true`        | Should the dev server use SSL (with a self-signed certificate matching the `host`). You can alternatively supply your own `{cert: string, key: string}` object if you've generated your certificate some other way.                             |
 | `port`              | `8000`        | The port number of your dev server. If the port specified is unavailable, **aunty** will try incrementing the port number until it finds an available one. The `AUNTY_PORT` environment variable, if present, will override this setting.      |
 
 #### `deploy` config properties
@@ -156,7 +156,7 @@ Note: You may also need a `Promise` polyfill for IE11.
 
 ## Authors
 
-- Colin Gourlay ([gourlay.colin@abc.net.au](mailto:gourlay.colin@abc.net.au))
+- Colin Gourlay
 - Simon Elvery ([elvery.simon@abc.net.au](mailto:elvery.simon@abc.net.au))
 - Joshua Byrd ([byrd.joshua@abc.net.au](mailto:byrd.joshua@abc.net.au))
 - Nathan Hoad

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@abcnews/aunty",
-  "version": "14.0.0",
+  "version": "14.0.2",
   "description": "A toolkit for working with ABC News projects",
   "repository": "abcnews/aunty",
   "license": "MIT",
@@ -12,7 +12,8 @@
   ],
   "scripts": {
     "postinstall": "node scripts/postinstall.js",
-    "release": "release-it"
+    "release": "release-it",
+    "test": "jest test/test.js"
   },
   "files": [
     "assets",
@@ -94,6 +95,7 @@
     "babel-eslint": "^10.1.0",
     "eslint": "^7.7.0",
     "eslint-config-prettier": "^8.2.0",
-    "release-it": "^15.1.4"
+    "release-it": "^15.1.4",
+    "yeoman-automation-adapter": "^2.0.0"
   }
 }

package/src/cli/build/index.js

@@ -19,77 +19,82 @@ const { command } = require('../');
 const cleanCommand = require('../clean');
 const { MESSAGES, OPTIONS } = require('./constants');
 
-module.exports = command(
-  {
-    name: 'build',
-    nodeEnv: 'production',
-    options: OPTIONS,
-    usage: MESSAGES.usage
-  },
-  async argv => {
-    const { root } = getProjectConfig();
-    const webpackConfig = getWebpackConfig();
-    let deployConfig;
-
-    if (!argv.local) {
-      deployConfig = getDeployConfig({ id: argv.id });
-      webpackConfig.forEach(config => {
-        config.output.publicPath = deployConfig.targets[0].publicPath;
-      });
-    }
-
-    if (argv.dry) {
-      return dry(
-        combine(
-          {
-            'Webpack config': webpackConfig
-          },
-          deployConfig
-            ? {
-                'Deploy config': deployConfig
-              }
-            : {}
-        )
-      );
-    }
+const build = async argv => {
+  const { root } = getProjectConfig();
+  const webpackConfig = getWebpackConfig();
+  let deployConfig;
 
-    throws(await cleanCommand(['--quiet']));
+  if (!argv.local) {
+    deployConfig = getDeployConfig({ id: argv.id });
+    webpackConfig.forEach(config => {
+      config.output.publicPath = deployConfig.targets[0].publicPath;
+    });
+  }
 
-    info(
-      MESSAGES.build({
-        id: deployConfig ? deployConfig.id : null,
-        publicPaths: deployConfig ? deployConfig.targets.map(x => x.publicPath) : [webpackConfig[0].output.publicPath]
-      })
+  if (argv.dry) {
+    return dry(
+      combine(
+        {
+          'Webpack config': webpackConfig
+        },
+        deployConfig
+          ? {
+              'Deploy config': deployConfig
+            }
+          : {}
+      )
     );
+  }
 
-    let spinner = spin('Building');
-    const startTime = Date.now();
-    const compiler = webpack(webpackConfig);
-    const stats = unpack(await packs(pify(compiler.run.bind(compiler)))());
+  throws(await cleanCommand(['--quiet']));
 
-    if (stats.hasErrors()) {
-      const errors = stats.toJson({}, true).errors;
+  info(
+    MESSAGES.build({
+      id: deployConfig ? deployConfig.id : null,
+      publicPaths: deployConfig ? deployConfig.targets.map(x => x.publicPath) : [webpackConfig[0].output.publicPath]
+    })
+  );
 
-      spinner.fail();
+  let spinner = spin('Building');
+  const startTime = Date.now();
+  const compiler = webpack(webpackConfig);
+  const stats = unpack(await packs(pify(compiler.run.bind(compiler)))());
 
-      if (errors.length > 1) {
-        throw MESSAGES.multipleErrors(errors.map(error => error.message));
-      }
+  if (stats.hasErrors()) {
+    const errors = stats.toJson({}, true).errors;
 
-      throw errors[0];
-    }
+    spinner.fail();
 
-    if (stats.hasWarnings()) {
-      spinner.warn();
-      stats.toJson({}, true).warnings.forEach(warning => warn(warning.message));
-    } else {
-      spinner.succeed(`Built in ${((Date.now() - startTime) / 1000).toFixed(2)}s`);
+    if (errors.length > 1) {
+      throw MESSAGES.multipleErrors(errors.map(error => error.message));
     }
 
-    if (deployConfig) {
-      spinner = spin('Creating deploy configuration');
-      writeJsonFile.sync(join(root, OUTPUT_DIRECTORY_NAME, DEPLOY_FILE_NAME), deployConfig);
-      spinner.succeed('Created deploy configuration');
-    }
+    throw errors[0];
   }
+
+  if (stats.hasWarnings()) {
+    spinner.warn();
+    stats.toJson({}, true).warnings.forEach(warning => warn(warning.message));
+  } else {
+    spinner.succeed(`Built in ${((Date.now() - startTime) / 1000).toFixed(2)}s`);
+  }
+
+  if (deployConfig) {
+    spinner = spin('Creating deploy configuration');
+    writeJsonFile.sync(join(root, OUTPUT_DIRECTORY_NAME, DEPLOY_FILE_NAME), deployConfig);
+    spinner.succeed('Created deploy configuration');
+  }
+};
+
+module.exports = command(
+  {
+    name: 'build',
+    nodeEnv: 'production',
+    options: OPTIONS,
+    usage: MESSAGES.usage
+  },
+  build
 );
+
+// Expose this for the tests
+module.exports._testBuild = build;

package/src/cli/constants.js

@@ -1,7 +1,6 @@
 // Ours
 const { createLogo } = require('../utils/branding');
 const { cmd, dim, hvy, opt, req, sec } = require('../utils/color');
-const { setOfValues } = require('../utils/structures');
 
 const COMMAND_ALIASES = (module.exports.COMMAND_ALIASES = {
   b: 'build',
@@ -14,7 +13,7 @@ const COMMAND_ALIASES = (module.exports.COMMAND_ALIASES = {
   t: 'test'
 });
 
-module.exports.COMMANDS = setOfValues(COMMAND_ALIASES);
+module.exports.COMMANDS = new Set(Object.values(COMMAND_ALIASES));
 
 module.exports.DEFAULTS = {
   name: '__command__',

package/src/cli/generate/constants.js

@@ -1,6 +1,5 @@
 // Ours
 const { cmd, hvy, opt, req, sec } = require('../../utils/color');
-const { setOfValues } = require('../../utils/structures');
 
 module.exports.OPTIONS = {
   boolean: ['announce'],
@@ -14,7 +13,7 @@ const GENERATOR_ALIASES = (module.exports.GENERATOR_ALIASES = {
   p: 'project'
 });
 
-module.exports.GENERATORS = setOfValues(GENERATOR_ALIASES);
+module.exports.GENERATORS = new Set(Object.values(GENERATOR_ALIASES));
 
 module.exports.MESSAGES = {
   generatorDoesNotExist: name => `The generator '${name}' does not exist.`,

package/src/cli/generate/index.js

@@ -10,55 +10,63 @@ const { log } = require('../../utils/logging');
 const { command } = require('../');
 const { GENERATOR_ALIASES, GENERATORS, MESSAGES, OPTIONS } = require('./constants');
 
-module.exports = command(
-  {
-    name: 'generate',
-    hasSubcommands: true,
-    options: OPTIONS
-  },
-  async argv => {
-    if (argv.dry) {
-      throw MESSAGES.noDryRuns;
-    }
-
-    const generatorName = GENERATOR_ALIASES[argv._[0]] || argv._[0];
+const generate = async argv => {
+  if (argv.dry) {
+    throw MESSAGES.noDryRuns;
+  }
 
-    // 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).
+  const generatorName = GENERATOR_ALIASES[argv._[0]] || argv._[0];
 
-    if (!GENERATORS.has(generatorName)) {
-      if (!generatorName || generatorName.indexOf('-') === 0 || argv.help) {
-        return log(MESSAGES.usage);
-      }
+  // 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).
 
-      throw MESSAGES.generatorDoesNotExist(generatorName);
+  if (!GENERATORS.has(generatorName)) {
+    if (!generatorName || generatorName.indexOf('-') === 0 || argv.help) {
+      return log(MESSAGES.usage);
     }
 
-    log(createCommandLogo(`generate ${generatorName}`));
+    throw MESSAGES.generatorDoesNotExist(generatorName);
+  }
 
-    const env = yeoman.createEnv();
+  log(createCommandLogo(`generate ${generatorName}`));
 
-    // Register the generator
+  // 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();
 
-    const generatorPath = require.resolve(`../../generators/${generatorName}`);
+  // Register the generator
 
-    env.register(generatorPath, generatorName);
+  const generatorPath = require.resolve(`../../generators/${generatorName}`);
 
-    // Run the generator, including known arguments
+  env.register(generatorPath, generatorName);
 
-    const runArgs = [generatorName]
-      .concat(argv['--'])
-      .concat(argv.help ? ['--help'] : [])
-      .join(' ');
+  // Run the generator, including known arguments
 
-    const [err] = await pack(env.run(runArgs));
+  const runArgs = [generatorName]
+    .concat(argv['--'])
+    .concat(argv.help ? ['--help'] : [])
+    .join(' ');
 
-    if (err) {
-      throw err;
-    }
+  const [err] = await pack(env.run(runArgs));
 
-    if (argv.announce) {
-      announce();
-    }
+  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/serve/constants.js

@@ -8,7 +8,7 @@ module.exports.BUNDLE_ANALYZER_CONFIG = {
 };
 
 module.exports.MESSAGES = {
-  port: port => `Port ${port} already in use attempting to use port ${port + 1}`,
+  port: ({ port, errorType }) => `Port ${port} could not be used (${errorType}). Attempting to use port ${port + 1}`,
   analysis: ({ analyzerHost, analyzerPort }) => `http://${analyzerHost}:${analyzerPort}`,
   serve: ({ bundleAnalysisPath, hot, publicPath }) => `Serve (${hvy(process.env.NODE_ENV)}):${
     bundleAnalysisPath

package/src/config/project.js

@@ -9,7 +9,7 @@ const mem = require('mem');
 
 // Ours
 const { hvy } = require('../utils/color');
-const { pretty, warn } = require('../utils/logging');
+const { pretty } = require('../utils/logging');
 const { combine } = require('../utils/structures');
 const { PROJECT_CONFIG_FILE_NAME } = require('../constants');
 

package/src/config/serve.js

@@ -12,7 +12,7 @@ const { combine } = require('../utils/structures');
 const { getProjectConfig } = require('./project');
 const { info } = require('../utils/logging');
 const { MESSAGES } = require('../cli/serve/constants');
-const {INTERNAL_TEST_HOST} = require('../constants')
+const { INTERNAL_TEST_HOST } = require('../constants');
 
 const HOME_DIR = homedir();
 const SSL_DIR = '.aunty/ssl';
@@ -38,10 +38,10 @@ const addEnvironmentVariables = config => {
 
 const getSSLPath = (module.exports.getSSLPath = (host, name) => join(HOME_DIR, SSL_DIR, host, name || '.'));
 
-/*
-Set config.https to cert & key generated with `aunty sign-cert` (if they both exist)
-We expect them to be in: ~/.aunty/ssl/<host>/server.{cert|key}
-*/
+/**
+ * Set config.https to cert & key generated with `aunty sign-cert` (if they both exist)
+ * We expect them to be in: ~/.aunty/ssl/<host>/server.{cert|key}
+ */
 const addUserSSLConfig = config => {
   if (config.https === true) {
     try {
@@ -55,13 +55,16 @@ const addUserSSLConfig = config => {
   return config;
 };
 
+/**
+ * Find an open port, or keep incrementing until we get one
+ */
 const findPort = async (port, max = port + 100, host = '0.0.0.0') => {
   return new Promise((resolve, reject) => {
     const socket = new Socket();
 
-    const next = () => {
+    const next = errorType => {
       socket.destroy();
-      info(MESSAGES.port(port));
+      info(MESSAGES.port({ port, errorType }));
       if (port <= max) resolve(findPort(port + 1, max, host));
       else reject(new Error('Could not find an available port'));
     };
@@ -72,7 +75,7 @@ const findPort = async (port, max = port + 100, host = '0.0.0.0') => {
     };
 
     // Port is taken if connection can be made
-    socket.once('connect', next);
+    socket.once('connect', () => next('in use'));
 
     // Port is open if connection attempt times out
     socket.setTimeout(500);
@@ -83,9 +86,19 @@ const findPort = async (port, max = port + 100, host = '0.0.0.0') => {
       // If the connection is refused, it's assumed nothing is listening and the port is available.
       if (e.code === 'ECONNREFUSED') {
         found();
+      } else if (e.code === 'ENOTFOUND' && e.syscall === 'getaddrinfo' && e.hostname?.includes(INTERNAL_SUFFIX)) {
+        console.error(
+          [
+            'Could not resolve hostname ' + e.hostname,
+            'You appear to be on the ABC network without a hostname attached to your computer.',
+            "Aunty can't continue. Consider reconnecting, or add your hostname to your hosts file.",
+            ''
+          ].join('\n')
+        );
+        process.exit(1);
       } else {
-        // Not sure what to do with other errors, so keep seeking a free port.
-        next();
+        // Not sure what to do with other errors. Log the code & keep seeking a free port.
+        next(`error code ${e.code}`);
       }
     });
 

package/src/config/webpack.js

@@ -18,6 +18,10 @@ const { getBuildConfig } = require('./build');
 const { getProjectConfig } = require('./project');
 
 const JSX_RESOLVE_EXTENSIONS = ['.jsx', '.tsx'];
+
+/**
+ * Project types to override the Webpack config.
+ */
 const PROJECT_TYPES_CONFIG = {
   preact: {
     resolve: {
@@ -34,6 +38,11 @@ const PROJECT_TYPES_CONFIG = {
       extensions: JSX_RESOLVE_EXTENSIONS
     }
   },
+
+  /**
+   * Svelte uses a function to modify the existing config, rather than just merging in.
+   * @see combine
+   */
   svelte: config => {
     config.resolve = {
       // Make sure that only one copy of the Svelte runtime is bundled in the app
@@ -44,7 +53,8 @@ const PROJECT_TYPES_CONFIG = {
       extensions: [...config.resolve.extensions, '.svelte'],
       // When using Svelte components installed from npm, use the original component
       // source code, rather than consuming the already-compiled version
-      mainFields: ['svelte', 'browser', 'module', 'main']
+      mainFields: ['svelte', 'browser', 'module', 'main'],
+      conditionNames: ['svelte', 'browser', 'import']
     };
 
     const { include, loader, options } = getHintedRule(config, 'scripts');
@@ -167,6 +177,10 @@ function createWebpackConfig({ isModernJS } = {}) {
       module: {
         rules: [
           {
+            /**
+             * hints are used by PROJECT_TYPES_CONFIGs to quickly select the right config.
+             * @see PROJECT_TYPES_CONFIG
+             */
             __hint__: 'scripts',
             test: hasTS ? /\.m?[jt]sx?$/ : /\.m?jsx?$/,
             include: [resolve(root, from)].concat(resolveIncludedDependencies(includedDependencies, root)),

package/src/generators/project/templates/preact/src/index.tsx

@@ -26,7 +26,7 @@ if (module.hot) {
   module.hot.accept('./components/App', () => {
     try {
       renderApp();
-    } catch (err) {
+    } catch (err<% if (isTS) { %>: any<% } %>) {
       import('./components/ErrorBox').then(({ default: ErrorBox }) => {
         if (appMountEl) {
           render(<ErrorBox error={err} />, appMountEl);

package/src/generators/project/templates/react/src/index.tsx

@@ -27,7 +27,7 @@ if (module.hot) {
   module.hot.accept('./components/App', () => {
     try {
       renderApp();
-    } catch (err: any) {
+    } catch (err<% if (isTS) { %>: any<% } %>) {
       import('./components/ErrorBox').then(({ default: ErrorBox }) => {
         root.render(<ErrorBox error={err} />);
       });

package/src/utils/structures.js

@@ -1,5 +1,12 @@
 const deepmerge = require('deepmerge');
 
+/**
+ * Merge a function or object into the target object
+ * @param target an object to merge into
+ * @param source an object to merge with `target`, or a function that takes `target` as an argument
+ * @param isDeep use deepmerge to merge
+ * @returns
+ */
 const combine = (target, source, isDeep) =>
   typeof source === 'function'
     ? source(target)
@@ -11,11 +18,16 @@ const combine = (target, source, isDeep) =>
 
 const combineDeep = (memo, source) => combine(memo, source, true);
 
+/**
+ * Shallow merge an array of objects. Earlier values overwritten by later values
+ * @param sources Array of objects and functions to be merged using `combine`
+ * @see combine
+ */
 module.exports.combine = (...sources) => sources.reduce(combine, {});
 
+/**
+ * Deep merge an array of objects. Earlier values overwritten by later values.
+ * @param sources Array of objects and functions to be merged using `combine`
+ * @see combine
+ */
 module.exports.merge = (...sources) => sources.reduce(combineDeep, {});
-
-module.exports.setOfKeysAndValues = source =>
-  new Set([].concat(Object.keys(source).map(key => source[key])).concat(Object.keys(source)));
-
-module.exports.setOfValues = source => new Set(Object.keys(source).map(key => source[key]));