@madgex/fert 5.0.0 → 5.0.1

package/README.md

@@ -91,7 +91,7 @@ e.g.
 
 ```js
 module.exports = {
-  name: 'jobseekers-frontend',
+  serviceName: 'jobseekers-frontend',
   entry: './src/index.js',
   externalAssets: {
     links: [],

package/bin/commands/build.js

@@ -9,13 +9,10 @@ const { validateLocalConfigs } = require('../utils/configs.js');
 
 module.exports = async (options = {}) => {
   const fertConfig = await resolveConfig(options);
-  await validateLocalConfigs(
-    {
-      workingDir: fertConfig.rootDir,
-      clientPropertyId: fertConfig.clientPropertyId,
-    },
-    { throwable: true }
-  );
+  await validateLocalConfigs({
+    workingDir: fertConfig.rootDir,
+    clientPropertyId: fertConfig.clientPropertyId,
+  });
 
   if (!options.only) {
     await rimraf(path.resolve(fertConfig.workingDir, 'dist'));

package/bin/commands/dev-server.js

@@ -24,7 +24,11 @@ module.exports = async (options = {}) => {
     )}\n`
   );
 
-  await validateLocalConfigs(fertConfig);
+  await validateLocalConfigs({
+    workingDir: fertConfig.rootDir,
+    clientPropertyId: fertConfig.clientPropertyId,
+    throwable: false,
+  });
   await buildTokens(fertConfig);
 
   const fertConfigDir = await findFertConfigDir();
@@ -32,7 +36,11 @@ module.exports = async (options = {}) => {
   // watch local configs - revalidate on change
   const configsPath = path.resolve(fertConfigDir, './config/*.json');
   chokidar.watch(configsPath, { ignoreInitial: true }).on('all', async () => {
-    await validateLocalConfigs(fertConfig);
+    await validateLocalConfigs({
+      workingDir: fertConfig.rootDir,
+      clientPropertyId: fertConfig.clientPropertyId,
+      throwable: false,
+    });
   });
 
   // watch brand.json & fert.config.js - refresh on change

package/bin/commands/publish.js

@@ -84,17 +84,16 @@ module.exports = async (options) => {
     }
     // validate & upload local configs to configuration API
     if (!options.dryRun) {
-      await updateProjectConfigs(fertConfig, {
+      await updateProjectConfigs({
+        workingDir: fertConfig.rootDir,
+        clientPropertyId: fertConfig.clientPropertyId,
         environment: fertConfig.currBranch === 'master' ? 'production' : 'dev',
       });
     } else {
-      await validateLocalConfigs(
-        {
-          workingDir: fertConfig.rootDir,
-          clientPropertyId: fertConfig.clientPropertyId,
-        },
-        { throwable: true }
-      );
+      await validateLocalConfigs({
+        workingDir: fertConfig.rootDir,
+        clientPropertyId: fertConfig.clientPropertyId,
+      });
     }
 
     log.success(

package/bin/utils/configs.js

@@ -9,9 +9,10 @@ const { CONFIG_DIR } = require('../../constants');
 /**
  * Validates the local configuration files against the provided schema.
  *
- * @param {Object} fertConfig - The project config.
- * @param {Object} options - The options object.
- * @param {boolean} options.catch - Whether to catch validation errors or just log them.
+ * @param {Object} options - required, The options object.
+ * @param {string} options.workingDir - required, Working dir for configs - should usually be 'root' where fert.config.js is
+ * @param {string} options.clientPropertyId - required, clientPropertyId
+ * @param {boolean} options.throwable -  default: true, Whether to throw validation errors or just log them.
  *
  * @returns {Promise<void>} - Returns a promise that resolves if all configurations are valid.
  * @throws {Error} - Throws an error if any configuration is invalid.
@@ -19,7 +20,7 @@ const { CONFIG_DIR } = require('../../constants');
 const validateLocalConfigs = async ({
   workingDir,
   clientPropertyId,
-  throwable = false,
+  throwable = true,
 }) => {
   Hoek.assert(clientPropertyId, 'clientPropertyId is required');
   Hoek.assert(workingDir, 'workingDir is required');
@@ -97,6 +98,12 @@ const getConfigAPI = async ({
   return api;
 };
 
+/**
+ * loading all configs from a directory (usually root /configs folder)
+ *
+ * @param {string} workingDir
+ * @returns {Promise<Object>} - Object map of configs loaded from files {filename:configJSON,...}
+ */
 const loadLocalConfigs = (workingDir) => {
   const dir = path.join(workingDir, CONFIG_DIR);
   const configs = {};
@@ -130,7 +137,10 @@ const loadLocalConfigs = (workingDir) => {
 /**
  * Handles the removal and setting of project configs in the Configuration API.
  *
- * @param {Object} fertConfig - The project config.
+ * @param {Object} options - required, The options object.
+ * @param {string} options.workingDir - required, Working dir for configs - should usually be 'root' where fert.config.js is
+ * @param {string} options.clientPropertyId - required, clientPropertyId
+ * @param {string} options.environment - default=production, clientPropertyId
  *
  * @returns {Promise<boolean>} - Returns a promise that resolves to true if the update is successful.
  */
@@ -140,6 +150,7 @@ const updateProjectConfigs = async ({
   environment = 'production',
 } = {}) => {
   Hoek.assert(clientPropertyId, 'clientPropertyId is required');
+  Hoek.assert(workingDir, 'workingDir is required');
 
   const dir = path.join(workingDir, CONFIG_DIR);
   let spinner;
@@ -151,10 +162,7 @@ const updateProjectConfigs = async ({
   }
 
   try {
-    await validateLocalConfigs(
-      { clientPropertyId, workingDir },
-      { catch: false }
-    );
+    await validateLocalConfigs({ clientPropertyId, workingDir });
     const api = await getConfigAPI({ clientPropertyId, environment });
     spinner = ora('Fetching local configs').start();
 

package/bin/utils/configs.test.js

@@ -9,13 +9,14 @@ describe('configs', () => {
     it('logs debug message if config directory does not exist', async (t) => {
       const fsSpy = t.mock.method(fs, 'existsSync');
       const logSpy = t.mock.method(log, 'debug');
-      const fertConfig = {
-        workingDir: '/non/existent/dir',
-        clientPropertyId: 'cpid',
-      };
+      const workingDir = '/non/existent/dir';
+      const clientPropertyId = 'cpid';
       let calls;
 
-      await validateLocalConfigs(fertConfig);
+      await validateLocalConfigs({
+        workingDir,
+        clientPropertyId,
+      });
 
       calls = fsSpy.mock.calls;
       assert.strictEqual(calls[0].arguments[0], '/non/existent/dir/config');
@@ -31,13 +32,14 @@ describe('configs', () => {
     it('logs debug message if config directory does not exist', async (t) => {
       const fsSpy = t.mock.method(fs, 'existsSync');
       const logSpy = t.mock.method(log, 'debug');
-      const fertConfig = {
-        workingDir: '/non/existent/dir',
-        clientPropertyId: 'cpid',
-      };
+      const workingDir = '/non/existent/dir';
+      const clientPropertyId = 'cpid';
       let calls;
 
-      await updateProjectConfigs(fertConfig);
+      await updateProjectConfigs({
+        workingDir,
+        clientPropertyId,
+      });
 
       calls = fsSpy.mock.calls;
       assert.strictEqual(calls[0].arguments[0], '/non/existent/dir/config');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@madgex/fert",
-  "version": "5.0.0",
+  "version": "5.0.1",
   "description": "Tool to help build the V6 branding",
   "bin": {
     "fert": "./bin/cli.js"
@@ -38,7 +38,6 @@
     "cac": "^6.7.14",
     "chalk": "4.1.2",
     "chokidar": "^3.5.3",
-    "dayjs": "^1.11.13",
     "debug": "^4.4.0",
     "dedent": "^1.5.3",
     "find-up-simple": "^1.0.0",