@eui/tools 6.14.10 → 6.14.12

package/.version.properties

@@ -1 +1 @@
-6.14.10
+6.14.12

package/CHANGELOG.md

@@ -1,3 +1,22 @@
+## 6.14.12 (2023-12-09)
+
+##### Chores
+
+* **other:**
+  * fix hotfix flag for npm package version fetch - EUI-7121 [EUI-7121](https://webgate.ec.europa.eu/CITnet/jira/browse/EUI-7121)  ([a4b99eb0](https://webgate.ec.europa.eu/CITnet/stash/scm/csdr/eui-tools.git/commits/a4b99eb0842675d5cffd3b4d4adaccb3d92e1f54))
+  * refactor metadata of UI pkg fetch and store using npm direct call - EUI-7121 [EUI-7121](https://webgate.ec.europa.eu/CITnet/jira/browse/EUI-7121)  ([942ba35e](https://webgate.ec.europa.eu/CITnet/stash/scm/csdr/eui-tools.git/commits/942ba35e7f22e309feca6a69f9a7d6599c0c81b1))
+
+* * *
+* * *
+## 6.14.11 (2023-12-08)
+
+##### Chores
+
+* **other:**
+  * improve styles audit for non-SoC component style used - EUI-7121 [EUI-7121](https://webgate.ec.europa.eu/CITnet/jira/browse/EUI-7121)  ([41cee1b9](https://webgate.ec.europa.eu/CITnet/stash/scm/csdr/eui-tools.git/commits/41cee1b96c507872f08ebca4f002d646869566c0))
+
+* * *
+* * *
 ## 6.14.10 (2023-12-06)
 
 ##### Chores

package/package.json

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

package/sandbox.js

@@ -1366,18 +1366,78 @@ const publishUtils = require('./scripts/utils/publish/publish-utils');
 //     console.log(compositeDeps);
 //   })
 
-const prj = configUtils.projects.getCsdrProject('eui-showcase-ux-components');
+// const prj = configUtils.projects.getCsdrProject('eui-showcase-ux-components');
 
-Promise.resolve()
-  .then(() => {
-    return utils.buildApp.generateProjectDistributionList(prj, true);
-  })
+// Promise.resolve()
+//   .then(() => {
+//     return utils.buildApp.generateProjectDistributionList(prj, true);
+//   })
+
+//   .then((output) => {
+//     console.log(output);
+
+//     const { baseHrefIn } = tools.getArgs();
+//     const baseHref = configUtils.projects.getBaseHref(prj, '17.0.2-snapshot-1701859601406', baseHrefIn);
+
+//     console.log(baseHref);
+//   })
+
+
+// Promise.resolve()
+//   .then(() => {
+//     const pkgsIn = configUtils.packages.getCsdrPackages();
+//     let pkgs = Object.keys(pkgsIn).map(p => {
+//       return {
+//         name: p,
+//         npmPkg: pkgsIn[p].npmPkg,
+//         remote: pkgsIn[p].remote
+//       }
+//     });
+//     pkgs = pkgs.filter(p => p.npmPkg !== undefined && !p.remote && p.name.indexOf('backend') === -1);
+//     pkgs = tools.sortArray(pkgs, 'name');
+
+//     pkgs.forEach(p => {
+//       const pkg = configUtils.packages.getPackage(p.name, true);
+
+//       const lastMetadataLatest = metadataUtils.package.getPackageVersionsLastLatest(pkg);
+//       const lastMetadataSnapshot = metadataUtils.package.getPackageVersionsLastSnapshot(pkg);
+//       const lastMetadataRc = metadataUtils.package.getPackageVersionsLastRc(pkg);
+
+//       console.log(`Checking ${pkg.name}...`);
+
+//       // TODO check multi-version of LATEST f.e. : csdr-integration-ui 2.x 3.x 4.x
+
+//       try {
+//         const output = execa.sync('npm', ['view', '--latest', pkg.npmPkg, '--json']).stdout;
+//         const json = JSON.parse(output);
+//         const npmSnapshot = json['dist-tags'].snapshot;
+//         const npmLatest = json['dist-tags'].latest;
+//         const npmNext = json['dist-tags'].next;
+
+//         if (
+//           lastMetadataSnapshot !== npmSnapshot ||
+//           lastMetadataLatest !== npmLatest
+//         ) {
+//           console.log(pkg.name);
+//           console.log(lastMetadataSnapshot, lastMetadataLatest, lastMetadataRc);
+//           console.log(npmSnapshot, npmLatest, npmNext);
+//           console.log ('');
+//         }
+//       } catch(e) {
+//         console.log('---Error getting npm info for pkg');
+//       }
 
-  .then((output) => {
-    console.log(output);
+//     });
+//   })
 
-    const { baseHrefIn } = tools.getArgs();
-    const baseHref = configUtils.projects.getBaseHref(prj, '17.0.2-snapshot-1701859601406', baseHrefIn);
 
-    console.log(baseHref);
+Promise.resolve()
+  .then(() => {
+    const pkg = configUtils.packages.getPackage('cc-decidepoc-ui', true);
+    console.log(pkg);
+    const versions = metadataUtils.package.getPackageVersions(pkg);
+    console.log(JSON.stringify(versions, null, 2));
+  })
+  .catch((e) => {
+    console.log(e);
   })

package/scripts/csdr/audit/styles.js

@@ -73,10 +73,10 @@ const runStylesAudit = (module.exports.runStylesAudit = (pkg, customPath) => {
     srcPath = customPath;
     tools.logTitle(`Auditing : ${customPath}`);
   } else {
-    if (pkg.build && pkg.build.srcRootDefault === false) {
-      srcPath = pkg.paths.root;
-    } else {
+    if (pkg.srcRootDefault) {
       srcPath = pkg.paths.src;
+    } else {
+      srcPath = pkg.paths.root;
     }
     tools.logTitle(`Auditing : ${pkg.name}`);
   }
@@ -98,6 +98,12 @@ const runStylesAudit = (module.exports.runStylesAudit = (pkg, customPath) => {
       count: 0,
       files: [],
     },
+    tsNotSoC: {
+      count: 0,
+      files: [],
+      templateCount: 0,
+      styleCount: 0,
+    },
     thirdPartyDependencies: {
       count: 0,
       dependencies: [],
@@ -152,11 +158,11 @@ const runStylesAudit = (module.exports.runStylesAudit = (pkg, customPath) => {
     },
     uxCmp: {
       count: 0,
-      indices: []
+      indices: [],
     },
     mywpSharedAll: {
       count: 0,
-      indices: []
+      indices: [],
     },
     finalReport: {},
   };
@@ -167,13 +173,113 @@ const runStylesAudit = (module.exports.runStylesAudit = (pkg, customPath) => {
     report.package = pkg.name;
   }
 
+
   let files;
+
+  // CHECKING TS FILES CONTENT
+  // -------------------------
+
+  files = glob.sync('**/*.ts', { cwd: srcPath, nodir: true, follow: true, dot: true });
+
+  files.forEach((file) => {
+    let result, regex;
+
+    const filePath = path.join(srcPath, file);
+    const fileContent = tools.getFileContent(filePath);
+    const linesCount = fileContent.split('\n').length;
+
+    if (fileContent.indexOf('styles-audit-disabled') !== -1) {
+      report.stylesAuditDisabledCount++;
+      return;
+    }
+
+    if (linesCount > 500) {
+      report.tsOver500.count++;
+      report.tsOver500.files.push(file);
+    }
+
+    let tsNotSoCTemplateIndices = [];
+    regex = /template:/gi;
+    while ((result = regex.exec(fileContent))) {
+      tsNotSoCTemplateIndices.push(result.index);
+    }
+    report.tsNotSoC.count += tsNotSoCTemplateIndices.length;
+    report.tsNotSoC.templateCount += tsNotSoCTemplateIndices.length;
+    if (tsNotSoCTemplateIndices.length > 0) {
+      report.tsNotSoC.files.push(file);
+    }
+
+    let tsNotSoCStyleIndices = [];
+    regex = /styles:/gi;
+    while ((result = regex.exec(fileContent))) {
+      tsNotSoCStyleIndices.push(result.index);
+    }
+    report.tsNotSoC.count += tsNotSoCStyleIndices.length;
+    report.tsNotSoC.styleCount += tsNotSoCStyleIndices.length;
+    if (tsNotSoCStyleIndices.length > 0) {
+      report.tsNotSoC.files.push(file);
+    }
+
+    report.tsNotSoC.files = tools.removeArrayDuplicates(report.tsNotSoC.files);
+
+
+    let primengIndices = [];
+    regex = /primeng/gi;
+    while ((result = regex.exec(fileContent))) {
+      primengIndices.push(result.index);
+    }
+    report.primeng.count += primengIndices.length;
+    report.primeng.indices = [...report.primeng.indices, ...generateIndicesContent(primengIndices, file, fileContent)];
+
+    let materialIndices = [];
+    regex = /@angular\/material/gi;
+    while ((result = regex.exec(fileContent))) {
+      materialIndices.push(result.index);
+    }
+    const indicesContent = generateIndicesContent(materialIndices, file, fileContent, [
+      '@angular/material/core',
+      '@angular/material-moment-adapter',
+    ]);
+
+    report.material.count += recalculateIndicesCount(indicesContent);
+    report.material.indices = [...report.material.indices, ...indicesContent];
+
+    let allModulesIndices = [];
+    regex = /EuiAllModule/gi;
+    while ((result = regex.exec(fileContent))) {
+      allModulesIndices.push(result.index);
+    }
+    regex = /UxAllModule/gi;
+    while ((result = regex.exec(fileContent))) {
+      allModulesIndices.push(result.index);
+    }
+    report.allModules.count += allModulesIndices.length;
+    report.allModules.indices = [...report.allModules.indices, ...generateIndicesContent(allModulesIndices, file, fileContent)];
+
+    let mywpSharedAllIndices = [];
+    regex = /\@mywp\/shared'|\@mywp\/shared"/gi;
+    while ((result = regex.exec(fileContent))) {
+      mywpSharedAllIndices.push(result.index);
+    }
+    report.mywpSharedAll.count += mywpSharedAllIndices.length;
+    report.mywpSharedAll.indices = [...report.mywpSharedAll.indices, ...generateIndicesContent(mywpSharedAllIndices, file, fileContent)];
+  });
+
+
+  // CHECKING STYLES FILE CONTENT
+  // ----------------------------
+
   const scssFiles = glob.sync('**/*.scss', { cwd: srcPath, nodir: true, follow: true, dot: true });
   const cssFiles = glob.sync('**/*.css', { cwd: srcPath, nodir: true, follow: true, dot: true });
 
-  files = [...scssFiles, ...cssFiles];
+  let tsFiles = [];
+  if (report.tsNotSoC.styleCount > 0) {
+    tsFiles = glob.sync('**/*.ts', { cwd: srcPath, nodir: true, follow: true, dot: true });
+  }
+
+  files = [...scssFiles, ...cssFiles, ...tsFiles];
 
-  report.scssFilesCount += files.length;
+  report.scssFilesCount += [...scssFiles, ...cssFiles].length;
 
   files.forEach((file) => {
     const filePath = path.join(srcPath, file);
@@ -188,16 +294,21 @@ const runStylesAudit = (module.exports.runStylesAudit = (pkg, customPath) => {
     if (fileContent === '') {
       report.scssEmptyFiles++;
     }
-    report.scssLinescount += linesCount;
+    if (file.indexOf('.scss') > -1 || file.indexOf('.css') > -1) {
+      report.scssLinescount += linesCount;
+    }
 
-    let result,
-      euiIndices = [];
-    let regex = /\.eui|\.ux/gi;
-    while ((result = regex.exec(fileContent))) {
-      euiIndices.push(result.index);
+    let result, regex;
+
+    if (file.indexOf('.scss') > -1 || file.indexOf('.css') > -1) {
+      let euiIndices = [];
+      regex = /\.eui|\.ux/gi;
+      while ((result = regex.exec(fileContent))) {
+        euiIndices.push(result.index);
+      }
+      report.euiOverrides.count += euiIndices.length;
+      report.euiOverrides.indices = [...report.euiOverrides.indices, ...generateIndicesContent(euiIndices, file, fileContent)];
     }
-    report.euiOverrides.count += euiIndices.length;
-    report.euiOverrides.indices = [...report.euiOverrides.indices, ...generateIndicesContent(euiIndices, file, fileContent)];
 
     let sizesIndices = [];
     regex = /px/gi;
@@ -256,9 +367,20 @@ const runStylesAudit = (module.exports.runStylesAudit = (pkg, customPath) => {
     report.zIndex.indices = [...report.zIndex.indices, ...generateIndicesContent(zIndexIndices, file, fileContent)];
   });
 
-  files = glob.sync('**/*.html', { cwd: srcPath, nodir: true, follow: true, dot: true });
 
-  report.htmlFilesCount += files.length;
+  // CHECKING HTML FILES CONTENT
+  // ---------------------------
+
+  const htmlFiles = glob.sync('**/*.html', { cwd: srcPath, nodir: true, follow: true, dot: true });
+
+  tsFiles = [];
+  if (report.tsNotSoC.templateCount.length > 0) {
+    tsFiles = glob.sync('**/*.ts', { cwd: srcPath, nodir: true, follow: true, dot: true });
+  }
+
+  files = [...htmlFiles, ...tsFiles];
+
+  report.htmlFilesCount += htmlFiles.length;
 
   files.forEach((file) => {
     const filePath = path.join(srcPath, file);
@@ -270,11 +392,13 @@ const runStylesAudit = (module.exports.runStylesAudit = (pkg, customPath) => {
       return;
     }
 
-    report.htmlLinesCount += linesCount;
+    if (file.indexOf('.html') > -1) {
+      report.htmlLinesCount += linesCount;
+    }
 
     let result,
       inlineStylesIndices = [];
-    let regex = /style=/gi;
+    let regex = /style=|style =/gi;
     while ((result = regex.exec(fileContent))) {
       inlineStylesIndices.push(result.index);
     }
@@ -282,77 +406,17 @@ const runStylesAudit = (module.exports.runStylesAudit = (pkg, customPath) => {
     report.inlineStyles.indices = [...report.inlineStyles.indices, ...generateIndicesContent(inlineStylesIndices, file, fileContent)];
 
     let uxCmpIndices = [];
-    regex = /ux-/gi;
+    regex = /<ux-/gi;
     while ((result = regex.exec(fileContent))) {
       uxCmpIndices.push(result.index);
     }
-    const indicesContent = generateIndicesContent(uxCmpIndices, file, fileContent, [
-      'ux-dyn-forms',
-    ]);
+    const indicesContent = generateIndicesContent(uxCmpIndices, file, fileContent);
 
     report.uxCmp.count += recalculateIndicesCount(indicesContent);
     report.uxCmp.indices = [...report.uxCmp.indices, ...indicesContent];
   });
 
-  files = glob.sync('**/*.ts', { cwd: srcPath, nodir: true, follow: true, dot: true });
-
-  files.forEach((file) => {
-    const filePath = path.join(srcPath, file);
-    const fileContent = tools.getFileContent(filePath);
-    const linesCount = fileContent.split('\n').length;
-
-    if (fileContent.indexOf('styles-audit-disabled') !== -1) {
-      report.stylesAuditDisabledCount++;
-      return;
-    }
-
-    if (linesCount > 500) {
-      report.tsOver500.count++;
-      report.tsOver500.files.push(file);
-    }
-
-    let result,
-      primengIndices = [];
-    let regex = /primeng/gi;
-    while ((result = regex.exec(fileContent))) {
-      primengIndices.push(result.index);
-    }
-    report.primeng.count += primengIndices.length;
-    report.primeng.indices = [...report.primeng.indices, ...generateIndicesContent(primengIndices, file, fileContent)];
-
-    let materialIndices = [];
-    regex = /@angular\/material/gi;
-    while ((result = regex.exec(fileContent))) {
-      materialIndices.push(result.index);
-    }
-    const indicesContent = generateIndicesContent(materialIndices, file, fileContent, [
-      '@angular/material/core',
-      '@angular/material-moment-adapter',
-    ]);
-
-    report.material.count += recalculateIndicesCount(indicesContent);
-    report.material.indices = [...report.material.indices, ...indicesContent];
-
-    let allModulesIndices = [];
-    regex = /EuiAllModule/gi;
-    while ((result = regex.exec(fileContent))) {
-      allModulesIndices.push(result.index);
-    }
-    regex = /UxAllModule/gi;
-    while ((result = regex.exec(fileContent))) {
-      allModulesIndices.push(result.index);
-    }
-    report.allModules.count += allModulesIndices.length;
-    report.allModules.indices = [...report.allModules.indices, ...generateIndicesContent(allModulesIndices, file, fileContent)];
 
-    let mywpSharedAllIndices = [];
-    regex = /\@mywp\/shared'|\@mywp\/shared"/gi;
-    while ((result = regex.exec(fileContent))) {
-      mywpSharedAllIndices.push(result.index);
-    }
-    report.mywpSharedAll.count += mywpSharedAllIndices.length;
-    report.mywpSharedAll.indices = [...report.mywpSharedAll.indices, ...generateIndicesContent(mywpSharedAllIndices, file, fileContent)];
-  });
 
   // Analyzing 3rd party dependencies usage
 
@@ -371,14 +435,13 @@ const runStylesAudit = (module.exports.runStylesAudit = (pkg, customPath) => {
 
     // checking against allowed CSDR known package scopes
     if (!allowedScopes.includes(scope)) {
-
       // exclusions known
       let exclusionFound = false;
       exclusions.forEach((exc) => {
         if (scope.indexOf(exc) > -1) {
           exclusionFound = true;
         }
-      })
+      });
 
       if (!exclusionFound) {
         thirdPartyDeps.push(d);
@@ -431,18 +494,18 @@ const runStylesAudit = (module.exports.runStylesAudit = (pkg, customPath) => {
     };
   }
 
-  if (report.stylesAuditDisabledCount !==0) {
+  if (report.stylesAuditDisabledCount !== 0) {
     report.finalReport['stylesAuditDisabledCount'] = {
       description: 'audit disabled count',
       value: report.stylesAuditDisabledCount,
-      status: report.stylesAuditDisabledCount !== 0 ? 'IMPROVE': 'OK',
-      comment : report.stylesAuditDisabledCount !==0 ? 'If not done yet, files to be checked by eUI team': null,
-    }
+      status: report.stylesAuditDisabledCount !== 0 ? 'IMPROVE' : 'OK',
+      comment: report.stylesAuditDisabledCount !== 0 ? 'If not done yet, files to be checked by eUI team' : null,
+    };
   }
 
   // BALANCED - styles content
 
-  if (report.scssFilesCount !== 0) {
+  if (report.scssFilesCount !== 0 || report.tsNotSoC.styleCount !== 0) {
     report.finalReport['euiOverrides'] = {
       description: 'eUI overrides found',
       value: report.euiOverrides.count,
@@ -501,7 +564,7 @@ const runStylesAudit = (module.exports.runStylesAudit = (pkg, customPath) => {
 
   // CRITICAL ONLY
 
-  if (report.htmlLinesCount !== 0) {
+  if (report.htmlLinesCount !== 0 || report.tsNotSoC.templateCount !== 0) {
     report.finalReport['inlineStyles'] = {
       description: 'inline styles found in HTML',
       value: report.inlineStyles.count,
@@ -551,16 +614,25 @@ const runStylesAudit = (module.exports.runStylesAudit = (pkg, customPath) => {
       status: report.tsOver500.count !== 0 ? 'IMPROVE' : 'OK',
       comment: report.tsOver500.count !== 0 ? 'Split TS files into multiple ones for readability' : null,
     };
+
+    report.finalReport['tsNotSoC'] = {
+      description: 'TS file not respecting SoC template OR scss split content',
+      value: report.tsNotSoC.count,
+      status: report.tsNotSoC.count !== 0 ? 'IMPROVE' : 'OK',
+      comment: report.tsNotSoC.count !== 0 ? 'Split TS file into types of concerns' : null,
+    };
   }
 
   report.finalReport['thirdPartyDependencies'] = {
     description: 'Third party dependencies usage',
     value: report.thirdPartyDependencies.count,
     status: report.thirdPartyDependencies.count !== 0 ? 'IMPROVE' : 'OK',
-    comment: report.thirdPartyDependencies.count !== 0 ? 'Use 3rd party dependencies only if really necessary (bundle size increase) - contact eUI team for more info' : null,
+    comment:
+      report.thirdPartyDependencies.count !== 0
+        ? 'Use 3rd party dependencies only if really necessary (bundle size increase) - contact eUI team for more info'
+        : null,
   };
 
-
   if (Object.keys(report.finalReport).length === 0) {
     tools.logInfo('No sources to audit...skipping');
     return null;