@eui/tools 6.11.21 → 6.11.23

package/.version.properties

@@ -1 +1 @@
-6.11.21
+6.11.23

package/CHANGELOG.md

@@ -1,3 +1,25 @@
+## 6.11.23 (2023-05-31)
+
+##### Chores
+
+* **other:**
+  * adapted pre-build translations compilation tool for handling additional folders through config - EUI-7121 [EUI-7121](https://webgate.ec.europa.eu/CITnet/jira/browse/EUI-7121)  ([183da80a](https://webgate.ec.europa.eu/CITnet/stash/scm/csdr/eui-tools.git/commits/183da80a893ec264306290f754aa65c2945e9fd8))
+
+* * *
+* * *
+## 6.11.22 (2023-05-15)
+
+##### Chores
+
+* **other:**
+  * prevent hotfix for dev/tst releases of remotes - added gates for styles audit (v16+) - EUI-7121 [EUI-7121](https://webgate.ec.europa.eu/CITnet/jira/browse/EUI-7121)  ([4e85e2a5](https://webgate.ec.europa.eu/CITnet/stash/scm/csdr/eui-tools.git/commits/4e85e2a50b88ff889e15eedcb22276a7ef7c6a5e))
+##### Bug Fixes
+
+* **other:**
+  * styles gates values comparison - EUI-7121 [EUI-7121](https://webgate.ec.europa.eu/CITnet/jira/browse/EUI-7121)  ([3fb7a751](https://webgate.ec.europa.eu/CITnet/stash/scm/csdr/eui-tools.git/commits/3fb7a751ab2f15b395de30f9a24102902f1b9cb2))
+
+* * *
+* * *
 ## 6.11.21 (2023-05-11)
 
 ##### Chores

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@eui/tools",
-    "version": "6.11.21",
+    "version": "6.11.23",
     "tag": "latest",
     "license": "EUPL-1.1",
     "description": "eUI common tools and scripts",

package/scripts/csdr/audit/styles.js

@@ -7,6 +7,7 @@ const glob = require('glob');
 // LOCAL
 const tools = require('../../utils/tools');
 const notificationUtils = require('../../utils/notification/notification-utils');
+const configUtils = require('../config/config-utils');
 
 
 const runStylesAudit = module.exports.runStylesAudit = (pkg, customPath) => {
@@ -371,13 +372,13 @@ const runStylesAudit = module.exports.runStylesAudit = (pkg, customPath) => {
      description: 'material component usage found in HTML',
      value: report.material.count,
      status: (report.material.count !== 0) ? 'CRITICAL' : 'OK',
-     comment: (report.material.count !== 0) ? 'Usage of material should be avoided' : null
+     comment: (report.material.count !== 0) ? 'Usage of material should be avoided - this will be blocking as of eUI 16' : null
    }
    report.finalReport['primeng'] = {
      description: 'PrimeNG components usage found in HTML',
      value: report.primeng.count,
      status: (report.primeng.count !== 0) ? 'CRITICAL' : 'OK',
-     comment: (report.primeng.count !== 0) ? 'Remove any PrimeNG usage, deprecated in eUI' : null
+     comment: (report.primeng.count !== 0) ? 'Remove any PrimeNG usage, deprecated in eUI - this will be blocking as of eUI 16' : null
    }
 
   // IMPROVE ONLY
@@ -445,16 +446,14 @@ module.exports.audit = (pkg) => {
 
   tools.logTitle('Audit package styles');
 
-  return Promise.resolve()
-   .then(() => {
-
-    const report = runStylesAudit(pkg);
-
-    if (!report) {
-      return;
-    }
+  const report = runStylesAudit(pkg);
 
+  if (!report) {
+    return;
+  }
 
+  return Promise.resolve()
+   .then(() => {
     // FINAL REPORT
 
     let finalReportMessage = `*STYLES AUDIT REPORT for ${pkg.name}:*\n\n`;
@@ -482,10 +481,60 @@ module.exports.audit = (pkg) => {
       package: pkg,
       text: finalReportMessage
     });
+  })
 
-   })
-   .catch((e) => {
-     console.log(e);
+  .then(() => {
+      // getting config options for gates defined
+      const configOptions = configUtils.global.getConfigOptions();
+
+      // getting local csdr euiVersion
+      const euiVersion = configUtils.global.getLocalEuiVersion();
+
+      // if eUI version not found, no action
+      if (!euiVersion) {
+        return;
+      }
+
+      // getting gates for euiVersion found
+      const gates = configOptions.AUDIT_STYLES_GATES[euiVersion];
+
+      tools.logTitle(`Checking audit styles gates for local euiVersion : ${euiVersion}`);
+
+      // if no gates found for corresponding version, no action
+      if (!gates) {
+        tools.logInfo('No gates found for local eUI version...skipping');
+        return;
+      }
+
+      tools.logInfo(`Gates found : ${JSON.stringify(gates)}`);
+
+      // checking gates level if any
+      let gatesPassed = true;
+
+      Object.keys(report.finalReport).forEach((styleCategory) => {
+        tools.logInfo(`Checking audit styles category : ${styleCategory} - item found ${report.finalReport[styleCategory].value}`);
+
+        if (gates[styleCategory] === undefined) {
+          tools.logInfo(`No gates found for category`);
+          tools.logInfo(`===> PASSED`);
+        } else {
+          tools.logInfo(`Gates found for category maxium allowed : ${gates[styleCategory]}`);
+          if (report.finalReport[styleCategory].value > gates[styleCategory]) {
+            tools.logError(`===> FAILED`);
+            gatesPassed = false;
+          } else {
+            tools.logInfo(`===> PASSED`);
+          }
+        }
+      })
+
+      if (!gatesPassed) {
+        throw new Error('AUDIT_STYLES_GATES_FAILED');
+      }
+  })
+
+  .catch((e) => {
+     throw e;
    })
 
  }

package/scripts/csdr/config/global.js

@@ -236,6 +236,7 @@ module.exports.getConfigOptions = () => {
     MSTEAMS_CHANNELS_EMAILS: null,
     API_HOST: null,
     AUDIT_DEPENDENCIES_GATES: null,
+    AUDIT_STYLES_GATES: null
   }
 
   // getting devops metadata options
@@ -374,6 +375,19 @@ module.exports.getConfigOptions = () => {
         })
       }
     }
+
+    if (audit.styles) {
+      if (audit.styles.gates) {
+        configOptions.AUDIT_STYLES_GATES = [];
+        Object.keys(audit.styles.gates).forEach((v) => {
+          const gatesForVersion = audit.styles.gates[v];
+          configOptions.AUDIT_STYLES_GATES[v] = {
+            "material": gatesForVersion.material,
+            "primeng": gatesForVersion.primeng
+          };
+        })
+      }
+    }
   }
 
 

package/scripts/csdr/metadata/package.js

@@ -262,6 +262,10 @@ module.exports.getPackageVersionsByMajor = (pkg, major, isMaster) => {
       tools.logInfo(`----> ${versions.length} metadata versions non-master release for major`);
     }
 
+    tools.logInfo('----> exluding hotfix package versions type');
+    versions = versions.filter(v => !v.hotfix);
+    tools.logInfo(`----> ${versions.length} metadata versions excluding hotfix version type`);
+
     return versions;
   }
 }

package/scripts/csdr/release/package/release-ui.js

@@ -103,12 +103,6 @@ module.exports.run = () => {
             .then(() => {
               return innerUi.install(pkg, branches.isMaster);
             })
-            // CHECK STYLES USAGE
-            .then(() => {
-              if (!pkg.build || (pkg.build && !pkg.build.skipAudit)) {
-                return auditUtils.styles.audit(pkg);
-              }
-            })
 
             // AUDIT DEPENDENCIES
             .then(() => {

package/scripts/utils/build/package/angular.js

@@ -8,6 +8,7 @@ const execa = require('execa');
 const tools = require('../../tools');
 const notificationUtils = require('../../notification/notification-utils');
 const cleanUtils = require('../../clean/clean-utils');
+const auditUtils = require('../../../csdr/audit/audit-utils');
 
 module.exports.build = (pkg, isMaster) => {
 
@@ -16,7 +17,7 @@ module.exports.build = (pkg, isMaster) => {
   const ng = path.resolve(process.cwd(), 'node_modules', '@angular', 'cli', 'bin', 'ng');
 
   // FETCH ARGS
-  let { deps, skipClean, skipLint, skipTest, skipCompile, skipDoc, build } = pkg.build? {...pkg.build, ...tools.getArgs()} : tools.getArgs();
+  let { deps, skipClean, skipLint, skipTest, skipCompile, skipDoc, build, skipAudit } = pkg.build? {...pkg.build, ...tools.getArgs()} : tools.getArgs();
 
   return Promise.resolve()
     .then(() => {
@@ -86,6 +87,12 @@ module.exports.build = (pkg, isMaster) => {
       if (!skipTest) {
         tools.logSuccess();
       }
+
+      if (!skipAudit) {
+        return auditUtils.styles.audit(pkg);
+      }
+    })
+    .then(() => {
       if (!skipCompile) {
         tools.logInfo('Bundling package...');
         let args = ['--max_old_space_size=8096', ng, 'build', pkg.name];

package/scripts/utils/pre-build/translations/elements.js

@@ -72,7 +72,7 @@ module.exports.generate = (inputScopes = '', inputPkg) => {
       tools.logInfo(`langs: ${langs}`);
       tools.logInfo(`dest folder: ${destFolder}`);
       tools.logInfo(`total packages: ${packages.length}`);
-      tools.logInfo(packages);
+      tools.logInfo(JSON.stringify(packages, null, 1));
     })
 
     .then(() => {
@@ -88,25 +88,16 @@ module.exports.generate = (inputScopes = '', inputPkg) => {
             addTranslation(file, lang);
 
             // Add module translations
-            packages.forEach((pkg) => {
+            packages.forEach((pkgDeps) => {
                 let baseI18nPath = 'i18n';
                 if (pkg.scope === '@eui') {
                   baseI18nPath = 'i18n-eui';
                 }
-                file = path.join(pkg.folder, `assets/${baseI18nPath}/${lang}.json`);
-
-                tools.logInfo(`Adding translations from ${pkg.folder}`);
-                if (tools.isFileExists(file)) {
-                  tools.logInfo(`${file} found...adding`);
-                  addTranslation(file, lang)
-                } else {
-                  file = path.join(pkg.folder, `assets/i18n/${lang}.json`);
-                  if (tools.isFileExists(file)) {
-                    tools.logInfo(`${file} found...adding`);
-                    addTranslation(file, lang)
-                  } else {
-                    tools.logInfo(`${file} not found...skipping`);
-                  }
+                processTranslationsFolder(pkgDeps, baseI18nPath, lang);
+
+                // process additional translation folders if set as option in config
+                if (pkg.build && pkg.build.translationAdditionalFolders) {
+                  processTranslationsFolder(pkgDeps, pkg.build.translationAdditionalFolders, lang);
                 }
             });
 
@@ -138,6 +129,26 @@ module.exports.generate = (inputScopes = '', inputPkg) => {
                 }
             }
         }
+
+        function processTranslationsFolder(pkg, folder, lang) {
+          tools.logInfo(`------>Scanning ${folder}`);
+
+          let file = path.join(pkg.folder, `assets/${folder}/${lang}.json`);
+
+          tools.logInfo(`Adding translations from ${pkg.folder}`);
+          if (tools.isFileExists(file)) {
+            tools.logInfo(`${file} found...adding`);
+            addTranslation(file, lang)
+          } else {
+            file = path.join(pkg.folder, `assets/i18n/${lang}.json`);
+            if (tools.isFileExists(file)) {
+              tools.logInfo(`${file} found...adding`);
+              addTranslation(file, lang)
+            } else {
+              tools.logInfo(`${file} not found...skipping`);
+            }
+          }
+        }
     })
     .catch((e) => {
       throw e;