@madgex/fert 4.2.0 → 4.2.1

package/README.md

@@ -190,6 +190,91 @@ Index all the files and their paths in the `dist` directory, and using a recursi
 
 The Asset Store API uses a multi-part form upload to PUT files in the client directory. Upload paths are respected, directories are created on the fly.
 
+## Configs
+
+`fert configs`
+
+A set of commands to help with publishing, downloading & referencing project configs.
+
+**Usage**
+
+`fert configs [root] --[query|download|publish] [env]`
+
+| Option               | Description                                                                             |
+| -------------------- | --------------------------------------------------------------------------------------- |
+| --query [configName] | Describe known keys for a config, omit to list all known configs                        |
+| --download <env>     | Download known configs from the Configuration API for environment "dev" or "production" |
+| --publish            | Publish configs to Configuration API environment "dev" or "production"                  |
+
+### Example usage
+
+Its assumed you're running from a branding repo in all examples
+
+#### Review all known configs
+
+```bash
+# fert configs --query
+
+Fert v0.0.0-development
+
+Available config schemas...
+ * JobSeekerDesignConfig
+ * JobSeekerSiteConfig
+ * jsfe-config
+ * webconfig
+ ...
+```
+
+#### Review validation schema & default values for a config
+
+```bash
+# fert configs --query JobBoardConfig.filesizeDefinitions
+
+Fert v0.0.0-development
+
+Getting schema description for config: JobBoardConfig.filesizeDefinitions...
+{
+  "documents": {
+    "type": "number",
+    "flags": {
+      "description": "The definition in MBs of how large documents can be",
+      "default": 1
+    }
+  }
+}
+
+Configs default values:
+{
+  "documents": 1
+}
+```
+
+#### Download known configs for the current client (specified in `fert.config.js`) from the Configuration API. This is intended as a one-time command to get the current config values in the repo
+
+```bash
+# fert configs --download production
+
+Fert v0.0.0-development
+✔ Downloading v6 configs...
+Saving files...
+ - JobBoardConfig.applicationForm.json
+ - JobBoardConfig.articlesFilterByDate.json
+ - JobBoardConfig.careerpathCountryIso.json
+ - JobBoardConfig.careerpathGlobalRoleSettings.json
+ ...
+```
+
+#### Publish all known, valid configs found in branding repos `./config/*` for the current client. In this scenario, there is only `./config/jsfe-config.json`
+
+```bash
+# fert configs --publish production
+
+Fert v0.0.0-development
+✔ Config validated: jsfe-config
+✔ Project configs applied to configuration-api.job.madgexhosting.net
+upload
+```
+
 # Global options
 
 These options are available no matter the command used.
@@ -216,5 +301,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/utils/configs.js

@@ -77,25 +77,27 @@ const loadLocalConfigs = (fertConfig) => {
   const configs = {};
   const files = fs.readdirSync(dir);
 
-  files.forEach((file) => {
-    const filePath = path.join(dir, file);
-
-    if (fs.statSync(filePath).isFile()) {
-      const fileName = path.basename(file, path.extname(file));
-
-      // Purge any existing cache of the file
-      delete require.cache[filePath];
-
-      try {
-        configs[fileName] = {
-          path: filePath,
-          data: require(filePath),
-        };
-      } catch (err) {
-        log.error(`Error loading config: ${err.message}`);
+  files
+    .filter((file) => file.endsWith('.json'))
+    .forEach((file) => {
+      const filePath = path.join(dir, file);
+
+      if (fs.statSync(filePath).isFile()) {
+        const fileName = path.basename(file, path.extname(file));
+
+        // Purge any existing cache of the file
+        delete require.cache[filePath];
+
+        try {
+          configs[fileName] = {
+            path: filePath,
+            data: require(filePath),
+          };
+        } catch (err) {
+          log.error(`Error loading config (${filePath}): ${err.message}`);
+        }
       }
-    }
-  });
+    });
 
   return configs;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@madgex/fert",
-  "version": "4.2.0",
+  "version": "4.2.1",
   "description": "Tool to help build the V6 branding",
   "bin": {
     "fert": "./bin/cli.js"
@@ -31,8 +31,8 @@
     "@hapi/inert": "^7.1.0",
     "@hapi/vision": "^7.0.3",
     "@hapipal/toys": "^4.0.0",
-    "@madgex/config-api-sdk": "^1.0.12",
-    "@madgex/design-system": "^9.1.8",
+    "@madgex/config-api-sdk": "^1.0.13",
+    "@madgex/design-system": "^9.1.9",
     "@private/header-footer-podlet-server": "github:wiley/madgex-header-footer-podlet",
     "axios": "^1.7.9",
     "cac": "^6.7.14",

package/server/templates/page1.njk

@@ -30,7 +30,7 @@
         <div class="mds-branded-container mds-branded-container--1 mds-padding-b4 mds-padding-bottom-b5 mds-margin-bottom-b5">
             <h2 class="mds-font-s2">Branded Container</h2>
             <p class="mds-margin-bottom-b4">Lorem ipsum dolor sit amet, consectetur adipiscing elit.</p>
-            <a href="#" draggable="false" class="mds-button mds-button--neutral mds-button--small">Lorem ipsum</a>
+            <a href="#" draggable="false" class="mds-button mds-button--small">Lorem ipsum</a>
         </div>
         </div>
     </div>