@abcnews/aunty 12.2.2 → 13.0.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@abcnews/aunty",
-  "version": "12.2.2",
+  "version": "13.0.2",
   "description": "A toolkit for working with ABC News projects",
   "repository": "abcnews/aunty",
   "license": "MIT",
@@ -11,10 +11,12 @@
     "Joshua Byrd <byrd.joshua@abc.net.au>"
   ],
   "scripts": {
+    "postinstall": "node scripts/postinstall.js",
     "release": "release-it"
   },
   "files": [
     "assets",
+    "scripts",
     "src",
     "ts"
   ],
@@ -42,7 +44,7 @@
     "chalk": "^4.1.2",
     "cli-select": "^1.1.0",
     "copy-webpack-plugin": "^8.1.1",
-    "css-loader": "^5.2.1",
+    "css-loader": "^5.2.7",
     "csv-loader": "^3.0.3",
     "deepmerge": "^4.0.0",
     "del": "^6.0.0",
@@ -80,7 +82,7 @@
     "svelte-preprocess": "^4.1.1",
     "tcp-ping-sync": "^1.0.0",
     "typescript": "^4.0.2",
-    "update-notifier": "^5.1.0",
+    "update-notifier": "^6.0.2",
     "url-loader": "^4.1.1",
     "webpack": "^5.33.2",
     "webpack-bundle-analyzer": "^4.5.0",
@@ -95,6 +97,6 @@
   "devDependencies": {
     "eslint": "^7.7.0",
     "eslint-config-prettier": "^8.2.0",
-    "release-it": "^14.6.1"
+    "release-it": "^15.1.4"
   }
 }

package/scripts/postinstall.js

@@ -0,0 +1,44 @@
+/*
+    Aunty v13 changes how build artefacts are created. When building a project,
+    pre-v13, a .build folder and .deploy files were created inside your project
+    directory. In v13, this was changed to a single .aunty directory, which
+    contains a build filder and deploy.json file.
+
+    This script runs after aunty is installed inside a project directory, and
+    if the project was upgraded from a pre-v13 aunty, it will delete any old
+    build artefacts, and update the .gitignore file to make sure the .aunty
+    directory isn't committed, and remove the .build & .deploy references.
+*/
+
+const { existsSync, readFileSync, rmSync, rmdirSync, writeFileSync } = require('fs');
+const { join } = require('path');
+
+const INSTALLATION_DIRECTORY = process.env.INIT_CWD || '.';
+
+const PRE_AUNTY_13_GITIGNORE_PATTERN = /\/\.build\n\/\.deploy/;
+const POST_AUNTY_13_GITIGNORE_REPLACEMENT = `/.aunty`;
+
+const PRE_AUNTY_13_BUILD_DIR_PATH = join(INSTALLATION_DIRECTORY, '.build');
+const PRE_AUNTY_13_DEPLOY_CONFIG_FILE_PATH = join(INSTALLATION_DIRECTORY, '.deploy');
+const GITIGNORE_PATH = join(INSTALLATION_DIRECTORY, '.gitignore');
+
+if (existsSync(PRE_AUNTY_13_BUILD_DIR_PATH)) {
+  rmdirSync(PRE_AUNTY_13_BUILD_DIR_PATH, { recursive: true });
+}
+
+if (existsSync(PRE_AUNTY_13_DEPLOY_CONFIG_FILE_PATH)) {
+  rmSync(PRE_AUNTY_13_DEPLOY_CONFIG_FILE_PATH);
+}
+
+if (existsSync(GITIGNORE_PATH)) {
+  const fileContents = readFileSync(GITIGNORE_PATH, 'utf8');
+
+  if (PRE_AUNTY_13_GITIGNORE_PATTERN.test(fileContents)) {
+    const updatedFileContents = fileContents.replace(
+      PRE_AUNTY_13_GITIGNORE_PATTERN,
+      POST_AUNTY_13_GITIGNORE_REPLACEMENT
+    );
+
+    writeFileSync(GITIGNORE_PATH, updatedFileContents);
+  }
+}

package/src/cli/build/index.js

@@ -11,7 +11,7 @@ const writeJsonFile = importLazy('write-json-file');
 const { getDeployConfig } = require('../../config/deploy');
 const { getProjectConfig } = require('../../config/project');
 const { getWebpackConfig } = require('../../config/webpack');
-const { DEPLOY_FILE_NAME } = require('../../constants');
+const { DEPLOY_FILE_NAME, OUTPUT_DIRECTORY_NAME } = require('../../constants');
 const { packs, throws, unpack } = require('../../utils/async');
 const { dry, info, spin, warn } = require('../../utils/logging');
 const { combine } = require('../../utils/structures');
@@ -71,7 +71,7 @@ module.exports = command(
       const errors = stats.toJson({}, true).errors;
 
       spinner.fail();
-      
+
       if (errors.length > 1) {
         throw MESSAGES.multipleErrors(errors.map(error => error.message));
       }
@@ -88,7 +88,7 @@ module.exports = command(
 
     if (deployConfig) {
       spinner = spin('Creating deploy configuration');
-      writeJsonFile.sync(join(root, DEPLOY_FILE_NAME), deployConfig);
+      writeJsonFile.sync(join(root, OUTPUT_DIRECTORY_NAME, DEPLOY_FILE_NAME), deployConfig);
       spinner.succeed('Created deploy configuration');
     }
   }

package/src/cli/clean/index.js

@@ -3,9 +3,8 @@ const importLazy = require('import-lazy')(require);
 const del = importLazy('del');
 
 // Ours
-const { getBuildConfig } = require('../../config/build');
 const { getProjectConfig } = require('../../config/project');
-const { DEPLOY_FILE_NAME } = require('../../constants');
+const { OUTPUT_DIRECTORY_NAME } = require('../../constants');
 const { hvy } = require('../../utils/color');
 const { dry, info, spin } = require('../../utils/logging');
 const { inlineList } = require('../../utils/text');
@@ -19,8 +18,7 @@ module.exports = command(
   },
   async argv => {
     const { root } = getProjectConfig();
-    const { to } = getBuildConfig();
-    const globs = [to, DEPLOY_FILE_NAME];
+    const globs = [OUTPUT_DIRECTORY_NAME];
 
     if (argv.dry) {
       return dry({

package/src/cli/deploy/index.js

@@ -10,7 +10,7 @@ const loadJsonFile = importLazy('load-json-file');
 const { command } = require('../');
 const { addProfileProperties } = require('../../config/deploy');
 const { getProjectConfig } = require('../../config/project');
-const { DEPLOY_FILE_NAME } = require('../../constants');
+const { DEPLOY_FILE_NAME, OUTPUT_DIRECTORY_NAME } = require('../../constants');
 const { packs, throws, unpack } = require('../../utils/async');
 const { dry, info, spin, warn } = require('../../utils/logging');
 const { ftp, rsync } = require('../../utils/remote');
@@ -29,7 +29,7 @@ module.exports = command(
     // 1) Load the deploy configuration (created by the build process)
 
     try {
-      deployConfig = loadJsonFile.sync(join(root, DEPLOY_FILE_NAME));
+      deployConfig = loadJsonFile.sync(join(root, OUTPUT_DIRECTORY_NAME, DEPLOY_FILE_NAME));
     } catch (err) {
       throw new Error(MESSAGES.noDeployConfigFile);
     }

package/src/cli/index.js

@@ -4,7 +4,6 @@ const { resolve } = require('path');
 // External
 const importLazy = require('import-lazy')(require);
 const minimist = importLazy('minimist');
-const updateNotifier = importLazy('update-notifier');
 
 // Ours
 const pkg = require('../../package');
@@ -27,6 +26,8 @@ const {
 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

package/src/config/build.js

@@ -1,8 +1,11 @@
+// Native
+const { join } = require('path');
+
 // External
 const mem = require('mem');
 
 // Ours
-const { BUILD_DIRECTORY_NAME } = require('../constants');
+const { BUILD_DIRECTORY_NAME, OUTPUT_DIRECTORY_NAME } = require('../constants');
 const { combine } = require('../utils/structures');
 const { getProjectConfig } = require('./project');
 
@@ -22,7 +25,7 @@ module.exports.getBuildConfig = mem(() => {
     {
       entry: DEFAULT_ENTRY_FILE_NAME,
       from: DEFAULT_SOURCE_DIRECTORY_NAME,
-      to: BUILD_DIRECTORY_NAME,
+      to: join(OUTPUT_DIRECTORY_NAME, BUILD_DIRECTORY_NAME),
       staticDir: DEFAULT_STATIC_DIRECTORY_NAME,
       addModernJS: false,
       includedDependencies: [],

package/src/config/serve.js

@@ -23,32 +23,7 @@ const DEFAULT_HOST = (module.exports.DEFAULT_HOST = probe(`nucwed${INTERNAL_SUFF
   : 'localhost');
 const DEFAULT_PORT = 8000;
 
-const serveConfigPromise = getServeConfigPromise();
-
-module.exports.getServeConfig = () => serveConfigPromise;
-
-async function getServeConfigPromise() {
-  const { serve } = getProjectConfig();
-
-  const config = combine(
-    {
-      hasBundleAnalysis: false,
-      host: DEFAULT_HOST,
-      hot: process.env.NODE_ENV === 'development',
-      https: true,
-      port: DEFAULT_PORT
-    },
-    serve,
-    addEnvironmentVariables,
-    addUserSSLConfig
-  );
-  const port = await findPort(config.port, config.port + 100, config.host);
-  config.port = port;
-
-  return config;
-}
-
-function addEnvironmentVariables(config) {
+const addEnvironmentVariables = config => {
   if (process.env.AUNTY_HOST) {
     config.host = process.env.AUNTY_HOST;
   }
@@ -58,7 +33,7 @@ function addEnvironmentVariables(config) {
   }
 
   return config;
-}
+};
 
 const getSSLPath = (module.exports.getSSLPath = (host, name) => join(HOME_DIR, SSL_DIR, host, name || '.'));
 
@@ -66,7 +41,7 @@ const getSSLPath = (module.exports.getSSLPath = (host, name) => join(HOME_DIR, S
 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}
 */
-function addUserSSLConfig(config) {
+const addUserSSLConfig = config => {
   if (config.https === true) {
     try {
       config.https = {
@@ -77,9 +52,9 @@ function addUserSSLConfig(config) {
   }
 
   return config;
-}
+};
 
-async function findPort(port, max = port + 100, host = '0.0.0.0') {
+const findPort = async (port, max = port + 100, host = '0.0.0.0') => {
   return new Promise((resolve, reject) => {
     const socket = new Socket();
 
@@ -115,4 +90,41 @@ async function findPort(port, max = port + 100, host = '0.0.0.0') {
 
     socket.connect(port, host);
   });
-}
+};
+
+const _getServeConfig = async () => {
+  const { serve } = getProjectConfig();
+
+  const config = combine(
+    {
+      hasBundleAnalysis: false,
+      host: DEFAULT_HOST,
+      hot: process.env.NODE_ENV === 'development',
+      https: true,
+      port: DEFAULT_PORT
+    },
+    serve,
+    addEnvironmentVariables,
+    addUserSSLConfig
+  );
+  const port = await findPort(config.port, config.port + 100, config.host);
+  config.port = port;
+
+  return config;
+};
+
+let _serveConfigPromiseSingleton;
+
+// getServeConfig is called twice during server startup, because the `serve`
+// command calls it directly, then indirectly, via getWebpackDevServerConfig.
+// Because it won't change during a single `serve` command, and because we
+// don't want to waste time doing port lookups with `findPort` multiple times
+// we just cache the promise created on the first run, and return that later.
+
+module.exports.getServeConfig = async () => {
+  if (!_serveConfigPromiseSingleton) {
+    _serveConfigPromiseSingleton = _getServeConfig();
+  }
+
+  return _serveConfigPromiseSingleton;
+};

package/src/constants.js

@@ -1,5 +1,6 @@
 module.exports = {
-  BUILD_DIRECTORY_NAME: '.build',
-  DEPLOY_FILE_NAME: '.deploy',
+  OUTPUT_DIRECTORY_NAME: '.aunty',
+  BUILD_DIRECTORY_NAME: 'build',
+  DEPLOY_FILE_NAME: 'deploy.json',
   PROJECT_CONFIG_FILE_NAME: 'aunty.config.js'
 };

package/src/generators/project/index.js

@@ -8,7 +8,7 @@ const requireg = require('requireg');
 const Generator = require('yeoman-generator');
 
 // Ours
-const { BUILD_DIRECTORY_NAME, DEPLOY_FILE_NAME } = require('../../constants');
+const { OUTPUT_DIRECTORY_NAME } = require('../../constants');
 const { cmd, hvy, opt, sec } = require('../../utils/color');
 const { success } = require('../../utils/logging');
 const { installDependencies } = require('../../utils/npm');
@@ -114,8 +114,7 @@ Shorthand examples (assuming xyz is your project name):
 
   writing() {
     const context = {
-      BUILD_DIRECTORY_NAME,
-      DEPLOY_FILE_NAME,
+      OUTPUT_DIRECTORY_NAME,
       projectName: this.options.projectName,
       projectNameSlug: this.options.projectNameSlug,
       projectNameFlat: this.options.projectNameFlat,

package/src/generators/project/templates/_common/_.gitignore

@@ -2,8 +2,7 @@
 /node_modules
 
 # output
-/<%= BUILD_DIRECTORY_NAME %>
-/<%= DEPLOY_FILE_NAME %>
+/<%= OUTPUT_DIRECTORY_NAME %>
 
 # misc
 .DS_Store