@abcnews/aunty 16.0.0 → 17.0.0-next.0

package/src/config/serve.js

@@ -1,144 +0,0 @@
-// Native
-const { homedir, hostname } = require('os');
-const { readFileSync } = require('fs');
-const { join } = require('path');
-const { Socket } = require('net');
-
-// External
-const { probe } = require('tcp-ping-sync');
-
-// Ours
-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 HOME_DIR = homedir();
-const SSL_DIR = '.aunty/ssl';
-const SERVER_CERT_FILENAME = (module.exports.SERVER_CERT_FILENAME = 'server.crt');
-const SERVER_KEY_FILENAME = (module.exports.SERVER_KEY_FILENAME = 'server.key');
-const INTERNAL_SUFFIX = '.aus.aunty.abc.net.au';
-const DEFAULT_HOST = (module.exports.DEFAULT_HOST = probe(INTERNAL_TEST_HOST)
-  ? `${hostname().toLowerCase().split('.')[0]}${INTERNAL_SUFFIX}` // hostname _may_ include INTERNAL_SUFFIX
-  : 'localhost');
-const DEFAULT_PORT = 8000;
-
-const addEnvironmentVariables = config => {
-  if (process.env.AUNTY_HOST) {
-    config.host = process.env.AUNTY_HOST;
-  }
-
-  if (process.env.AUNTY_PORT) {
-    config.port = process.env.AUNTY_PORT;
-  }
-
-  return 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}
- */
-const addUserSSLConfig = config => {
-  if (config.https === true) {
-    try {
-      config.https = {
-        cert: readFileSync(getSSLPath(config.host, SERVER_CERT_FILENAME)),
-        key: readFileSync(getSSLPath(config.host, SERVER_KEY_FILENAME))
-      };
-    } catch (e) {}
-  }
-
-  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 = errorType => {
-      socket.destroy();
-      info(MESSAGES.port({ port, errorType }));
-      if (port <= max) resolve(findPort(port + 1, max, host));
-      else reject(new Error('Could not find an available port'));
-    };
-
-    const found = () => {
-      socket.destroy();
-      resolve(port);
-    };
-
-    // Port is taken if connection can be made
-    socket.once('connect', () => next('in use'));
-
-    // Port is open if connection attempt times out
-    socket.setTimeout(500);
-    socket.once('timeout', found);
-
-    // If an error occurs, it's assumed the port is available.
-    socket.once('error', e => {
-      // 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. Log the code & keep seeking a free port.
-        next(`error code ${e.code}`);
-      }
-    });
-
-    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/config/webpack.js

@@ -1,325 +0,0 @@
-// Native
-const { existsSync } = require('fs');
-const { join, resolve } = require('path');
-
-// External
-const importLazy = require('import-lazy')(require);
-const CopyPlugin = importLazy('copy-webpack-plugin');
-const Dotenv = importLazy('dotenv-webpack');
-const ForkTsCheckerWebpackPlugin = importLazy('fork-ts-checker-webpack-plugin');
-const MiniCssExtractPlugin = importLazy('mini-css-extract-plugin');
-const sveltePreprocess = importLazy('svelte-preprocess');
-const EnvironmentPlugin = importLazy('webpack/lib/EnvironmentPlugin');
-
-// Ours
-const { combine, merge } = require('../utils/structures');
-const { getBabelConfig } = require('./babel');
-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: {
-      alias: {
-        react: 'preact',
-        'react-dom': 'preact/compat'
-      },
-
-      extensions: JSX_RESOLVE_EXTENSIONS
-    }
-  },
-  react: {
-    resolve: {
-      extensions: JSX_RESOLVE_EXTENSIONS
-    }
-  },
-
-  /**
-   * Svelte uses a function to modify the existing config, rather than just merging in.
-   * @see combine
-   */
-  svelte: config => {
-    config.resolve = {
-      extensions: [...config.resolve.extensions, '.svelte'],
-      mainFields: ['svelte', 'browser', 'module', 'main'],
-      conditionNames: ['svelte', 'browser', 'import']
-    };
-
-    const { include, loader, options } = getHintedRule(config, 'scripts');
-    const extractCSS = getHintedRule(config, 'styles').use[0].loader === MiniCssExtractPlugin.loader;
-
-    include.push(/(node_modules\/svelte)/);
-
-    // options from https://github.com/sveltejs/svelte-loader
-    config.module.rules.push(
-      ...[
-        {
-          test: /\.svelte\.ts$/,
-          use: [
-            {
-              loader,
-              options
-            },
-            { loader: require.resolve('ts-loader'), options: { transpileOnly: true } },
-            {
-              loader: require.resolve('svelte-loader'),
-              options: {
-                dev: config.mode === 'development',
-                emitCss: extractCSS,
-                preprocess: sveltePreprocess()
-              }
-            }
-          ]
-        },
-        {
-          test: /(?<!\.svelte)\.ts$/,
-          loader: require.resolve('ts-loader'),
-          options: {
-            transpileOnly: true // you should use svelte-check for type checking
-          }
-        },
-        {
-          // Svelte 5+:
-          test: /\.(svelte|svelte\.js)$/,
-          include,
-          use: [
-            {
-              loader,
-              options
-            },
-            {
-              loader: require.resolve('svelte-loader'),
-              options: {
-                dev: config.mode === 'development',
-                emitCss: extractCSS,
-                preprocess: sveltePreprocess()
-              }
-            }
-          ]
-        },
-        {
-          // required to prevent errors from Svelte on Webpack 5+, omit on Webpack 4
-          test: /node_modules\/svelte\/.*\.mjs$/,
-          resolve: {
-            fullySpecified: false
-          }
-        }
-      ]
-    );
-
-    return config;
-  }
-};
-const WEBPACK_CONFIG_FILE = 'webpack.config.js';
-
-module.exports.getWebpackConfig = () => {
-  const { root } = getProjectConfig();
-  const { addModernJS, showDeprecations } = getBuildConfig();
-  const customWebpackConfigFilePath = join(root, WEBPACK_CONFIG_FILE);
-
-  if (showDeprecations) {
-    process.traceDeprecation = true;
-  } else {
-    process.noDeprecation = true;
-  }
-
-  let config;
-
-  // If the project has a webpack config file, use it, otherwise create our own
-  if (existsSync(customWebpackConfigFilePath)) {
-    config = require(customWebpackConfigFilePath);
-
-    if (!Array.isArray(config)) {
-      config = [config];
-    }
-
-    // Ensure functions are resolved to objects
-    config = config.map(combine);
-  } else {
-    config = [createWebpackConfig()];
-
-    // Duplicate the config if the project expects an additional modern JS build
-    if (addModernJS) {
-      config.push(createWebpackConfig({ isModernJS: true }));
-    }
-  }
-
-  return config;
-};
-
-const createEntriesDictionary = (root, from, entry) =>
-  (Array.isArray(entry) ? entry : [entry]).reduce(
-    (memo, _entry) => ({ ...memo, [_entry]: [join(root, from, _entry)] }),
-    {}
-  );
-
-const resolveIncludedDependencies = (includedDependencies, root) => {
-  if (!Array.isArray(includedDependencies)) {
-    return [];
-  }
-
-  return includedDependencies.map(packageNameOrPattern => {
-    if (typeof packageNameOrPattern === 'string') {
-      return resolve(root, 'node_modules', packageNameOrPattern);
-    }
-
-    if (packageNameOrPattern instanceof RegExp) {
-      return new RegExp(join('node_modules', packageNameOrPattern.source), packageNameOrPattern.flags);
-    }
-
-    return null;
-  });
-};
-
-function createWebpackConfig({ isModernJS } = {}) {
-  const { pkg, root, hasTS, type, webpack: projectWebpackConfig } = getProjectConfig();
-  const { entry, extractCSS, from, includedDependencies, staticDir, to, useCSSModules } = getBuildConfig();
-  const isProd = process.env.NODE_ENV === 'production';
-  const hasEnvFile = existsSync(join(root, '.env'));
-  const hasEnvExampleFile = existsSync(join(root, '.env.example'));
-
-  const config = merge(
-    {
-      mode: isProd ? 'production' : 'development',
-      target: isModernJS ? 'web' : ['web', 'es5'],
-      cache: true,
-      entry: createEntriesDictionary(root, from, entry),
-      devtool: 'source-map',
-      output: {
-        path: join(root, to),
-        publicPath: '/',
-        filename: isModernJS ? '[name]_modern.js' : '[name].js'
-      },
-      resolve: {
-        extensions: ['.mjs', '.js', '.json', '.ts']
-      },
-      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)),
-            loader: require.resolve('babel-loader'),
-            options: getBabelConfig({ isModernJS })
-          },
-          {
-            __hint__: 'styles',
-            test: /\.(css|scss)$/,
-            use: [
-              extractCSS
-                ? {
-                    loader: MiniCssExtractPlugin.loader
-                  }
-                : {
-                    loader: require.resolve('style-loader')
-                  },
-              {
-                loader: require.resolve('css-loader'),
-                options: {
-                  modules: useCSSModules && {
-                    exportLocalsConvention: 'camelCase',
-                    localIdentContext: __dirname,
-                    //  ^^^ https://github.com/webpack-contrib/css-loader/issues/413#issuecomment-299578180
-                    localIdentHashSalt: `${pkg.name}@${pkg.version}`,
-                    localIdentName: `${isProd ? '' : '[folder]-[name]__[local]--'}[hash:base64:6]`
-                  },
-                  sourceMap: !isProd
-                }
-              },
-              {
-                loader: require.resolve('sass-loader')
-              }
-            ]
-          },
-          {
-            __hint__: 'data',
-            test: /\.[tc]sv$/,
-            loader: 'csv-loader',
-            options: {
-              dynamicTyping: true,
-              header: true,
-              skipEmptyLines: true
-            }
-          },
-          {
-            test: /\.(jpg|png|gif|mp4|m4v|flv|mp3|wav|m4a|eot|ttf|woff|woff2|webm|webp|avif)$/,
-            type: 'asset'
-          },
-          {
-            test: /\.svg$/,
-            resourceQuery: { not: [/raw/] },
-            type: 'asset'
-          },
-          {
-            resourceQuery: /raw/,
-            type: 'asset/source'
-          },
-          {
-            test: /\.html$/,
-            type: 'asset/source'
-          }
-        ]
-      },
-      plugins: [
-        new EnvironmentPlugin(Object.keys(process.env)),
-        hasEnvFile || hasEnvExampleFile
-          ? new Dotenv({
-              safe: hasEnvExampleFile
-            })
-          : null,
-        hasTS
-          ? new ForkTsCheckerWebpackPlugin({
-              logger: { infrastructure: 'silent', issues: 'silent' },
-              typescript: {
-                diagnosticOptions: {
-                  semantic: true,
-                  syntactic: true
-                }
-              }
-            })
-          : null,
-        extractCSS
-          ? new MiniCssExtractPlugin({
-              filename: `[name].css`
-            })
-          : null,
-        new CopyPlugin({
-          patterns: (Array.isArray(staticDir) ? staticDir : [staticDir]).map(dirName => ({
-            from: join(root, dirName)
-          }))
-        })
-      ].filter(x => x),
-      optimization: {
-        moduleIds: isProd ? 'deterministic' : 'named'
-      }
-    },
-    PROJECT_TYPES_CONFIG[type],
-    projectWebpackConfig
-  );
-
-  if (isProd) {
-    config.optimization.minimize = true;
-  }
-
-  // Cleanup hints
-  config.module.rules.forEach(rule => {
-    if (rule.__hint__) {
-      delete rule.__hint__;
-    }
-  });
-
-  return config;
-}
-
-function getHintedRule(config, hint) {
-  return config.module.rules.find(rule => rule.__hint__ === hint);
-}

package/src/config/webpackDevServer.js

@@ -1,46 +0,0 @@
-// Native
-const { join } = require('path');
-
-// Ours
-const { combine } = require('../utils/structures');
-const { getBuildConfig } = require('./build');
-const { getProjectConfig } = require('./project');
-const { getServeConfig } = require('./serve');
-
-module.exports.getWebpackDevServerConfig = async () => {
-  const { root, webpackDevServer: projectWebpackDevServerConfig } = getProjectConfig();
-  const { staticDir } = getBuildConfig();
-  const { host, hot, https, port } = await getServeConfig();
-
-  return combine(
-    {
-      allowedHosts: 'all',
-      client: {
-        logging: 'warn',
-        overlay: true,
-        webSocketURL: `ws${https ? 's' : ''}://${host}:${port}/ws`
-      },
-      devMiddleware: {
-        publicPath: `http${https ? 's' : ''}://${host}:${port}/`
-      },
-      headers: {
-        'Access-Control-Allow-Origin': '*'
-      },
-      host: '0.0.0.0',
-      hot,
-      port,
-      server: https
-        ? typeof https === 'object'
-          ? {
-              type: 'https',
-              options: https
-            }
-          : 'https'
-        : 'http',
-      static: (Array.isArray(staticDir) ? staticDir : [staticDir]).map(dirName => ({
-        directory: join(root, dirName)
-      }))
-    },
-    projectWebpackDevServerConfig
-  );
-};

package/src/constants.js

@@ -1,7 +0,0 @@
-module.exports = {
-  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'
-};

package/src/generators/component/index.js

@@ -1,172 +0,0 @@
-// External
-const Inflect = require('i')();
-const Generator = require('yeoman-generator');
-
-// Ours
-const { getProjectConfig } = require('../../config/project');
-const { cmd, hvy, opt } = require('../../utils/color');
-const { success } = require('../../utils/logging');
-const { installDependencies } = require('../../utils/npm');
-const { combine } = require('../../utils/structures');
-
-/**
- * Generate a Component
- */
-module.exports = class extends Generator {
-  constructor(args, opts) {
-    super(args, {
-      ...opts,
-      localConfigOnly: true
-    });
-
-    this.argument('name', { required: false });
-
-    this.option('template', {
-      description: 'Type of project [basic|preact|react|svelte]'
-    });
-    this.option('d3', { description: 'This component will use D3' });
-
-    this.dependencies = [];
-    this.devDependencies = [];
-  }
-
-  usage() {
-    return `${cmd('aunty generate component')} -- ${opt('[options] [<name>]')}`;
-  }
-
-  initializing() {
-    try {
-      const { root, type, hasTS } = getProjectConfig();
-
-      process.chdir(root);
-      this.destinationRoot(root);
-      this.options.template = type;
-      this.options.typescript = hasTS;
-    } catch (err) {}
-  }
-
-  async prompting() {
-    let prompts = [];
-
-    if (!this.options.template) {
-      prompts.push({
-        type: 'list',
-        name: 'template',
-        message: 'What type of project is it again?',
-        choices: [
-          { name: 'Preact', value: 'preact' },
-          { name: 'Basic', value: 'basic' },
-          { name: 'React', value: 'react' },
-          { name: 'Svelte', value: 'svelte' }
-        ]
-      });
-    }
-
-    if (!this.options.name) {
-      prompts.push({
-        type: 'input',
-        name: 'name',
-        message: 'Component name?',
-        default: 'NewComponent'
-      });
-    }
-
-    if (!this.options.d3) {
-      prompts.push({
-        type: 'confirm',
-        name: 'd3',
-        message: 'Is this a D3 component?',
-        default: false
-      });
-    }
-
-    if (prompts.length > 0) {
-      const answers = await this.prompt(prompts);
-      this.options = combine(this.options, answers);
-    }
-
-    this.options.name = Inflect.camelize(this.options.name.replace(' ', '_'));
-  }
-
-  writing() {
-    const isSFC = this.options.template === 'svelte';
-    const isJSX = this.options.template === 'preact' || this.options.template === 'react';
-    const sourceName = `component${this.options.d3 ? '-with-d3' : ''}`;
-    const sourceScriptExt = isJSX ? 'tsx' : 'ts';
-    const destinationScriptExt = this.options.typescript ? sourceScriptExt : 'js';
-    const context = {
-      className: this.options.name,
-      isTS: this.options.typescript
-    };
-
-    if (isSFC) {
-      this.fs.copyTpl(
-        this.templatePath(this.options.template, `${sourceName}.${this.options.template}`),
-        this.destinationPath(`src/components/${this.options.name}/${this.options.name}.${this.options.template}`),
-        context
-      );
-    } else {
-      this.fs.copyTpl(
-        this.templatePath(this.options.template, `${sourceName}.${sourceScriptExt}`),
-        this.destinationPath(`src/components/${this.options.name}/index.${destinationScriptExt}`),
-        context,
-        { globOptions: { noext: true } }
-      );
-      this.fs.copy(
-        this.templatePath(`_non_sfc/styles.scss`),
-        this.destinationPath(`src/components/${this.options.name}/styles.scss`),
-        context
-      );
-    }
-
-    this.fs.copyTpl(
-      this.templatePath(this.options.template, `${sourceName}.test.${sourceScriptExt}`),
-      this.destinationPath(
-        `src/components/${this.options.name}/${isSFC ? this.options.name : 'index'}.test.${destinationScriptExt}`
-      ),
-      context,
-      { globOptions: { noext: true } }
-    );
-  }
-
-  async install() {
-    if (this.options.typescript) {
-      this.devDependencies.push('@types/jest', '@types/webpack-env');
-    }
-
-    if (this.options.d3) {
-      this.dependencies.push('d3-selection');
-
-      if (this.options.typescript) {
-        this.devDependencies.push('@types/d3-selection');
-      }
-    }
-
-    switch (this.options.template) {
-      case 'preact':
-        this.devDependencies.push('html-looks-like', 'preact-render-to-string');
-        this.dependencies.push('preact');
-        break;
-      case 'react':
-        this.devDependencies.push(
-          'react-test-renderer',
-          ...(this.options.typescript ? ['@types/react', '@types/react-dom', '@types/react-test-renderer'] : [])
-        );
-        this.dependencies.push('react', 'react-dom');
-        break;
-      case 'svelte':
-        this.devDependencies.push('@testing-library/svelte');
-        this.dependencies.push('svelte');
-        break;
-      default:
-        break;
-    }
-
-    await installDependencies(this.devDependencies.sort(), ['--save-dev'], this.log);
-    await installDependencies(this.dependencies.sort(), null, this.log);
-  }
-
-  end() {
-    success(`Created ${hvy(this.options.name)} component`);
-  }
-};

package/src/generators/component/templates/_non_sfc/styles.scss

@@ -1,6 +0,0 @@
-.root {
-  border: 1px solid rgb(255, 115, 0);
-  padding: 20px;
-  text-align: center;
-  color: black;
-}