@madgex/fert 6.0.0 → 6.0.2

package/bin/cli.js

@@ -1,12 +1,17 @@
 #!/usr/bin/env node
 
-const fs = require('node:fs');
-const chalk = require('chalk');
-const cli = require('cac')('fert');
-const { VERSION } = require('../constants');
-const { printBanner } = require('./utils/index.js');
+import path from 'node:path';
+import fs from 'node:fs';
+import chalk from 'chalk';
+import cac from 'cac';
+import simpleUpdateNotifier from 'simple-update-notifier';
+import { VERSION } from '../constants.js';
+import { printBanner } from './utils/index.js';
+import { serviceCommandBootstrap } from './commands/_service-command-bootstrap.js';
+import { configsCommand } from './commands/configs.js';
+import { initCommand } from './commands/init.js';
 
-const { serivceCommandBootstrap } = require('./commands/_service-command-bootstrap.js');
+const cli = cac('fert');
 
 const run = () => {
   printBanner();
@@ -18,21 +23,21 @@ const run = () => {
     .option('--host [host]', '[string] specify hostname')
     .option('--port <port>', '[number] specify port')
     .option('--service-name <serviceName>', '[string] run a single service')
-    .action((...args) => serivceCommandBootstrap('dev', ...args));
+    .action((...args) => serviceCommandBootstrap('dev', ...args));
 
   cli
     .command('build', 'Build project. Can supply a branding directory if running FERT standalone')
     .option('--only <task>', `Only run part of the build [ 'assets', 'tokens']`)
     .option('--config [dir]', 'Use custom rollup config file')
     .option('--service-name <serviceName>', '[string] run a single service')
-    .action((...args) => serivceCommandBootstrap('build', ...args));
+    .action((...args) => serviceCommandBootstrap('build', ...args));
 
   cli
     .command('publish', 'Publish the project')
     .option('--target <env>', 'Environment to publish to, "dev" or "production"')
     .option('--service-name <serviceName>', '[string] run a single service')
     .option('--dry-run', 'Dry run, dont actually upload anything')
-    .action((...args) => serivceCommandBootstrap('publish', ...args));
+    .action((...args) => serviceCommandBootstrap('publish', ...args));
 
   cli
     .command('configs', 'Query/Publish project configs')
@@ -42,12 +47,12 @@ const run = () => {
       'Download known configs from the Configuration API for environment "dev" or "production"',
     )
     .option('--query [configName]', 'Describe known keys for a config, omit to list all known configs')
-    .action((...args) => require('./commands/configs')(...args));
+    .action((...args) => configsCommand(...args));
 
   cli
     .command('init [root]', 'Create a new branding project')
     .option('--cpid <cpid>', 'Specify the clientPropertyId to use in the new project')
-    .action((...args) => require('./commands/init')(...args));
+    .action((...args) => initCommand(...args));
 
   cli.option('--no-cache', 'Do not use cache');
   cli.option('--purge-cache', 'Purge all caches');
@@ -56,10 +61,10 @@ const run = () => {
   cli.parse();
 
   // checks for available update
-  const pkg = JSON.parse(fs.readFileSync(__dirname + '/../package.json'));
+  const pkg = JSON.parse(fs.readFileSync(path.join(import.meta.dirname, '..', 'package.json')));
 
   if (pkg.version.indexOf('0.0.0') !== 0) {
-    require('simple-update-notifier')({ pkg });
+    simpleUpdateNotifier({ pkg });
   }
 };
 
@@ -67,7 +72,7 @@ try {
   run();
 } catch (error) {
   if (error.name === 'CACError') {
-    console.error(chalk`\n{red ${error.message}}`);
+    console.error(chalk.red(`\n${error.message}`));
   } else {
     console.error(error);
   }

package/bin/commands/_service-command-bootstrap.js

@@ -1,24 +1,22 @@
-const chalk = require('chalk');
-
-const { loadServiceConfigFiles, loadConfigFromFile } = require('../utils/index.js');
-
-const commandDevSever = require('./dev-server.js');
-const commandBuild = require('./build.js');
-const commandPublish = require('./publish.js');
-const { FERT_SERVICE_CONFIG_FILENAME } = require('../../constants.js');
-const { log } = require('../utils/logging.js');
+import chalk from 'chalk';
+import { loadServiceConfigFiles, loadConfigFromFile } from '../utils/index.js';
+import { createDevServer } from './dev-server.js';
+import { build } from './build.js';
+import { publish } from './publish.js';
+import { FERT_SERVICE_CONFIG_FILENAME } from '../../constants.js';
+import { log } from '../utils/logging.js';
 
 const commandMap = {
-  dev: commandDevSever,
-  build: commandBuild,
-  publish: commandPublish,
+  dev: createDevServer,
+  build,
+  publish,
 };
 
 /**
  * determine if we are running a single service, otherwise search for all services
  * Then run command
  */
-module.exports.serivceCommandBootstrap = async function serivceCommandBootstrap(command, options) {
+export async function serviceCommandBootstrap(command, options) {
   // explicitly run a single service - via CLI option
   if (options.serviceName) {
     console.log(`🔦 ${chalk.green('Running single service mode')}`);
@@ -71,4 +69,4 @@ module.exports.serivceCommandBootstrap = async function serivceCommandBootstrap(
       });
     }
   }
-};
+}

package/bin/commands/build-tasks/build-external-assets.js

@@ -1,8 +1,8 @@
-const Path = require('node:path');
-const fs = require('node:fs/promises');
-const { log } = require('../../utils/logging');
+import Path from 'node:path';
+import fs from 'node:fs/promises';
+import { log } from '../../utils/logging.js';
 
-module.exports = async function buildExternalAssets(fertConfig) {
+export async function buildExternalAssets(fertConfig) {
   const { externalAssets, workingDir } = fertConfig;
   const destination = Path.join(workingDir, `/dist/external-assets.json`);
 
@@ -13,4 +13,4 @@ module.exports = async function buildExternalAssets(fertConfig) {
     log.error(err);
     throw err;
   }
-};
+}

package/bin/commands/build-tasks/build-tokens.js

@@ -1,10 +1,10 @@
-const Path = require('node:path');
-const fs = require('node:fs/promises');
-const { createStyleDictionary } = require('@madgex/design-system/style-dictionary');
-const { ensureTrailingSlash, exists } = require('../../utils');
-const { log } = require('../../utils/logging');
+import Path from 'node:path';
+import fs from 'node:fs/promises';
+import { createStyleDictionary } from '@madgex/design-system/style-dictionary';
+import { ensureTrailingSlash, exists } from '../../utils/index.js';
+import { log } from '../../utils/logging.js';
 
-module.exports = async function buildCssFromTokens(_srcTokensPath, _buildPath) {
+export async function buildCssFromTokens(_srcTokensPath, _buildPath) {
   const srcTokensPath = ensureTrailingSlash(Path.resolve(_srcTokensPath));
   const buildPath = ensureTrailingSlash(Path.resolve(_buildPath));
 
@@ -33,4 +33,4 @@ module.exports = async function buildCssFromTokens(_srcTokensPath, _buildPath) {
   await cleanTempFiles();
 
   log.success('Token build complete (CSS & JSON).');
-};
+}

package/bin/commands/build-tasks/bundle-entry.js

@@ -1,17 +1,20 @@
-const path = require('node:path');
-const _ = require('lodash');
-const vite = require('vite');
-const buildExternalAssets = require('./build-external-assets');
-const { log } = require('../../utils/logging');
+import path from 'node:path';
+import { pathToFileURL } from 'node:url';
+import merge from 'lodash/merge.js';
+import * as vite from 'vite';
+import { buildExternalAssets } from './build-external-assets.js';
+import { log } from '../../utils/logging.js';
 
-module.exports = async (fertConfig, options = {}) => {
+export async function bundleEntry(fertConfig, options = {}) {
   let dynamicOptions = {};
   let viteConfig = {};
 
   if (options.config) {
-    viteConfig = require(path.resolve(fertConfig.workingDir, options.config));
+    const viteConfigPkg = await import(pathToFileURL(path.resolve(fertConfig.workingDir, options.config)));
+    viteConfig = viteConfigPkg.default;
   } else {
-    viteConfig = require(path.resolve(__dirname, '../../../vite.config.js'));
+    const viteConfigPkg = await import('../../../vite.config.js');
+    viteConfig = viteConfigPkg.default;
   }
 
   dynamicOptions = {
@@ -26,11 +29,11 @@ module.exports = async (fertConfig, options = {}) => {
     },
   };
 
-  _.merge(viteConfig, dynamicOptions);
+  merge(viteConfig, dynamicOptions);
 
   await vite.build(viteConfig);
 
   await buildExternalAssets(fertConfig);
 
   log.success('Assets built.');
-};
+}

package/bin/commands/build.js

@@ -1,13 +1,15 @@
-const path = require('node:path');
-const { rimraf } = require('rimraf');
-const { resolveConfig } = require('../utils');
-const { log } = require('../utils/logging');
-const bundleEntry = require('./build-tasks/bundle-entry');
-const buildCssFromTokens = require('./build-tasks/build-tokens');
-const buildExternalAssets = require('./build-tasks/build-external-assets');
-const { validateLocalConfigs } = require('../utils/configs.js');
-
-module.exports = async (options = {}) => {
+import path from 'node:path';
+import { rimraf } from 'rimraf';
+import { resolveConfig } from '../utils/index.js';
+import { log } from '../utils/logging.js';
+import { bundleEntry } from './build-tasks/bundle-entry.js';
+import { buildCssFromTokens } from './build-tasks/build-tokens.js';
+import { buildExternalAssets } from './build-tasks/build-external-assets.js';
+import { validateLocalConfigs } from '../utils/configs.js';
+
+export { bundleEntry, buildExternalAssets };
+
+export async function build(options = {}) {
   const fertConfig = await resolveConfig(options);
   await validateLocalConfigs({
     workingDir: fertConfig.rootDir,
@@ -16,34 +18,28 @@ module.exports = async (options = {}) => {
 
   if (!options.only) {
     await rimraf(path.resolve(fertConfig.workingDir, 'dist'));
-    await exports.buildTokens(fertConfig, options);
-    await exports.bundleEntry(fertConfig, options);
+    await buildTokens(fertConfig, options);
+    await bundleEntry(fertConfig, options);
 
     return;
   }
 
   switch (options.only) {
     case 'tokens':
-      await exports.buildTokens(fertConfig, options);
+      await buildTokens(fertConfig, options);
       break;
     case 'assets':
-      await exports.bundleEntry(fertConfig, options);
+      await bundleEntry(fertConfig, options);
       break;
     default:
       log.error('"--only param" not recognixed. Not building.');
   }
-};
-
-// eslint-disable-next-line n/no-exports-assign
-exports = module.exports; // allow default export & { named } exports
+}
 
 // eslint-disable-next-line no-unused-vars
-exports.buildTokens = async (fertConfig, options = {}) => {
+export async function buildTokens(fertConfig, options = {}) {
   const { workingDir } = fertConfig;
   const tokenDist = path.join(workingDir, `/public/tokens/`);
 
   buildCssFromTokens(workingDir, tokenDist);
-};
-
-exports.bundleEntry = bundleEntry;
-exports.buildExternalAssets = buildExternalAssets;
+}

package/bin/commands/configs.js

@@ -1,14 +1,14 @@
-const { loadConfigFromFile, findFertConfigDir } = require('../utils/index.js');
-const { getConfigAPI, updateProjectConfigs } = require('../utils/configs.js');
-const chalk = require('chalk');
-const { log } = require('../utils/logging.js');
-const { getSchemaMeta } = require('../utils/getSchemaMeta.js');
-const ora = require('ora');
-const { mkdir, writeFile } = require('node:fs/promises');
-const Path = require('node:path');
-const { CONFIG_DIR } = require('../../constants.js');
-
-const handleDownload = async ({ workingDir }, api, options) => {
+import { loadConfigFromFile, findFertConfigDir } from '../utils/index.js';
+import { getConfigAPI, updateProjectConfigs } from '../utils/configs.js';
+import chalk from 'chalk';
+import { log } from '../utils/logging.js';
+import { getSchemaMeta } from '../utils/getSchemaMeta.js';
+import ora from 'ora';
+import { mkdir, writeFile } from 'node:fs/promises';
+import Path from 'node:path';
+import { CONFIG_DIR } from '../../constants.js';
+
+export async function handleDownload({ workingDir }, api, options) {
   const validTargets = ['dev', 'production'];
 
   if (!validTargets.includes(options.download)) {
@@ -79,9 +79,9 @@ const handleDownload = async ({ workingDir }, api, options) => {
     await writeFile(filePath, JSON.stringify(data, null, 2));
     console.log(` - ${schemaName}.json`);
   }
-};
+}
 
-const handlePublish = async ({ workingDir, clientPropertyId }, api, options) => {
+export async function handlePublish({ workingDir, clientPropertyId }, api, options) {
   const validTargets = ['dev', 'production'];
 
   if (!validTargets.includes(options.publish)) {
@@ -99,9 +99,9 @@ const handlePublish = async ({ workingDir, clientPropertyId }, api, options) =>
     // eslint-disable-next-line n/no-process-exit
     process.exit(1);
   }
-};
+}
 
-const handleQuery = async (/* { workingDir, clientPropertyId } */ _, api, options) => {
+export async function handleQuery(/* { workingDir, clientPropertyId } */ _, api, options) {
   try {
     if (options.query !== true) {
       console.log(chalk.cyan(`\nGetting schema description for config: ${chalk.bold(options.query)}...`));
@@ -131,9 +131,9 @@ const handleQuery = async (/* { workingDir, clientPropertyId } */ _, api, option
     // eslint-disable-next-line n/no-process-exit
     process.exit(1);
   }
-};
+}
 
-module.exports = async (options) => {
+export async function configsCommand(options) {
   const fertConfigDir = await findFertConfigDir();
 
   const { clientPropertyId } = await loadConfigFromFile({
@@ -156,8 +156,4 @@ module.exports = async (options) => {
   } else if (options.query) {
     await handleQuery({ clientPropertyId, workingDir: fertConfigDir }, api, options);
   }
-};
-
-module.exports.handleDownload = handleDownload;
-module.exports.handlePublish = handlePublish;
-module.exports.handleQuery = handleQuery;
+}

package/bin/commands/dev-server.js

@@ -1,15 +1,17 @@
-const path = require('node:path');
-const chalk = require('chalk');
-const open = require('open');
-const chokidar = require('chokidar');
-const { resolveConfig, findFertConfigDir } = require('../utils/index.js');
-const { log } = require('../utils/logging.js');
-const { validateLocalConfigs } = require('../utils/configs.js');
-const { devServer } = require('../../server');
-const { buildTokens, buildExternalAssets } = require('./build.js');
-const { BRAND_JSON_FILENAME, FERT_CONFIG_FILENAME, FERT_SERVICE_CONFIG_FILENAME } = require('../../constants.js');
+import path from 'node:path';
+// eslint-disable-next-line n/no-unsupported-features/node-builtins
+import { glob } from 'node:fs/promises';
+import chalk from 'chalk';
+import open from 'open';
+import chokidar from 'chokidar4';
+import { resolveConfig, findFertConfigDir } from '../utils/index.js';
+import { log } from '../utils/logging.js';
+import { validateLocalConfigs } from '../utils/configs.js';
+import { devServer } from '../../server/server.js';
+import { buildTokens, buildExternalAssets } from './build.js';
+import { BRAND_JSON_FILENAME, FERT_CONFIG_FILENAME, FERT_SERVICE_CONFIG_FILENAME } from '../../constants.js';
 
-module.exports = async (options = {}) => {
+export async function createDevServer(options = {}) {
   let fertConfig = await resolveConfig(options);
 
   console.log(
@@ -28,8 +30,8 @@ module.exports = async (options = {}) => {
   const fertConfigDir = await findFertConfigDir();
 
   // watch local configs - revalidate on change
-  const configsPath = path.resolve(fertConfigDir, './config/*.json');
-  chokidar.watch(configsPath, { ignoreInitial: true }).on('all', async () => {
+  const configPaths = await Array.fromAsync(glob(path.resolve(fertConfigDir, './config/*.json')));
+  chokidar.watch(configPaths, { ignoreInitial: true }).on('all', async () => {
     await validateLocalConfigs({
       workingDir: fertConfig.rootDir,
       clientPropertyId: fertConfig.clientPropertyId,
@@ -39,6 +41,7 @@ module.exports = async (options = {}) => {
 
   // watch brand.json & fert.config.js - refresh on change
   const brandPath = path.resolve(fertConfig.workingDir, BRAND_JSON_FILENAME);
+
   chokidar.watch(brandPath, { ignoreInitial: true }).on('all', async () => {
     await buildTokens(fertConfig);
   });
@@ -66,4 +69,4 @@ module.exports = async (options = {}) => {
   if (options.open) {
     await open(server.info.uri);
   }
-};
+}

package/bin/commands/init.js

@@ -1,18 +1,17 @@
-const path = require('node:path');
-const fs = require('node:fs');
-const chalk = require('chalk');
-const prompts = require('prompts');
-const uuidValidator = require('uuid-validate');
-const ora = require('ora');
-const { cpidLookup } = require('../utils/cpid-lookup');
-const fertPackageJSON = require('../../package.json');
-
-const { isEmptyDir, formatTargetDir, emptyDir } = require('../utils/index');
-const { FERT_CONFIG_FILENAME } = require('../../constants');
+import path from 'node:path';
+import fs from 'node:fs';
+import chalk from 'chalk';
+import prompts from 'prompts';
+import uuidValidator from 'uuid-validate';
+import ora from 'ora';
+import { cpidLookup } from '../utils/cpid-lookup.js';
+import fertPackageJSON from '../../package.json' with { type: 'json' };
+import { isEmptyDir, formatTargetDir, emptyDir } from '../utils/index.js';
+import { FERT_CONFIG_FILENAME } from '../../constants.js';
 
 const cwd = process.cwd();
 
-module.exports = async (root, options = {}) => {
+export async function initCommand(root, options = {}) {
   const defaultProjectName = 'madgex-{cpid}';
   const argTargetDir = root ? formatTargetDir(root) : null;
   const argClientPropertyId = options.cpid && uuidValidator(options.cpid) ? options.cpid : false;
@@ -91,7 +90,7 @@ module.exports = async (root, options = {}) => {
   console.log(`\nScaffolding project in ${chalk.bold(outDir)}…`);
 
   // copy boilerplate to output dir
-  const templateDir = path.resolve(__dirname, '../../repo-template');
+  const templateDir = path.resolve(import.meta.dirname, '../../repo-template');
   fs.cpSync(templateDir, outDir, { recursive: true });
 
   // Update new package.json
@@ -119,4 +118,4 @@ module.exports = async (root, options = {}) => {
   console.log(`  npm install`);
   console.log(`  npm run dev`);
   console.log();
-};
+}

package/bin/commands/publish-tasks/asset-store-uploader.js

@@ -1,14 +1,14 @@
-const fs = require('node:fs');
-const path = require('node:path');
-const Hoek = require('@hapi/hoek');
-const { log } = require('../../utils/logging');
-const axios = require('axios');
-const FormData = require('form-data');
-const ora = require('ora');
-const chalk = require('chalk');
-const { ASSET_STORE_USER_GUID } = require('../../../constants');
-
-module.exports = class AssetStoreUploader {
+import fs from 'node:fs';
+import path from 'node:path';
+import * as Hoek from '@hapi/hoek';
+import axios from 'axios';
+import FormData from 'form-data';
+import ora from 'ora';
+import chalk from 'chalk';
+import { log } from '../../utils/logging.js';
+import { ASSET_STORE_USER_GUID } from '../../../constants.js';
+
+export class AssetStoreUploader {
   constructor(options = {}) {
     Hoek.assert(options.apiUrl, 'apiUrl required');
     Hoek.assert(options.apiKey, 'apiKey required');
@@ -120,4 +120,4 @@ module.exports = class AssetStoreUploader {
 
     return files;
   };
-};
+}

package/bin/commands/publish-tasks/get-aws-parameter.js

@@ -1,5 +1,5 @@
-const { SSMClient, GetParameterCommand } = require('@aws-sdk/client-ssm');
-const { AWS_REGION } = require('../../../constants');
+import { SSMClient, GetParameterCommand } from '@aws-sdk/client-ssm';
+import { AWS_REGION } from '../../../constants.js';
 
 /**
  * Gets AWS parameter from the parameter store
@@ -13,7 +13,7 @@ const { AWS_REGION } = require('../../../constants');
  * @returns {Promise<{ value: string | undefined }>} the value of the requested AWS parameter
  *
  */
-const getAwsParam = async (paramName) => {
+export async function getAwsParam(paramName) {
   const client = new SSMClient({
     region: AWS_REGION,
   });
@@ -34,6 +34,4 @@ const getAwsParam = async (paramName) => {
   }
 
   return result;
-};
-
-module.exports = getAwsParam;
+}

package/bin/commands/publish.js

@@ -1,21 +1,21 @@
-const path = require('node:path');
-const Hoek = require('@hapi/hoek');
-const chalk = require('chalk');
-const { resolveConfig } = require('../utils');
-const { log } = require('../utils/logging');
-const getAwsParam = require('./publish-tasks/get-aws-parameter');
-const AssetStoreUploader = require('./publish-tasks/asset-store-uploader');
-const { getCloudFrontDistributionsForDomain } = require('../utils/lookup-cf-distribution-ids');
-const {
+import path from 'node:path';
+import * as Hoek from '@hapi/hoek';
+import chalk from 'chalk';
+import { resolveConfig } from '../utils/index.js';
+import { log } from '../utils/logging.js';
+import { getAwsParam } from './publish-tasks/get-aws-parameter.js';
+import { AssetStoreUploader } from './publish-tasks/asset-store-uploader.js';
+import { getCloudFrontDistributionsForDomain } from '../utils/lookup-cf-distribution-ids.js';
+import {
   ASSET_STORE_API,
   AWS_PARAM_NAME,
   REMOTE_UPLOAD_BASE,
   UPLOAD_DIR,
   ASSET_STORE_INVALIDATION_PATH,
   BRANDED_SITE_INVALIDATION_PATH,
-} = require('../../constants');
+} from '../../constants.js';
 
-module.exports = async (options) => {
+export async function publish(options) {
   const fertConfig = await resolveConfig(options);
   const validTargets = ['dev', 'prod', 'production'];
 
@@ -83,4 +83,4 @@ module.exports = async (options) => {
   } catch (error) {
     log.error('An error occurred during the publish process', error);
   }
-};
+}