@abcnews/aunty 16.0.0 → 17.0.0-next.0

package/README.md

@@ -83,6 +83,16 @@ module.exports = {
 }
 ```
 
+For example to include a package that needs to be pre-processed, include in `aunty.config.js`
+
+```js
+module.exports = {
+  build: {
+    includedDependencies: ["runed"],
+  },
+};
+```
+
 Supported project `type`s (currently: `basic`, `preact`, `react` & `svelte`) have their own default build configuration, but you can override it by extending your project configuration.
 
 The `build`, `serve` and `deploy` properties allow you to override the default settings for those respective commands. Their respective properties (and default values) are documented below.

package/dist/bin/aunty.js

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+console.log("Hello from Aunty Next! 🎉");
+export {};

package/dist/lib/constants.js

@@ -0,0 +1,8 @@
+const constants = {
+    OUTPUT_DIRECTORY_NAME: ".aunty",
+    BUILD_DIRECTORY_NAME: "build",
+    DEPLOY_FILE_NAME: "deploy.json",
+    PROJECT_CONFIG_FILE_NAME: "aunty.config.js",
+    INTERNAL_TEST_HOST: "master-news-web.news-web-developer.presentation-layer.abc-prod.net.au",
+};
+export default constants;

package/package.json

@@ -1,104 +1,47 @@
 {
   "name": "@abcnews/aunty",
-  "version": "16.0.0",
-  "description": "A toolkit for working with ABC News projects",
-  "repository": "abcnews/aunty",
+  "version": "17.0.0-next.0",
+  "type": "module",
+  "description": "ABC News Digital developer toolkit",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/abcnews/aunty.git"
+  },
   "license": "MIT",
   "contributors": [
     "Colin Gourlay <gourlay.colin@abc.net.au>",
     "Simon Elvery <elvery.simon@abc.net.au>",
     "Joshua Byrd <byrd.joshua@abc.net.au>",
-    "Ash Kyd <kyd.ashley@abc.net.au>",
-    "Nathan Hoad"
+    "Ash Kyd <kyd.ashley@abc.net.au>"
   ],
   "scripts": {
-    "postinstall": "node scripts/postinstall.js",
-    "release": "release-it",
-    "test": "jest test/test.js"
+    "build": "tsc",
+    "dev": "tsx src/bin/aunty.ts",
+    "test": "echo \"Put your tests here\" && exit 1",
+    "lint": "eslint src",
+    "clean": "rimraf dist",
+    "prebuild": "npm run clean"
   },
   "files": [
-    "assets",
-    "scripts",
-    "src",
-    "ts"
+    "dist"
   ],
   "publishConfig": {
     "access": "public"
   },
   "bin": {
-    "aunty": "src/bin/aunty.js",
-    "nt": "src/bin/aunty.js"
+    "aunty": "dist/bin/aunty.js",
+    "nt": "dist/bin/aunty.js"
   },
-  "main": "src/api",
   "engines": {
-    "node": ">=16"
-  },
-  "dependencies": {
-    "@babel/core": "^7.11.4",
-    "@babel/plugin-syntax-dynamic-import": "^7.2.0",
-    "@babel/plugin-transform-react-jsx": "^7.3.0",
-    "@babel/preset-env": "^7.6.0",
-    "@babel/preset-react": "^7.0.0",
-    "@babel/preset-typescript": "^7.10.4",
-    "await-to-js": "^3.0.0",
-    "babel-core": "^7.0.0-bridge.0",
-    "babel-jest": "^26.1.0",
-    "babel-loader": "^8.2.2",
-    "basic-ftp": "^5.0.2",
-    "chalk": "^4.1.2",
-    "cli-select": "^1.1.2",
-    "copy-webpack-plugin": "^11.0.0",
-    "css-loader": "^6.7.1",
-    "csv-loader": "^3.0.3",
-    "deepmerge": "^4.0.0",
-    "del": "^6.0.0",
-    "dotenv": "^16.0.3",
-    "dotenv-webpack": "^8.0.1",
-    "execa": "^5.0.0",
-    "fork-ts-checker-webpack-plugin": "^6.2.1",
-    "ftp-deploy": "^2.3.8",
-    "get-all-paths": "^1.0.1",
-    "guess-root-path": "^1.0.0",
-    "i": "^0.3.6",
-    "import-lazy": "^4.0.0",
-    "import-local": "^3.0.2",
-    "jest": "^26.4.1",
-    "load-json-file": "^6.2.0",
-    "log-symbols": "^4.0.0",
-    "make-dir": "^3.0.0",
-    "mem": "^8.1.0",
-    "mini-css-extract-plugin": "^1.4.1",
-    "minimist": "^1.2.5",
-    "node-fetch": "^2.6.0",
-    "ora": "^5.0.0",
-    "pify": "^5.0.0",
-    "prettier": "^2.0.5",
-    "requireg": "^0.2.2",
-    "rsyncwrapper": "^3.0.1",
-    "sass": "^1.26.10",
-    "sass-loader": "^11.0.1",
-    "semver": "^7.3.2",
-    "style-loader": "^2.0.0",
-    "svelte": "^5.17.4",
-    "svelte-loader": "^3.2.4",
-    "svelte-preprocess": "^5.1.1",
-    "tcp-ping-sync": "^1.0.0",
-    "ts-loader": "^9.5.1",
-    "typescript": "^5.3.2",
-    "update-notifier": "^6.0.2",
-    "webpack": "^5.33.2",
-    "webpack-bundle-analyzer": "^4.5.0",
-    "webpack-dev-server": "^4.6.0",
-    "write-json-file": "^4.2.0",
-    "yeoman-environment": "^3.2.0",
-    "yeoman-generator": "^5.2.0"
+    "node": ">=20"
   },
   "devDependencies": {
-    "@types/jest": "^29.5.10",
-    "babel-eslint": "^10.1.0",
-    "eslint": "^7.7.0",
-    "eslint-config-prettier": "^8.2.0",
-    "release-it": "^15.1.4",
-    "yeoman-automation-adapter": "^2.0.0"
+    "@eslint/js": "^9.39.2",
+    "@types/node": "^25.0.10",
+    "eslint": "^9.39.2",
+    "rimraf": "^6.1.2",
+    "tsx": "^4.21.0",
+    "typescript": "^5.9.3",
+    "typescript-eslint": "^8.54.0"
   }
 }

package/scripts/postinstall.js

@@ -1,44 +0,0 @@
-/*
-    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/api/index.js

@@ -1,5 +0,0 @@
-const pkg = require('../../package');
-
-module.exports = {
-  version: pkg.version
-};

package/src/bin/aunty.js

@@ -1,27 +0,0 @@
-#!/usr/bin/env node
-
-if (!require('import-local')(__filename)) {
-  (async () => {
-    const importLazy = require('import-lazy')(require);
-    const { cli } = require('../cli');
-    const { createErrorLogo } = importLazy('../utils/branding');
-    const { error, log } = importLazy('../utils/logging');
-
-    function exit(err) {
-      if (err) {
-        log(createErrorLogo());
-        error(err);
-        process.exit(1);
-      }
-
-      process.exit(0);
-    }
-
-    process.on('uncaughtException', exit);
-    process.on('unhandledRejection', exit);
-
-    const [err] = await cli(process.argv.slice(2));
-
-    exit(err);
-  })();
-}

package/src/cli/build/constants.js

@@ -1,46 +0,0 @@
-// Ours
-const { cmd, hvy, opt, sec, req } = require('../../utils/color');
-
-module.exports.OPTIONS = {
-  boolean: ['local'],
-  string: ['id'],
-  alias: {
-    id: 'i',
-    local: 'l'
-  }
-};
-
-// TODO: Add aunty config section to usage
-
-module.exports.MESSAGES = {
-  build: ({ id, publicPaths }) => `Build (${hvy(process.env.NODE_ENV)}):${
-    id
-      ? `
-  ┣ ${hvy('id')}: ${req(id)}`
-      : ''
-  }
-  ┗ ${hvy('publicPaths')}:${publicPaths
-    .map(
-      (publicPath, index) => `
-    ${index === publicPaths.length - 1 ? '┗' : '┣'} ${hvy(`[${index}]`)}: ${req(publicPath)}`
-    )
-    .join('')}`,
-  usage: name => `Usage: ${cmd(`aunty ${name}`)} ${opt('[options]')}
-
-${sec('Options')}
-
-  ${opt('-d')}, ${opt('--dry')}           Output the generated webpack (& deploy) configuration, then exit
-  ${opt('-l')}, ${opt('--local')}         Only build for local purposes; don't output deploy configuration
-  ${opt('-i NAME')}, ${opt('--id=NAME')}  Id for this build (can be used in deploy 'to' path) ${opt(
-    `[default: ${cmd('git branch')}]`
-  )}
-
-${sec('Environment variables')}
-
-  • Builds will assume you have set ${cmd('NODE_ENV=production')}, unless you specify otherwise.
-`,
-  multipleErrors: errors => `Multiple build errors:
-
-${errors.join('\n\n')}
-`
-};

package/src/cli/build/index.js

@@ -1,100 +0,0 @@
-// Native
-const { join } = require('path');
-
-// External
-const importLazy = require('import-lazy')(require);
-const pify = importLazy('pify');
-const webpack = importLazy('webpack');
-const writeJsonFile = importLazy('write-json-file');
-
-// Ours
-const { getDeployConfig } = require('../../config/deploy');
-const { getProjectConfig } = require('../../config/project');
-const { getWebpackConfig } = require('../../config/webpack');
-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');
-const { command } = require('../');
-const cleanCommand = require('../clean');
-const { MESSAGES, OPTIONS } = require('./constants');
-
-const build = 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
-            }
-          : {}
-      )
-    );
-  }
-
-  throws(await cleanCommand(['--quiet']));
-
-  info(
-    MESSAGES.build({
-      id: deployConfig ? deployConfig.id : null,
-      publicPaths: deployConfig ? deployConfig.targets.map(x => x.publicPath) : [webpackConfig[0].output.publicPath]
-    })
-  );
-
-  let spinner = spin('Building');
-  const startTime = Date.now();
-  const compiler = webpack(webpackConfig);
-  const stats = unpack(await packs(pify(compiler.run.bind(compiler)))());
-
-  if (stats.hasErrors()) {
-    const errors = stats.toJson({}, true).errors;
-
-    spinner.fail();
-
-    if (errors.length > 1) {
-      throw MESSAGES.multipleErrors(errors.map(error => error.message));
-    }
-
-    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/clean/constants.js

@@ -1,10 +0,0 @@
-// Ours
-const { cmd, hvy } = require('../../utils/color');
-const { inlineList } = require('../../utils/text');
-
-module.exports.MESSAGES = {
-  clean: paths => `Clean:
-  ┗ ${hvy('paths')} ${inlineList(paths)}`,
-  usage: name => `Usage: ${cmd(`aunty ${name}`)}
-`
-};

package/src/cli/clean/index.js

@@ -1,40 +0,0 @@
-// External
-const importLazy = require('import-lazy')(require);
-const del = importLazy('del');
-
-// Ours
-const { getProjectConfig } = require('../../config/project');
-const { OUTPUT_DIRECTORY_NAME } = require('../../constants');
-const { dry, info, spin } = require('../../utils/logging');
-const { command } = require('../');
-const { MESSAGES } = require('./constants');
-
-module.exports = command(
-  {
-    name: 'clean',
-    usage: MESSAGES.usage
-  },
-  async argv => {
-    const { root } = getProjectConfig();
-    const globs = [OUTPUT_DIRECTORY_NAME];
-
-    if (argv.dry) {
-      return dry({
-        'Deletion paths': { globs, cwd: root }
-      });
-    }
-
-    let spinner;
-
-    if (!argv.quiet) {
-      info(MESSAGES.clean(globs));
-      spinner = spin(`Cleaning`);
-    }
-
-    await del(globs, { cwd: root });
-
-    if (!argv.quiet) {
-      spinner.succeed('Cleaned');
-    }
-  }
-);

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]')}
-`
-};