@madgex/fert 5.0.3 → 5.0.5

package/README.md

@@ -149,10 +149,9 @@ When faced with an empty branding repo, this will help the user get started with
 
 **Options**
 
-| Option                  |                                                        |
-| ----------------------- | ------------------------------------------------------ |
-| `--template <template>` | Specify the template you wish to use when scaffolding  |
-| `--cpid <cpid>`         | Specify the clientPropertyId to use in the new project |
+| Option          |                                                        |
+| --------------- | ------------------------------------------------------ |
+| `--cpid <cpid>` | Specify the clientPropertyId to use in the new project |
 
 **Outline of implementation**
 
@@ -198,7 +197,7 @@ Templates & CSS may be processed using the [CSS Modules](https://github.com/css-
 ## Publish
 
 From root, run for all services or a specific service:
-`fert publish --target=prod` | `fert publish --target=prod --service-name=jobseekers-frontend`
+`fert publish --target=production` | `fert publish --target=production --service-name=jobseekers-frontend`
 
 Run for 1 service from the service folder:
 `cd services/jobseekers-frontend`
@@ -208,10 +207,10 @@ Run for 1 service from the service folder:
 
 `fert publish  --target [target]`
 
-| Option      |                                                                              |
-| ----------- | ---------------------------------------------------------------------------- |
-| `--target`  | Where to publish the `dist` directory assets.<br/>`dev` \| `prod` (`string`) |
-| `--dry-run` | Dry run, dont actually upload anything                                       |
+| Option      |                                                                                    |
+| ----------- | ---------------------------------------------------------------------------------- |
+| `--target`  | Where to publish the `dist` directory assets.<br/>`dev` \| `production` (`string`) |
+| `--dry-run` | Dry run, dont actually upload anything                                             |
 
 Send all files and directories created in the `dist` directory to either development or production versions of the Asset Store API. Files uploaded to the Asset Store API are available via a CloudFront-based CDN.
 
@@ -316,7 +315,19 @@ These options are available no matter the command used.
 
 # CI/CD
 
-It's intended that the branding repos have their own build/deploy pipeline. Each change that's merged to `master` will trigger a build (`npm run build` as a common entry point) and the resulting output directory (`dist`) is pushed up to the `asset-store-api` for use in production.
+All branding repos use a common jekinsfile and Dockerfile to build/deploy, and will use this FERT tool.
+
+- Here is the jenkinsfile all branding repos use: https://github.com/wiley/madgex-jenkins-shared-library/blob/master/vars/clientRepoDeploymentPipeline.groovy .
+- And the Dockerfile they all use [is in this repo](shared/Dockerfile.brandingRepoPublish).
+
+Each change that's pushed to a branch will trigger:
+
+1. a build (`npm run build` inside the [Dockerfile](shared/Dockerfile.brandingRepoPublish) as a common entry point), which creates a `dist` folder full of assets ready to upload.
+2. The [jenkinsfile](https://github.com/wiley/madgex-jenkins-shared-library/blob/master/vars/clientRepoDeploymentPipeline.groovy) pipeline will run `fert publish` to send all built assets to the Asset Store API.
+3. The [jenkinsfile](https://github.com/wiley/madgex-jenkins-shared-library/blob/master/vars/clientRepoDeploymentPipeline.groovy) pipeline will run `fert configs --publish`, Uploading the branding repo's client `/configs` to the configuration-api.
+
+> [!NOTE] > `master` branch will go to `production`. All other branches will go to `jb dev`.
+> `master` branch will go to `production`. All other branches will go to `jb dev`.
 
 ## `npm scripts`
 
@@ -330,5 +341,3 @@ Here are the default npm scripts in a Fert-scaffolded project.
   }
 }
 ```
-
-Its expected that a Jenkins pipeline will run `fert publish` to send all built assets to the Asset Store API.

package/bin/cli.js

@@ -6,18 +6,13 @@ const cli = require('cac')('fert');
 const { VERSION } = require('../constants');
 const { printBanner } = require('./utils/index.js');
 
-const {
-  serivceCommandBootstrap,
-} = require('./commands/_service-command-bootstrap.js');
+const { serivceCommandBootstrap } = require('./commands/_service-command-bootstrap.js');
 
 const run = () => {
   printBanner();
 
   cli
-    .command(
-      '',
-      'Start layout server. Can supply a branding directory if running FERT standalone'
-    )
+    .command('', 'Start layout server. Can supply a branding directory if running FERT standalone')
     .alias('dev')
     .option('--open', 'Automatically open the dev server in your browser')
     .option('--host [host]', '[string] specify hostname')
@@ -26,10 +21,7 @@ const run = () => {
     .action((...args) => serivceCommandBootstrap('dev', ...args));
 
   cli
-    .command(
-      'build',
-      'Build project. Can supply a branding directory if running FERT standalone'
-    )
+    .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')
@@ -37,34 +29,24 @@ const run = () => {
 
   cli
     .command('publish', 'Publish the project')
-    .option('--target <env>', 'Environment to publish to, "dev" or "prod"')
+    .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));
 
   cli
     .command('configs', 'Query/Publish project configs')
-    .option(
-      '--publish <env>',
-      'Publish configs to Configuration API environment "dev" or "production"'
-    )
+    .option('--publish <env>', 'Publish configs to Configuration API environment "dev" or "production"')
     .option(
       '--download <env>',
-      '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'
+      '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));
 
   cli
     .command('init [root]', 'Create a new branding project')
-    .option('--template <template>', 'Template to use when scaffolding project')
-    .option(
-      '--cpid <cpid>',
-      'Specify the clientPropertyId to use in the new project'
-    )
+    .option('--cpid <cpid>', 'Specify the clientPropertyId to use in the new project')
     .action((...args) => require('./commands/init')(...args));
 
   cli.option('--no-cache', 'Do not use cache');
@@ -89,6 +71,6 @@ try {
   } else {
     console.error(error);
   }
-
+  // eslint-disable-next-line n/no-process-exit
   process.exit(1);
 }

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

@@ -1,12 +1,6 @@
 const chalk = require('chalk');
 
-const {
-  loadServiceConfigFiles,
-  loadConfigFromFile,
-  findFertConfigDir,
-} = require('../utils/index.js');
-const { getConfigAPI, validateLocalConfigs } = require('../utils/configs.js');
-const { handlePublish } = require('../commands/configs.js');
+const { loadServiceConfigFiles, loadConfigFromFile } = require('../utils/index.js');
 
 const commandDevSever = require('./dev-server.js');
 const commandBuild = require('./build.js');
@@ -24,10 +18,7 @@ const commandMap = {
  * determine if we are running a single service, otherwise search for all services
  * Then run command
  */
-module.exports.serivceCommandBootstrap = async function serivceCommandBootstrap(
-  command,
-  options
-) {
+module.exports.serivceCommandBootstrap = async function serivceCommandBootstrap(command, options) {
   // explicitly run a single service - via CLI option
   if (options.serviceName) {
     console.log(`🔦 ${chalk.green('Running single service mode')}`);
@@ -65,50 +56,19 @@ module.exports.serivceCommandBootstrap = async function serivceCommandBootstrap(
   }
 
   console.log(
-    `🔦 ${chalk.green('Running multi service mode')}, calling ${chalk.cyan(command)} on ${chalk.cyan(serviceConfigs.length)} ${serviceConfigs.length === 1 ? 'service' : 'services'} [${serviceConfigs.map((i) => chalk.cyanBright(i?.serviceConfig?.serviceName || 'Unknown')).join(', ')}]`
+    `🔦 ${chalk.green('Running multi service mode')}, calling ${chalk.cyan(command)} on ${chalk.cyan(serviceConfigs.length)} ${serviceConfigs.length === 1 ? 'service' : 'services'} [${serviceConfigs.map((i) => chalk.cyanBright(i?.serviceConfig?.serviceName || 'Unknown')).join(', ')}]`,
   );
-  try {
-    for (const { serviceConfig } of serviceConfigs) {
-      try {
-        await commandMap[command]({
-          ...options,
-          serviceName: serviceConfig.serviceName,
-        });
-      } catch (err) {
-        throw new Error(
-          `Failed to run command ${command} on service ${serviceConfig.serviceName}: ${err.message}`,
-          { cause: err }
-        );
-      }
-    }
 
-    // if we're publishing, update all configs on configuration API
-    if (command === 'publish') {
-      options.target = options.target === 'dev' ? 'dev' : 'production';
-      const rootDir = await findFertConfigDir();
-      const { clientPropertyId } = await loadConfigFromFile({ dir: rootDir });
-      const api = await getConfigAPI({
-        clientPropertyId,
-        environment: options.target,
+  for (const { serviceConfig } of serviceConfigs) {
+    try {
+      await commandMap[command]({
+        ...options,
+        serviceName: serviceConfig.serviceName,
+      });
+    } catch (err) {
+      throw new Error(`Failed to run command ${command} on service ${serviceConfig.serviceName}: ${err.message}`, {
+        cause: err,
       });
-
-      // validate & upload local configs to configuration API
-      if (!options.dryRun) {
-        await handlePublish({ clientPropertyId, workingDir: rootDir }, api, {
-          publish: options.target,
-        });
-      } else {
-        await validateLocalConfigs({
-          clientPropertyId,
-          workingDir: rootDir,
-          throwable: true,
-        });
-      }
-
-      log.success(`${chalk.green('Publish completed successfully')}`);
     }
-  } catch (error) {
-    log.error('Failed to run command', command, options);
-    console.error(error);
   }
 };

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

@@ -1,17 +1,13 @@
 const Path = require('node:path');
 const fs = require('node:fs/promises');
 const StyleDictionaryPackage = require('style-dictionary');
-const {
-  registerTransforms,
-} = require('@madgex/design-system/tasks/registerTransforms');
+const { registerTransforms } = require('@madgex/design-system/tasks/registerTransforms');
 const colorTransforms = require('@madgex/design-system/tasks/colorTransforms');
 const { ensureTrailingSlash, exists } = require('../../utils');
 const { log } = require('../../utils/logging');
 const { TMP_DIR } = require('../../../constants');
 
-const dsTokensPath = Path.dirname(
-  require.resolve('@madgex/design-system/src/tokens/_config.js')
-);
+const dsTokensPath = Path.dirname(require.resolve('@madgex/design-system/src/tokens/_config.js'));
 
 // eslint-disable-next-line no-unused-vars
 const createTempBrandFile = async (dir = './') => {
@@ -35,9 +31,9 @@ async function runSilently(fn) {
   console.log = originalLog;
 }
 
-module.exports = async function buildCssFromTokens(srcTokensPath, buildPath) {
-  srcTokensPath = ensureTrailingSlash(Path.resolve(srcTokensPath));
-  buildPath = ensureTrailingSlash(Path.resolve(buildPath));
+module.exports = async function buildCssFromTokens(_srcTokensPath, _buildPath) {
+  const srcTokensPath = ensureTrailingSlash(Path.resolve(_srcTokensPath));
+  const buildPath = ensureTrailingSlash(Path.resolve(_buildPath));
 
   const brandFile = Path.join(srcTokensPath, 'brand.json');
 
@@ -46,24 +42,14 @@ module.exports = async function buildCssFromTokens(srcTokensPath, buildPath) {
   }
 
   // Fetch the file so we can transform the colours in style dictionary
-  const brandObj = JSON.parse(
-    await fs.readFile(brandFile, { encoding: 'utf8' })
-  );
+  const brandObj = JSON.parse(await fs.readFile(brandFile, { encoding: 'utf8' }));
   const tmpBrandFile = await createTempBrandFile(srcTokensPath);
 
-  await fs.writeFile(
-    Path.join(tmpBrandFile),
-    JSON.stringify(colorTransforms(brandObj))
-  );
+  await fs.writeFile(Path.join(tmpBrandFile), JSON.stringify(colorTransforms(brandObj)));
 
   // TODO - Investigate whether we can retrieve from DS instead of redefining
   // e.g. const { registerTransforms } = require('@madgex/design-system/tasks/registerTransforms');
-  const transforms = [
-    'attribute/cti',
-    'name/cti/kebab',
-    'color/css',
-    'css/rawData',
-  ];
+  const transforms = ['attribute/cti', 'name/cti/kebab', 'color/css', 'css/rawData'];
   const prefix = 'mds';
 
   // TODO - Investigate whether we can retrieve from DS instead of redefining

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

@@ -21,10 +21,7 @@ module.exports = async (fertConfig, options = {}) => {
       cssCodeSplit: false, // important: to get a single, style.css file output
       outDir: path.resolve(fertConfig.workingDir, 'dist'),
       rollupOptions: {
-        input: path.resolve(
-          fertConfig.workingDir,
-          fertConfig.entry || './src/index.js'
-        ),
+        input: path.resolve(fertConfig.workingDir, fertConfig.entry || './src/index.js'),
       },
     },
   };

package/bin/commands/build.js

@@ -34,6 +34,7 @@ module.exports = async (options = {}) => {
   }
 };
 
+// eslint-disable-next-line n/no-exports-assign
 exports = module.exports; // allow default export & { named } exports
 
 // eslint-disable-next-line no-unused-vars

package/bin/commands/configs.js

@@ -12,9 +12,7 @@ const handleDownload = async ({ workingDir }, api, options) => {
   const validTargets = ['dev', 'production'];
 
   if (!validTargets.includes(options.download)) {
-    throw new Error(
-      `Missing or invalid --download option. Choose from [${validTargets}]`
-    );
+    throw new Error(`Missing or invalid --download option. Choose from [${validTargets}]`);
   }
 
   const spinner = ora('Downloading v6 configs...').start();
@@ -53,7 +51,7 @@ const handleDownload = async ({ workingDir }, api, options) => {
         } catch (error) {
           log.debug(
             `Unable to retrieve ${chalk.cyan(error.url || schemaName + '/' + configKey)}`,
-            error.message || error.statusText || error
+            error.message || error.statusText || error,
           );
         }
       }
@@ -61,9 +59,7 @@ const handleDownload = async ({ workingDir }, api, options) => {
 
     spinner.succeed();
   } catch (error) {
-    spinner.fail(
-      `Error ${error.code ? `[${error.code}]` : ''}: ${error.message}`
-    );
+    spinner.fail(`Error ${error.code ? `[${error.code}]` : ''}: ${error.message}`);
     throw error;
   }
 
@@ -83,17 +79,11 @@ const handleDownload = async ({ workingDir }, api, options) => {
   }
 };
 
-const handlePublish = async (
-  { workingDir, clientPropertyId },
-  api,
-  options
-) => {
+const handlePublish = async ({ workingDir, clientPropertyId }, api, options) => {
   const validTargets = ['dev', 'production'];
 
   if (!validTargets.includes(options.publish)) {
-    throw new Error(
-      `Missing or invalid --publish option. Choose from [${validTargets}]`
-    );
+    throw new Error(`Missing or invalid --publish option. Choose from [${validTargets}]`);
   }
 
   try {
@@ -104,34 +94,23 @@ const handlePublish = async (
     });
   } catch (err) {
     log.debug(err);
+    // eslint-disable-next-line n/no-process-exit
     process.exit(1);
   }
 };
 
-const handleQuery = async (
-  /* { workingDir, clientPropertyId } */ _,
-  api,
-  options
-) => {
+const handleQuery = async (/* { workingDir, clientPropertyId } */ _, api, options) => {
   try {
     if (options.query !== true) {
-      console.log(
-        chalk.cyan(
-          `\nGetting schema description for config: ${chalk.bold(options.query)}...`
-        )
-      );
+      console.log(chalk.cyan(`\nGetting schema description for config: ${chalk.bold(options.query)}...`));
       const schema = api.schemas[options.query];
       if (!schema) {
-        console.error(
-          chalk.red(`Schema not found for ${chalk.bold(options.query)}`)
-        );
+        console.error(chalk.red(`Schema not found for ${chalk.bold(options.query)}`));
         return;
       }
 
       console.log(JSON.stringify(schema.describe().keys, null, 2));
-      console.log(
-        `\n${chalk.cyan('Configs default values')}:\n${JSON.stringify(schema.validate({}).value, null, 2)}`
-      );
+      console.log(`\n${chalk.cyan('Configs default values')}:\n${JSON.stringify(schema.validate({}).value, null, 2)}`);
       return;
     }
 
@@ -141,14 +120,13 @@ const handleQuery = async (
         .sort((a, b) => a.toLowerCase().localeCompare(b.toLowerCase()))
         .map((key) => ` * ${key}`)
         .join('\n'),
-      '\n'
+      '\n',
     );
 
-    console.log(
-      'Use `fert configs <configName>` to get a specific schema description'
-    );
+    console.log('Use `fert configs <configName>` to get a specific schema description');
   } catch (err) {
     log.debug(err);
+    // eslint-disable-next-line n/no-process-exit
     process.exit(1);
   }
 };
@@ -165,30 +143,16 @@ module.exports = async (options) => {
   });
 
   if (!options.publish && !options.query && !options.download) {
-    console.log(
-      chalk.red(`Missing required --publish, --query or --download option`)
-    );
+    console.log(chalk.red(`Missing required --publish, --query or --download option`));
     return;
   }
 
   if (options.download) {
-    await handleDownload(
-      { clientPropertyId, workingDir: fertConfigDir },
-      api,
-      options
-    );
+    await handleDownload({ clientPropertyId, workingDir: fertConfigDir }, api, options);
   } else if (options.publish) {
-    await handlePublish(
-      { clientPropertyId, workingDir: fertConfigDir },
-      api,
-      options
-    );
+    await handlePublish({ clientPropertyId, workingDir: fertConfigDir }, api, options);
   } else if (options.query) {
-    await handleQuery(
-      { clientPropertyId, workingDir: fertConfigDir },
-      api,
-      options
-    );
+    await handleQuery({ clientPropertyId, workingDir: fertConfigDir }, api, options);
   }
 };
 

package/bin/commands/dev-server.js

@@ -7,21 +7,15 @@ 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');
+const { BRAND_JSON_FILENAME, FERT_CONFIG_FILENAME, FERT_SERVICE_CONFIG_FILENAME } = require('../../constants.js');
 
 module.exports = async (options = {}) => {
   let fertConfig = await resolveConfig(options);
 
   console.log(
-    `Starting branding server for ${chalk.green(
-      fertConfig.client.brandName
-    )} [${fertConfig.serviceName}] ${chalk.dim(
-      `(${fertConfig.clientPropertyId})`
-    )}\n`
+    `Starting branding server for ${chalk.green(fertConfig.client.brandName)} [${fertConfig.serviceName}] ${chalk.dim(
+      `(${fertConfig.clientPropertyId})`,
+    )}\n`,
   );
 
   await validateLocalConfigs({
@@ -50,10 +44,7 @@ module.exports = async (options = {}) => {
   });
 
   const configPath = path.resolve(fertConfigDir, FERT_CONFIG_FILENAME);
-  const serviceConfigPath = path.resolve(
-    fertConfig.workingDir,
-    FERT_SERVICE_CONFIG_FILENAME
-  );
+  const serviceConfigPath = path.resolve(fertConfig.workingDir, FERT_SERVICE_CONFIG_FILENAME);
   chokidar.watch([configPath, serviceConfigPath]).on('change', async () => {
     console.log('Config changed, reloading…');
     fertConfig = await resolveConfig(options);