@simple-reporting/base 0.1.111 → 0.1.112

package/scripts/migrate-livingdocs-build/dev/logger.js

@@ -1,16 +1,16 @@
-import winston from 'winston';
-
-const logger = winston.createLogger({
-  level: 'debug',
-  format: winston.format.json(),
-  transports: [
-    new winston.transports.Console({
-      format: winston.format.combine(
-        winston.format.colorize(),
-        winston.format.simple(),
-      ),
-    }),
-  ],
-});
-
-export default logger;
+import winston from 'winston';
+
+const logger = winston.createLogger({
+  level: 'debug',
+  format: winston.format.json(),
+  transports: [
+    new winston.transports.Console({
+      format: winston.format.combine(
+        winston.format.colorize(),
+        winston.format.simple(),
+      ),
+    }),
+  ],
+});
+
+export default logger;

package/scripts/migrate-livingdocs-build/dev/migrate.js

@@ -1,241 +1,241 @@
-import configuration from './configuration.js';
-import lib from './lib.js';
-import logger from './logger.js';
-import fs from 'fs';
-
-const migrationManualReviews = [];
-
-class Migrate {
-  static migrateDesign(oldDesignData) {
-    let newDesignData = {
-      v: 2,
-      name: '',
-      version: '',
-      designSettings: {
-        componentProperties: [],
-        defaultComponents: {},
-        prefilledComponents: {},
-        componentGroups: [],
-        fieldExtractor: {},
-      },
-    };
-
-    // mapping
-    newDesignData.name = oldDesignData.name;
-    newDesignData.version = oldDesignData.version;
-
-    newDesignData.designSettings.assets = oldDesignData.assets;
-    newDesignData.designSettings.componentProperties =
-      this.migrateComponentProperties(oldDesignData.componentProperties);
-    newDesignData.designSettings.defaultComponents =
-      oldDesignData.defaultComponents;
-    newDesignData.designSettings.prefilledComponents =
-      oldDesignData.prefilledComponents;
-    newDesignData.designSettings.componentGroups = oldDesignData.groups;
-    newDesignData.designSettings.fieldExtractor = oldDesignData.metadata;
-    newDesignData.designSettings.defaultComponents =
-      oldDesignData.defaultComponents;
-
-    // delete removed properties
-    delete oldDesignData.label;
-    delete oldDesignData.license;
-    delete oldDesignData.description;
-    delete oldDesignData.author;
-    delete oldDesignData.imageRatios;
-    delete oldDesignData.defaultLayout;
-
-    // delete already moved properties
-    delete oldDesignData.name;
-    delete oldDesignData.version;
-    delete oldDesignData.assets;
-    delete oldDesignData.componentProperties;
-    delete oldDesignData.defaultComponents;
-    delete oldDesignData.prefilledComponents;
-    delete oldDesignData.groups;
-    delete oldDesignData.metadata;
-    delete oldDesignData.defaultComponents;
-    delete oldDesignData.defaultContent;
-
-    return newDesignData;
-  }
-
-  static migrateComponentProperties(oldProperties) {
-    const newProperties = [];
-
-    Object.keys(oldProperties).forEach((key) => {
-      newProperties.push({
-        name: key,
-        ...oldProperties[key],
-      });
-    });
-
-    return newProperties;
-  }
-
-  static migrateComponents(components) {
-    components.map((component) => {
-      const oldData = component.configurationData;
-      // clean copy the old Data
-      const newData = JSON.parse(JSON.stringify(oldData));
-
-      if (!!newData.directives) {
-        const directiveKeys = Object.keys(newData.directives);
-
-        let newDirectives = [];
-        if (directiveKeys) {
-          // remap directive object
-          directiveKeys.forEach((directiveKey) => {
-            const oldDirective = oldData.directives[directiveKey];
-
-            let newDirective = {
-              name: directiveKey,
-              ...oldDirective,
-            };
-
-            if (!newDirective.type) {
-              newDirective.type = this.getDirectiveType(
-                oldDirective,
-                component.path,
-                directiveKey,
-              );
-            }
-
-            if (newDirective.imageRatios) {
-              newDirective.imageRatios.forEach((imageRatio) => {
-                const regex = new RegExp(/[\d]{1,}\:[\d]{1,}/gm);
-                const regexResult = regex.test(imageRatio.trim());
-                if (!regexResult) {
-                  migrationManualReviews.push({
-                    path: component.path,
-                    directive: 'imageRatio:  ' + imageRatio + '  ',
-                  });
-                }
-              });
-
-              if (newDirective.allowOriginalRatio) {
-                newDirective.recommendedRatios = newDirective.imageRatios;
-                delete newDirective.imageRatios;
-              }
-
-              delete newDirective.allowOriginalRatio;
-            }
-
-            newDirectives.push(newDirective);
-          });
-        }
-
-        newData.directives = newDirectives;
-      }
-
-      component.configurationData = newData;
-
-      return component;
-    });
-
-    return components;
-  }
-
-  static getDirectiveType(directive, componentPath, directiveKey) {
-    if (
-      directive.allowedChildren ||
-      directive.defaultComponents ||
-      directive.defaultContent
-    ) {
-      return 'container';
-    } else if (
-      directive.plainText ||
-      directive.excludeFromTextCount ||
-      directive.maxLength ||
-      directive.recommendedMaxLength
-    ) {
-      return 'editable';
-    } else if (directive.imageRatios || directive.allowOriginalRatio) {
-      return 'image';
-    } else if (directive.service || directive.services) {
-      return 'include';
-    }
-
-    migrationManualReviews.push({
-      path: componentPath,
-      directive: directiveKey,
-    });
-
-    return '';
-  }
-
-  static writeDesign(newDesign) {
-    if (lib.bFileExists(configuration.migration.dest + '/config.json')) {
-      fs.rmSync(configuration.migration.dest + '/config.json');
-    }
-
-    fs.mkdirSync(configuration.migration.dest, { recursive: true });
-
-    fs.writeFileSync(
-      configuration.migration.dest + '/config.json',
-      JSON.stringify(newDesign, null, '\t'),
-      {
-        encoding: 'utf8',
-        flag: 'a+',
-        mode: 0o666,
-      },
-    );
-  }
-
-  static writeComponents(newComponents) {
-    newComponents.forEach((component) => {
-      const pathEndIndex = configuration.migration.components.indexOf('*');
-      const toReplace = configuration.migration.components.substring(
-        0,
-        pathEndIndex,
-      );
-      const newFullPath = component.path.replace(
-        toReplace,
-        configuration.migration.dest + '/components/',
-      );
-      const newPath = newFullPath.split('/');
-
-      newPath.splice(-1);
-
-      fs.mkdirSync(newPath.join('/'), { recursive: true });
-
-      fs.writeFileSync(newFullPath, this.makeComponentFileString(component));
-    });
-  }
-
-  static makeComponentFileString(component) {
-    let data = `<script type="ld-conf">\n${JSON.stringify(component.configurationData, null, '\t')}\n</script>\n`;
-    data += component.html;
-
-    return data;
-  }
-
-  static writeManualReviews() {
-    if (migrationManualReviews.length == 0) {
-      console.info('probably no manual reviews required');
-      return;
-    }
-
-    migrationManualReviews.forEach((review) => {
-      logger.warn(
-        `component ${review.path} directive ${review.directive} requires manual review`,
-      );
-    });
-
-    const textOutput = migrationManualReviews
-      .map(
-        (review) =>
-          `component ${review.path} directive ${review.directive} requires manual review`,
-      )
-      .join('\n');
-    fs.writeFileSync('./manual-review.txt', textOutput, {
-      encoding: 'utf8',
-      flag: 'a+',
-      mode: 0o666,
-    });
-    logger.warn(
-      `found [${migrationManualReviews.length}] issues, building a design without manual review will fail. ./manual-review.txt`,
-    );
-  }
-}
-
-export default Migrate;
+import configuration from './configuration.js';
+import lib from './lib.js';
+import logger from './logger.js';
+import fs from 'fs';
+
+const migrationManualReviews = [];
+
+class Migrate {
+  static migrateDesign(oldDesignData) {
+    let newDesignData = {
+      v: 2,
+      name: '',
+      version: '',
+      designSettings: {
+        componentProperties: [],
+        defaultComponents: {},
+        prefilledComponents: {},
+        componentGroups: [],
+        fieldExtractor: {},
+      },
+    };
+
+    // mapping
+    newDesignData.name = oldDesignData.name;
+    newDesignData.version = oldDesignData.version;
+
+    newDesignData.designSettings.assets = oldDesignData.assets;
+    newDesignData.designSettings.componentProperties =
+      this.migrateComponentProperties(oldDesignData.componentProperties);
+    newDesignData.designSettings.defaultComponents =
+      oldDesignData.defaultComponents;
+    newDesignData.designSettings.prefilledComponents =
+      oldDesignData.prefilledComponents;
+    newDesignData.designSettings.componentGroups = oldDesignData.groups;
+    newDesignData.designSettings.fieldExtractor = oldDesignData.metadata;
+    newDesignData.designSettings.defaultComponents =
+      oldDesignData.defaultComponents;
+
+    // delete removed properties
+    delete oldDesignData.label;
+    delete oldDesignData.license;
+    delete oldDesignData.description;
+    delete oldDesignData.author;
+    delete oldDesignData.imageRatios;
+    delete oldDesignData.defaultLayout;
+
+    // delete already moved properties
+    delete oldDesignData.name;
+    delete oldDesignData.version;
+    delete oldDesignData.assets;
+    delete oldDesignData.componentProperties;
+    delete oldDesignData.defaultComponents;
+    delete oldDesignData.prefilledComponents;
+    delete oldDesignData.groups;
+    delete oldDesignData.metadata;
+    delete oldDesignData.defaultComponents;
+    delete oldDesignData.defaultContent;
+
+    return newDesignData;
+  }
+
+  static migrateComponentProperties(oldProperties) {
+    const newProperties = [];
+
+    Object.keys(oldProperties).forEach((key) => {
+      newProperties.push({
+        name: key,
+        ...oldProperties[key],
+      });
+    });
+
+    return newProperties;
+  }
+
+  static migrateComponents(components) {
+    components.map((component) => {
+      const oldData = component.configurationData;
+      // clean copy the old Data
+      const newData = JSON.parse(JSON.stringify(oldData));
+
+      if (!!newData.directives) {
+        const directiveKeys = Object.keys(newData.directives);
+
+        let newDirectives = [];
+        if (directiveKeys) {
+          // remap directive object
+          directiveKeys.forEach((directiveKey) => {
+            const oldDirective = oldData.directives[directiveKey];
+
+            let newDirective = {
+              name: directiveKey,
+              ...oldDirective,
+            };
+
+            if (!newDirective.type) {
+              newDirective.type = this.getDirectiveType(
+                oldDirective,
+                component.path,
+                directiveKey,
+              );
+            }
+
+            if (newDirective.imageRatios) {
+              newDirective.imageRatios.forEach((imageRatio) => {
+                const regex = new RegExp(/[\d]{1,}\:[\d]{1,}/gm);
+                const regexResult = regex.test(imageRatio.trim());
+                if (!regexResult) {
+                  migrationManualReviews.push({
+                    path: component.path,
+                    directive: 'imageRatio:  ' + imageRatio + '  ',
+                  });
+                }
+              });
+
+              if (newDirective.allowOriginalRatio) {
+                newDirective.recommendedRatios = newDirective.imageRatios;
+                delete newDirective.imageRatios;
+              }
+
+              delete newDirective.allowOriginalRatio;
+            }
+
+            newDirectives.push(newDirective);
+          });
+        }
+
+        newData.directives = newDirectives;
+      }
+
+      component.configurationData = newData;
+
+      return component;
+    });
+
+    return components;
+  }
+
+  static getDirectiveType(directive, componentPath, directiveKey) {
+    if (
+      directive.allowedChildren ||
+      directive.defaultComponents ||
+      directive.defaultContent
+    ) {
+      return 'container';
+    } else if (
+      directive.plainText ||
+      directive.excludeFromTextCount ||
+      directive.maxLength ||
+      directive.recommendedMaxLength
+    ) {
+      return 'editable';
+    } else if (directive.imageRatios || directive.allowOriginalRatio) {
+      return 'image';
+    } else if (directive.service || directive.services) {
+      return 'include';
+    }
+
+    migrationManualReviews.push({
+      path: componentPath,
+      directive: directiveKey,
+    });
+
+    return '';
+  }
+
+  static writeDesign(newDesign) {
+    if (lib.bFileExists(configuration.migration.dest + '/config.json')) {
+      fs.rmSync(configuration.migration.dest + '/config.json');
+    }
+
+    fs.mkdirSync(configuration.migration.dest, { recursive: true });
+
+    fs.writeFileSync(
+      configuration.migration.dest + '/config.json',
+      JSON.stringify(newDesign, null, '\t'),
+      {
+        encoding: 'utf8',
+        flag: 'a+',
+        mode: 0o666,
+      },
+    );
+  }
+
+  static writeComponents(newComponents) {
+    newComponents.forEach((component) => {
+      const pathEndIndex = configuration.migration.components.indexOf('*');
+      const toReplace = configuration.migration.components.substring(
+        0,
+        pathEndIndex,
+      );
+      const newFullPath = component.path.replace(
+        toReplace,
+        configuration.migration.dest + '/components/',
+      );
+      const newPath = newFullPath.split('/');
+
+      newPath.splice(-1);
+
+      fs.mkdirSync(newPath.join('/'), { recursive: true });
+
+      fs.writeFileSync(newFullPath, this.makeComponentFileString(component));
+    });
+  }
+
+  static makeComponentFileString(component) {
+    let data = `<script type="ld-conf">\n${JSON.stringify(component.configurationData, null, '\t')}\n</script>\n`;
+    data += component.html;
+
+    return data;
+  }
+
+  static writeManualReviews() {
+    if (migrationManualReviews.length == 0) {
+      console.info('probably no manual reviews required');
+      return;
+    }
+
+    migrationManualReviews.forEach((review) => {
+      logger.warn(
+        `component ${review.path} directive ${review.directive} requires manual review`,
+      );
+    });
+
+    const textOutput = migrationManualReviews
+      .map(
+        (review) =>
+          `component ${review.path} directive ${review.directive} requires manual review`,
+      )
+      .join('\n');
+    fs.writeFileSync('./manual-review.txt', textOutput, {
+      encoding: 'utf8',
+      flag: 'a+',
+      mode: 0o666,
+    });
+    logger.warn(
+      `found [${migrationManualReviews.length}] issues, building a design without manual review will fail. ./manual-review.txt`,
+    );
+  }
+}
+
+export default Migrate;

package/scripts/migrate-livingdocs-build/readme.md

@@ -1,62 +1,62 @@
-# Installation
-
-    sudo npm i --location=global git@github.com:mmssolutionsio/migrate-livingdocs-build.git
-
-## Update
-
-    sudo npm update migrate-livingdocs-build --location=global
-
-# Usage
-
-## Node Version
-
-    at least "16.15.1"
-
-## Custom configuration
-
-default values which can be overwritten in package.json of the current ld project
-
-      {
-      "nhs-design-builder": {
-        "configurationSelector": "[type=\"ld-conf\"]",
-        "build": {
-          "design": "./src/config.json",
-          "components": "./src/components/**/*.html",
-          "requiredFolders": [
-            "./src/css",
-            "./src/fonts",
-            "./src/svg",
-            "./src/images"
-          ],
-          "dist": "./dist",
-          "dest": "./",
-          "archiveName": "design.zip"
-        },
-        "migration": {
-          "design": "./src/config.json",
-          "components": "./src/components/**/*.html",
-          "dest": "./design-v2",
-        }
-      }
-    }
-
-| prop                  | desc                                                  |
-| --------------------- | ----------------------------------------------------- |
-| configurationSelector | querySelector string for script tag in html component |
-| build.design          | location of base ld-design.json file                  |
-| build.components      | location of html templates                            |
-| build.requiredFolders | array of folders which are copied into the dist       |
-| build.dist            | dist folder, will be created and deleted              |
-| build.dest            | destination for the archive                           |
-| build.archiveName     | zipped design file name                               |
-| migration.design      | location of base ld-design.json file                  |
-| migration.components  | location of html templates                            |
-| dest                  | folder in which all migrated files will be written    |
-
-## Build
-
-cli command `nhs-ld-build` in ld project folder to make dist, build design and zip dist.
-
-## Migrate
-
-cli command `nhs-ld-migrate` in ld project folder to migrate html components and config.json, and write into a new location.
+# Installation
+
+    sudo npm i --location=global git@github.com:mmssolutionsio/migrate-livingdocs-build.git
+
+## Update
+
+    sudo npm update migrate-livingdocs-build --location=global
+
+# Usage
+
+## Node Version
+
+    at least "16.15.1"
+
+## Custom configuration
+
+default values which can be overwritten in package.json of the current ld project
+
+      {
+      "nhs-design-builder": {
+        "configurationSelector": "[type=\"ld-conf\"]",
+        "build": {
+          "design": "./src/config.json",
+          "components": "./src/components/**/*.html",
+          "requiredFolders": [
+            "./src/css",
+            "./src/fonts",
+            "./src/svg",
+            "./src/images"
+          ],
+          "dist": "./dist",
+          "dest": "./",
+          "archiveName": "design.zip"
+        },
+        "migration": {
+          "design": "./src/config.json",
+          "components": "./src/components/**/*.html",
+          "dest": "./design-v2",
+        }
+      }
+    }
+
+| prop                  | desc                                                  |
+| --------------------- | ----------------------------------------------------- |
+| configurationSelector | querySelector string for script tag in html component |
+| build.design          | location of base ld-design.json file                  |
+| build.components      | location of html templates                            |
+| build.requiredFolders | array of folders which are copied into the dist       |
+| build.dist            | dist folder, will be created and deleted              |
+| build.dest            | destination for the archive                           |
+| build.archiveName     | zipped design file name                               |
+| migration.design      | location of base ld-design.json file                  |
+| migration.components  | location of html templates                            |
+| dest                  | folder in which all migrated files will be written    |
+
+## Build
+
+cli command `nhs-ld-build` in ld project folder to make dist, build design and zip dist.
+
+## Migrate
+
+cli command `nhs-ld-migrate` in ld project folder to migrate html components and config.json, and write into a new location.