@tangelo/tangelo-configuration-toolkit 1.14.3 → 1.15.1

package/src/modules/build/oxygen.js

@@ -1,175 +1,178 @@
-const fs      = require('fs-extra');
-const globby  = require('globby');
-const path    = require('path');
-const SaxonJS = require('saxon-js');
-
-const spConfigPath  = path.join(_paths.repo, _paths.tdi, 'tct/build/oxygen/stylesheetPaths.json');
-const sefFilePath   = path.join(_paths.repo, _paths.tdi, 'tct/build/oxygen/createProjectFile.sef.json');
-const cmscustomPath = 'config/cmscustom/';
-const siteStylesheetsPath = 'config/txp/site-stylesheets/';
-
-const masterFiles = new Set;
-const transformationScenarios = [];
-
-const convertToValidFilename = (string) => string.replace(/[/|\\:*?"<>]/g, ' ');
-
-const createProjectFile = (config, filename) => {
-  _info('Initializing xpr file(s):');
-  const xprFiles = [...globby.sync(`*.xpr`)];
-  const newXprFile = (typeof filename === 'string') ? convertToValidFilename(filename) + '.xpr' : null;
-  // Add newXprFile at the start of xprFiles if it does not already exists:
-  if (newXprFile && xprFiles.indexOf(newXprFile)===-1) xprFiles.unshift(newXprFile);
-
-  // Copy xpr file from TDI if it does not exists yet;
-  if (xprFiles[0] && !newXprFile) _write(`Found: ${xprFiles.join(', ')}`);
-  else {
-    if (!newXprFile) {
-      // Set xpr filename to customer name (assumes correct upsert scripts structure)
-      const customers = new Set;
-      _repoconfig.forEach(p => customers.add(p.customer_name));
-      xprFiles.push(convertToValidFilename([...customers].join(' - ')) + '.xpr');
-    }
-    // Copy new xpr file
-    fs.copySync(path.join(_paths.repo, 'tangelo-default-implementation/src/[customer].xpr'), path.join(_paths.repo, xprFiles[0]));
-    _write(`Created: '${xprFiles[0]}'`);
-  }
-
-  // Search for transformationScenarios/masterfiles based on TDI submodule oxygenProjectFile config
-  _info('\nSearching for transformationScenarios/masterfiles');
-  config.oxygenProjectFile.forEach(
-    pf => {
-      // Collect transformation scenarios and add them to the transformationScenarios array; add individual stylesheets to the masterFiles set.
-      if      (pf.transformation) getTransformations(pf.transformation);
-      // Add files to the masterfiles set.
-      else if (pf.masterfile)     getMasterfiles(pf.masterfile);
-    }
-  );
-
-  // update all .xpr files with collected transformation scenarios and masterfiles.
-  transformXprFile(xprFiles);
-};
-
-const getTransformations = (config) => {
-  _repoconfig.forEach(rc => {
-    // get pathname of customer/project
-    const [customerPath, projectPath] = config.location == 'database' ? rc.path_dbconfig : rc.path_cmscustom;
-
-    // set pathname of customer/project in location glob-expression
-    const location = path.join(
-      _paths.repo,
-      config.files.replace(/\[customer\]/, customerPath).replace(/\[project\]/, projectPath)
-    );
-
-    globby
-      .sync(`${location}`)
-      .forEach(f => {
-      // extract baseStrings from file
-        const fileString = fs.readFileSync(f).toString();
-        const baseStrings = fileString.match(RegExp(config.extracts.base, 'gm'));
-
-        if (fileString.replace(/\s|^prompt\s.*$/gm, '')!=='') {
-          if (baseStrings) {
-            baseStrings.forEach(s => {
-            // extract type, name, files info from baseString
-              const type = config.extracts.type ? s.match(RegExp(config.extracts.type))[1] : config.values.type;
-              const name = config.extracts.name ? s.match(RegExp(config.extracts.name))[1] : config.values.name;
-              const files = s.match(RegExp(config.extracts.files))[1];
-
-              // Add transformation scenario to the transformationScenario array
-              transformationScenarios.push({
-                name: `${type}: ${name} (${rc.customer_name}, ${rc.project_name})`, // note that in createProjectFile.xsl a regex is added that matches scenarios based on this name. This to preserve manually added scenarios.
-                transformationScenario: files,
-                location: config.location == 'txp' ? siteStylesheetsPath : cmscustomPath
-              });
-
-              // Add each non-tdi stylesheet in transformation scenario to the masterFiles set
-              files.split(',').forEach(f => {
-                const filePath = `${config.location == 'txp' ? siteStylesheetsPath : cmscustomPath}${f}`;
-                if (!f.startsWith('tdi')) masterFiles.add(filePath);
-              });
-            });
-          } else {
-            _write(`No transformation scenarios found in ${f} for '${config.extracts.base}'`);
-          }
-        }
-      });
-  });
-
-};
-
-
-const getMasterfiles = (config) => {
-  globby
-    .sync(`${path.join(_paths.repo, config.files)}`)
-    .forEach(cf => {
-    // Check if masterfile should be extracted from file
-      const fileString = fs.readFileSync(cf).toString();
-      if (fileString.replace(/\s|^prompt\s.*$/gm, '')!=='') {
-        if (config.extracts) {
-        // extract baseStrings from file
-          const baseStrings = fileString.match(RegExp(config.extracts.base, 'gm'));
-
-          if (baseStrings) {
-            baseStrings.forEach(s => {
-            // extract (comma-separated) list of masterfiles
-              const filesString = s.match(RegExp(config.extracts.files))[1];
-              if (!filesString) _error(`No masterfiles found in '${s}' for '${config.extracts.files}'`);
-
-              // Add each non-tdi masterfile to the masterFiles set
-              filesString.split(',').forEach(f => {
-                if (!f.startsWith('tdi')){
-                  const filePath = `${config.location == 'txp' ? siteStylesheetsPath : cmscustomPath}${f}`;
-                  masterFiles.add(filePath);
-                }
-              });
-            });
-          } else {
-            _write(`No masterfiles found in ${cf} for '${config.extracts.base}'`);
-          }
-        } else { // Add synced file to masterfiles; strip path from c:/... hence it starts with config/cmscustom or config/txp/site-stylesheets
-          const filePath = config.location == 'txp' ? `${siteStylesheetsPath}${cf.split(siteStylesheetsPath)[1]}` : `${cmscustomPath}${cf.split(cmscustomPath)[1]}`;
-          masterFiles.add(filePath);
-        }
-      }
-    });
-
-};
-
-const transformXprFile = (xprFiles) => {
-  _info('\nUpdating xpr file(s):');
-  // create with: xslt3 -t -xsl:createProjectFile.xsl -export:createProjectFile.sef.json v -nogo'
-
-  xprFiles
-    .forEach(xprFile => {
-    // Transform xpr; add masterfiles and transformationScenarios as parameters of the stylesheet
-      _write(`${xprFile}\n`);
-      SaxonJS.transform({
-        stylesheetText: fs.readFileSync(sefFilePath),
-        stylesheetBaseURI: 'createProjectFile.sef.json',
-        sourceFileName: path.join(_paths.repo, xprFile),
-        destination: 'serialized',
-        stylesheetParams: {
-          'masterfiles': [...masterFiles],
-          'Q{}transformationScenarios': transformationScenarios
-        }
-      }, 'async')
-        .then(output => {
-          // Write result of transformation to xpr file
-          fs.writeFileSync(path.join(_paths.repo, xprFile), output.principalResult);
-        })
-        .catch(e => _warn(`Failed to update: ${xprFile}\n ${e}`));
-    });
-};
-
-
-module.exports = function oxygen (filename) {
-  // Set projects transformation scenarios and masterfiles in oXygen project file
-  // - Will try to preserve manually added entries in the transformation scenarios and masterfiles
-  // - Will remove non existing masterfiles or masterfiles that start with a '_'
-
-  if (!fs.existsSync(spConfigPath) || !fs.existsSync(sefFilePath)) {
-    _error(`Cannot find required files in TDI submodule. Try updating TDI submodule.`);
-  }
-
-  createProjectFile(require(spConfigPath), filename);
+const fs      = require('fs-extra');
+const globby  = require('globby');
+const path    = require('path');
+const SaxonJS = require('saxon-js');
+
+const spConfigPath  = 'build/oxygen/stylesheetPaths.json';
+const sefFilePath   = 'build/oxygen/createProjectFile.sef.json';
+const cmscustomPath = 'config/cmscustom/';
+const siteStylesheetsPath = 'config/txp/site-stylesheets/';
+
+const masterFiles = new Set;
+const transformationScenarios = [];
+
+let spConfig, sefFile;
+
+const convertToValidFilename = string => string.replace(/[/|\\:*?"<>]/g, ' ');
+
+const createProjectFile = (config, newXprFile) => {
+  _info('Initializing xpr file(s):');
+  const xprFiles = [...globby.sync(`*.xpr`)];
+  // Add newXprFile at the start of xprFiles if it does not already exists:
+  if (newXprFile && xprFiles.indexOf(newXprFile)===-1) xprFiles.unshift(newXprFile);
+
+  // Copy xpr file from TDI if it does not exists yet;
+  if (xprFiles[0] && !newXprFile) _write(`Found: ${xprFiles.join(', ')}`);
+  else {
+    if (!newXprFile) {
+      // Set xpr filename to customer name (assumes correct upsert scripts structure)
+      const customers = new Set;
+      _repoconfig.forEach(p => customers.add(p.customer_name));
+      xprFiles.push(convertToValidFilename([...customers].join(' - ')) + '.xpr');
+    }
+    // Copy new xpr file
+    fs.copySync(path.join(_paths.repo, 'tangelo-default-implementation/src/[customer].xpr'), path.join(_paths.repo, xprFiles[0]));
+    _write(`Created: '${xprFiles[0]}'`);
+  }
+
+  // Search for transformationScenarios/masterfiles based on TDI submodule oxygenProjectFile config
+  _info('\nSearching for transformationScenarios/masterfiles');
+  config.oxygenProjectFile.forEach(
+    pf => {
+      // Collect transformation scenarios and add them to the transformationScenarios array; add individual stylesheets to the masterFiles set.
+      if      (pf.transformation) getTransformations(pf.transformation);
+      // Add files to the masterfiles set.
+      else if (pf.masterfile)     getMasterfiles(pf.masterfile);
+    }
+  );
+
+  // update all .xpr files with collected transformation scenarios and masterfiles.
+  transformXprFile(xprFiles);
+};
+
+const getTransformations = config => {
+  _repoconfig.forEach(rc => {
+    // get pathname of customer/project
+    const [customerPath, projectPath] = config.location === 'database' ? rc.path_dbconfig : rc.path_cmscustom;
+
+    // set pathname of customer/project in location glob-expression
+    const location = path.join(
+      _paths.repo,
+      config.files.replace(/\[customer\]/, customerPath).replace(/\[project\]/, projectPath)
+    );
+
+    globby
+      .sync(`${location}`)
+      .forEach(f => {
+      // extract baseStrings from file
+        const fileString = fs.readFileSync(f).toString();
+        const baseStrings = fileString.match(RegExp(config.extracts.base, 'gm'));
+
+        if (fileString.replace(/\s|^prompt\s.*$/gm, '') !== '') {
+          if (baseStrings) {
+            baseStrings.forEach(s => {
+            // extract type, name, files info from baseString
+              const type = config.extracts.type ? s.match(RegExp(config.extracts.type))[1] : config.values.type;
+              const name = config.extracts.name ? s.match(RegExp(config.extracts.name))[1] : config.values.name;
+              const files = s.match(RegExp(config.extracts.files))[1];
+
+              // Add transformation scenario to the transformationScenario array
+              transformationScenarios.push({
+                name: `${type}: ${name} (${rc.customer_name}, ${rc.project_name})`, // note that in createProjectFile.xsl a regex is added that matches scenarios based on this name. This to preserve manually added scenarios.
+                transformationScenario: files,
+                location: config.location === 'txp' ? siteStylesheetsPath : cmscustomPath
+              });
+
+              // Add each non-tdi stylesheet in transformation scenario to the masterFiles set
+              files.split(',').forEach(f => {
+                const filePath = `${config.location === 'txp' ? siteStylesheetsPath : cmscustomPath}${f}`;
+                if (!f.startsWith('tdi')) masterFiles.add(filePath);
+              });
+            });
+          } else {
+            _write(`No transformation scenarios found in ${f} for '${config.extracts.base}'`);
+          }
+        }
+      });
+  });
+
+};
+
+
+const getMasterfiles = config => {
+  globby
+    .sync(`${path.join(_paths.repo, config.files)}`)
+    .forEach(cf => {
+    // Check if masterfile should be extracted from file
+      const fileString = fs.readFileSync(cf).toString();
+      if (fileString.replace(/\s|^prompt\s.*$/gm, '')!=='') {
+        if (config.extracts) {
+        // extract baseStrings from file
+          const baseStrings = fileString.match(RegExp(config.extracts.base, 'gm'));
+
+          if (baseStrings) {
+            baseStrings.forEach(s => {
+            // extract (comma-separated) list of masterfiles
+              const filesString = s.match(RegExp(config.extracts.files))[1];
+              if (!filesString) _error(`No masterfiles found in '${s}' for '${config.extracts.files}'`);
+
+              // Add each non-tdi masterfile to the masterFiles set
+              filesString.split(',').forEach(f => {
+                if (!f.startsWith('tdi')){
+                  const filePath = `${config.location === 'txp' ? siteStylesheetsPath : cmscustomPath}${f}`;
+                  masterFiles.add(filePath);
+                }
+              });
+            });
+          } else {
+            _write(`No masterfiles found in ${cf} for '${config.extracts.base}'`);
+          }
+        } else { // Add synced file to masterfiles; strip path from c:/... hence it starts with config/cmscustom or config/txp/site-stylesheets
+          const filePath = config.location === 'txp' ? `${siteStylesheetsPath}${cf.split(siteStylesheetsPath)[1]}` : `${cmscustomPath}${cf.split(cmscustomPath)[1]}`;
+          masterFiles.add(filePath);
+        }
+      }
+    });
+
+};
+
+const transformXprFile = xprFiles => {
+  _info('\nUpdating xpr file(s):');
+  // create with: xslt3 -t -xsl:createProjectFile.xsl -export:createProjectFile.sef.json v -nogo'
+
+  xprFiles
+    .forEach(xprFile => {
+    // Transform xpr; add masterfiles and transformationScenarios as parameters of the stylesheet
+      _write(`${xprFile}\n`);
+      SaxonJS.transform({
+        stylesheetText: JSON.stringify(sefFile),
+        stylesheetBaseURI: 'createProjectFile.sef.json',
+        sourceFileName: path.join(_paths.repo, xprFile),
+        destination: 'serialized',
+        stylesheetParams: {
+          'masterfiles': [...masterFiles],
+          'Q{}transformationScenarios': transformationScenarios
+        }
+      }, 'async')
+        .then(output => {
+          // Write result of transformation to xpr file
+          fs.writeFileSync(path.join(_paths.repo, xprFile), output.principalResult);
+        })
+        .catch(e => _warn(`Failed to update: ${xprFile}\n ${e}`));
+    });
+};
+
+
+module.exports = function oxygen (arg) {
+  // Set projects transformation scenarios and masterfiles in oXygen project file
+  // - Will try to preserve manually added entries in the transformation scenarios and masterfiles
+  // - Will remove non existing masterfiles or masterfiles that start with a '_'
+
+  spConfig = _modulesTdi.require(spConfigPath);
+  sefFile = _modulesTdi.require(sefFilePath);
+
+  if (!spConfig || !sefFile) _error(`Cannot find required files in TDI submodule. Try updating TDI submodule.`);
+
+  const newXprFile = (typeof arg === 'string') ? convertToValidFilename(arg) + '.xpr' : null;
+  createProjectFile(spConfig, newXprFile);
 };

package/src/modules/fonto/commands.js

@@ -56,8 +56,8 @@ module.exports = {
         resolve();
       });
     })
-    .then(() => cmdExec(`${fdt} editor upgrade --version ${fontoVersion} --non-interactive`))
-    .then(() => [fdt])
+      .then(() => cmdExec(`${fdt} editor upgrade --version ${fontoVersion} --non-interactive`))
+      .then(() => [fdt])
     ;
   },
 
@@ -154,7 +154,7 @@ module.exports = {
         else _write(result, '\n');
       }
     )
-    .then(() => [fdt])
+      .then(() => [fdt])
     ;
   },
 
@@ -205,7 +205,7 @@ module.exports = {
         else _write(result, '\n');
       }
     )
-    .then(() => [fdt])
+      .then(() => [fdt])
     ;
   },
 

package/src/modules/fonto/index.js

@@ -5,13 +5,13 @@ const globby      = require('globby');
 const path        = require('path');
 
 
-const fdtCommand = (fv) => `npx -y ${_packages.FDT.name}@${fv.replace(/^(7\.|8\.[012]\.).*/, '3.12.0')}`;
+const fdtCommand = fv => `npx -y ${_packages.FDT.name}@${fv.replace(/^(7\.|8\.[012]\.).*/, '3.12.0')}`;
 
 module.exports = function fonto (argv) {
 
   const allowedFontoVersionRegex = (() => {
-    const cfvPath = path.join(_paths.repo, _paths.tdi, 'tct/fonto/compatibleVersions.json');
-    if (fs.pathExistsSync(cfvPath)) return RegExp(fs.readJsonSync(cfvPath).regex);
+    const cvRegex = _modulesTdi.require('fonto/compatibleVersions.json')?.regex;
+    if (cvRegex) return RegExp(cvRegex);
 
     // old way: a regex for each basecommit is stored in global._git.commitTdi
     for (const fv of _git.commitTdi.fontoVersions) {
@@ -19,7 +19,7 @@ module.exports = function fonto (argv) {
     }
   })();
 
-  if (!_tdiSubmoduleExists) _error('TDI submodule folder is missing.');
+  if (!_tdiSubmoduleExists()) _error('TDI submodule folder is missing.');
 
   // check if FDT is not installed globally, because then it won't be possible to use specific versions with npx
   if (fs.pathExistsSync(path.join(_appdata.npmPath, 'node_modules', _packages.FDT.name))) {
@@ -30,8 +30,8 @@ module.exports = function fonto (argv) {
 
   // find fonto instances by searching for fonto/manifest.json files
   const fontoPaths = globby.sync(['**/fonto/manifest.json', 'manifest.json', `!${_paths.tdi}/**`])
-    .map(p => ([p.replace('manifest.json', ''), fs.readJsonSync(p).sdkVersion.replace(/Nightlies.*/, 'nightly')])
-  );
+    .map(p => ([p.replace('manifest.json', ''), fs.readJsonSync(p).sdkVersion.replace(/Nightlies.*/, 'nightly')]))
+  ;
 
   if (fontoPaths.length===0) _error('No Fonto instance found.');
 
@@ -43,14 +43,14 @@ module.exports = function fonto (argv) {
       .then(() => {
         process.chdir(path.join(_paths.repo, _paths.apply, fontoPath));
 
-        if (fontoPath!='.') _info(`${i>0 ? '\n' : ''}Fonto instance #${i+1}: ${path.join(_paths.apply, fontoPath)}\n`);
+        if (fontoPath !== '.') _info(`${i>0 ? '\n' : ''}Fonto instance #${i+1}: ${path.join(_paths.apply, fontoPath)}\n`);
 
         // execute commands sequentially and in correct order
-        return new Promise((resolve) => {
+        return new Promise(resolve => {
           _info('Determining Fonto version:');
           let fontoVersionNew = typeof argv.init == 'string' ? argv.init : fontoVersionCurrent;
 
-          if (fontoVersionNew == 'latest') {
+          if (fontoVersionNew === 'latest') {
             const data = execSync(`${fdtCommand(fontoVersionCurrent)} editor versions`, {encoding: 'UTF-8'});
             fontoVersionNew = data.match(/\d+\.\d+\.\d+/g).filter(v => allowedFontoVersionRegex.test(v))[0];
           }
@@ -61,13 +61,13 @@ module.exports = function fonto (argv) {
           _write(fontoVersionNew+'\n');
           return resolve([fdtCommand(fontoVersionNew), fontoVersionNew]);
         })
-        .then(argv.init && commands.init)
-        .then(argv.schema && commands.schema)
-        .then(argv.elements && commands.elements)
-        .then(argv.attributes && commands.attributes)
-        .then(argv.localize && commands.localize)
-        .then(argv.build && commands.build)
-        .then(argv.run && commands.run)
+          .then(argv.init && commands.init)
+          .then(argv.schema && commands.schema)
+          .then(argv.elements && commands.elements)
+          .then(argv.attributes && commands.attributes)
+          .then(argv.localize && commands.localize)
+          .then(argv.build && commands.build)
+          .then(argv.run && commands.run)
         ;
       });
   });

package/src/modules/git/index.js

@@ -36,7 +36,6 @@ const cmdExec = commands => new Promise(resolve => {
   });
 });
 
-const tdiMigrationFilePath  = path.join(_paths.repo, _paths.tdi, 'tct/git/tdiCommitsRequiringMigration.js');
 
 module.exports = function git (argv) {
 
@@ -143,10 +142,10 @@ module.exports = function git (argv) {
         if (!tdiFromDateCustom) _info(`TDI submodule updated:\n${updateSubmoduleMsg}`);
 
         // tdiMigrationFilePath should exist in latest commits of releases 5.3+; As we updated to the latest version this should work
-        if (fs.existsSync(tdiMigrationFilePath)) {
-          const migrations = require(tdiMigrationFilePath);
+        const migrations = _modulesTdi.require('git/tdiCommitsRequiringMigration.js');
+        if (migrations) {
           const fromTdiDate = tdiFromDateCustom ? new Date(tdiFromDateCustom) : (tdiBranch.commonAncestor) ? tdiBranch.commonAncestor.date: _git.commitTdi.local().date;
-          const toTdiDate = tdiToDateCustom ? new Date(tdiToDateCustom) : new Date(execGitCommand(`log -1 --format=%cd --date=iso-strict`, path.join(_paths.repo, _paths.tdi), ['date']).date);
+          const toTdiDate = tdiToDateCustom ? new Date(tdiToDateCustom) : new Date();
 
           _info(`TDI commits requiring migration between ${_formatDate(fromTdiDate)} and ${_formatDate(toTdiDate)}`);
           // Filter the migrations that should be applied/considered; Also display older releases migrations