@tangelo/tangelo-configuration-toolkit 1.24.2 → 1.24.3

package/README.md

@@ -1,94 +1,94 @@
-# tangelo-configuration-toolkit
-
-Tangelo Configuration Toolkit is a command-line toolkit which offers support for developing a Tangelo configuration.
-
-## Installation
-
-The toolkit requires [NPM](https://www.npmjs.com/get-npm) on [Node.js®](https://nodejs.org/) (at least version 18.x). An active or maintenance LTS release is recommended. After installing Node.js, you can install the latest version of the Tangelo Configuration Toolkit globally on your system using the following command:
-
-    npm i -g @tangelo/tangelo-configuration-toolkit
-
-## Usage
-
-Get help for the available commands and see version:
-
-    tangelo-configuration-toolkit
-
-Get help for a specific command, detailing all its arguments:
-
-    tangelo-configuration-toolkit <command>
-
-Use the `tct` shorthand instead of `tangelo-configuration-toolkit`:
-
-    tct <command>
-
-## Config
-
-### Global
-
-TCT requires a config file to work: `${userhome}/.tct/appconfig.json`\
-Several commands, like the `deploy` command, require server connection information, which can be stored in here.
-
-The contents looks like this (all properties are optional):
-
-    {
-      "sharedConfigPath": "absolute/or/relative/path/to/folder/containing/shared/config",
-      "servers": [{
-        "config": {
-          "port": 22,
-          "parallel": 4,
-          "username": "username",
-          "remotedir": "/absolute/path/to/tangelo/config/folder/on/server"
-        },
-        "domains": ["domain.name.com"],
-        "name": "name-for-local-deploy"
-      }],
-      "serverDefaults": {
-        "config": {
-          ...
-        }
-      }
-      "defaultServer": "can be set to the name of e.g. your favorite dev server",
-      "defaultDatabase": "can be set to the tnsname of e.g. your favorite dev server"
-    }
-
-When passing a server name, `tct` will look for a full match with a name or a partial match (the start) with a domain.
-
-### oXygen
-
-The `build -x` commands set projects transformation scenarios and masterfiles in the oXygen project file with the following functionality:
-- Will try to preserve manually added entries in the transformation scenarios and masterfiles
-- Will remove non existing masterfiles or masterfiles that start with a '_'
-- No masterfiles / scenarios will be added if their path match with oXygens hidden directory patterns
-
-
-## Debug
-
-Save this in the root of your local clone as `tct-dev.cmd`:
-
-```
-@ECHO off
-SETLOCAL
-CALL :find_dp0
-
-IF EXIST "%dp0%\node.exe" (
-  SET "_prog=%dp0%\node.exe"
-) ELSE (
-  SET "_prog=node"
-  SET PATHEXT=%PATHEXT:;.JS;=;%
-)
-
-"%_prog%"  "%dp0%\index.js" %*
-ENDLOCAL
-EXIT /b %errorlevel%
-:find_dp0
-SET dp0=%~dp0
-EXIT /b
-```
-
-Then:
-
-- open a 'Javascript Debug Terminal' in VSCode
-- jump to a customer folder ( you can use `tan-cust` for this)
-- set a breakpoint
-- type (for instance): `tct-dev d -c`
+# tangelo-configuration-toolkit
+
+Tangelo Configuration Toolkit is a command-line toolkit which offers support for developing a Tangelo configuration.
+
+## Installation
+
+The toolkit requires [NPM](https://www.npmjs.com/get-npm) on [Node.js®](https://nodejs.org/) (at least version 18.x). An active or maintenance LTS release is recommended. After installing Node.js, you can install the latest version of the Tangelo Configuration Toolkit globally on your system using the following command:
+
+    npm i -g @tangelo/tangelo-configuration-toolkit
+
+## Usage
+
+Get help for the available commands and see version:
+
+    tangelo-configuration-toolkit
+
+Get help for a specific command, detailing all its arguments:
+
+    tangelo-configuration-toolkit <command>
+
+Use the `tct` shorthand instead of `tangelo-configuration-toolkit`:
+
+    tct <command>
+
+## Config
+
+### Global
+
+TCT requires a config file to work: `${userhome}/.tct/appconfig.json`\
+Several commands, like the `deploy` command, require server connection information, which can be stored in here.
+
+The contents looks like this (all properties are optional):
+
+    {
+      "sharedConfigPath": "absolute/or/relative/path/to/folder/containing/shared/config",
+      "servers": [{
+        "config": {
+          "port": 22,
+          "parallel": 4,
+          "username": "username",
+          "remotedir": "/absolute/path/to/tangelo/config/folder/on/server"
+        },
+        "domains": ["domain.name.com"],
+        "name": "name-for-local-deploy"
+      }],
+      "serverDefaults": {
+        "config": {
+          ...
+        }
+      }
+      "defaultServer": "can be set to the name of e.g. your favorite dev server",
+      "defaultDatabase": "can be set to the tnsname of e.g. your favorite dev server"
+    }
+
+When passing a server name, `tct` will look for a full match with a name or a partial match (the start) with a domain.
+
+### oXygen
+
+The `build -x` commands set projects transformation scenarios and masterfiles in the oXygen project file with the following functionality:
+- Will try to preserve manually added entries in the transformation scenarios and masterfiles
+- Will remove non existing masterfiles or masterfiles that start with a '_'
+- No masterfiles / scenarios will be added if their path match with oXygens hidden directory patterns
+
+
+## Debug
+
+Save this in the root of your local clone as `tct-dev.cmd`:
+
+```
+@ECHO off
+SETLOCAL
+CALL :find_dp0
+
+IF EXIST "%dp0%\node.exe" (
+  SET "_prog=%dp0%\node.exe"
+) ELSE (
+  SET "_prog=node"
+  SET PATHEXT=%PATHEXT:;.JS;=;%
+)
+
+"%_prog%"  "%dp0%\index.js" %*
+ENDLOCAL
+EXIT /b %errorlevel%
+:find_dp0
+SET dp0=%~dp0
+EXIT /b
+```
+
+Then:
+
+- open a 'Javascript Debug Terminal' in VSCode
+- jump to a customer folder ( you can use `tan-cust` for this)
+- set a breakpoint
+- type (for instance): `tct-dev d -c`

package/Tangelo-Configuration-Toolkit.code-workspace

@@ -0,0 +1,8 @@
+{
+	"folders": [
+		{
+			"path": "."
+		}
+  ],
+  "settings": {}
+}

package/bin/index.js

@@ -1,3 +1,3 @@
-#!/usr/bin/env node
-
+#!/usr/bin/env node
+
 require('..');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tangelo/tangelo-configuration-toolkit",
-  "version": "1.24.2",
+  "version": "1.24.3",
   "engines": {
     "node": ">=14.0.0"
   },

package/src/cli.js

@@ -77,7 +77,10 @@ module.exports = function cli () {
         reset: {alias: 'r', desc: 'Reset repository to last commit', conflicts: ['i', 'c', 'u']},
         clone: {alias: 'c', desc: 'Clone a client repository and do basic setup', conflicts: ['i', 'r', 'u']},
         'update-repo': {alias: 'ur', desc: 'Update repository', conflicts: ['i', 'r', 'c']},
-        'update-submodule': {alias: 'us', desc: 'Update TDI submodule, optionally pass release branch (without "release/")', conflicts: ['i', 'r', 'c']},
+        'update-submodule': {alias: 'us', desc: 'Update TDI submodule, optionally pass release branch (without "release/")', conflicts: ['i', 'r', 'c'], type:"string",
+          // Running --us with no argument should default to true - defaulting to empty string throws a yargs error
+          coerce: (v => v || true)
+        },
         dates: {alias: 'd', desc: '[hidden] Use i.c.w. update-submodule, pass 2 dates in format yyyy-mm-dd', conflicts: ['i', 'r', 'c'], implies: 'update-submodule', requiresArg: true, array: true, hidden: !_devmode}
       },
       handler: require('./modules/git')

package/src/lib/get-tdi-branch.js

@@ -1,46 +1,55 @@
-const execGitCommand = require('./exec-git-command');
-const path           = require('path');
-
-module.exports = function getTdiBranch(toBranchName) {
-  const tdiPath = path.join(_paths.repo, _paths.tdi);
-  const tdiBranch = {};
-
-  // Fetch all
-  _info(`Fetch TDI submodule`);
-  const cmdFetch = execGitCommand('fetch -pf --all', tdiPath);
-  if (cmdFetch.error) _warn(`Fetch failed\n${cmdFetch.error}`);
-
-  let toBranch;
-  if (toBranchName) {
-    // Check if specified branch exists; we will update to this branch
-    toBranch = String(toBranchName).replace(/(?:release\/)?(\d+(?:\.[\dxt]+)*)/, `release/$1`);
-    const branchExists = execGitCommand(`branch --remote`, tdiPath).match(`origin/${toBranch}`);
-    if (!branchExists) _error(`TDI branch "${toBranch}" does not exist. Note that TCT can only update to a release branch.`);
-  }
-
-  // Get remote release branches containing TDI HEAD commit
-  const releaseBranches = execGitCommand(`branch --all --contains ${_git.commitTdi.local().hash}`, tdiPath).match(/remotes\/origin\/release\/[^\s]+/gsm);
-  if (!releaseBranches || releaseBranches.error) _error(`Could not retrieve TDI release branches`);
-
-  // Get the first possible branch; prefer release/5.1 over release/5.2:
-  releaseBranches.sort((a, b) => a > b ? 1 : -1);
-
-  // Set branch name of firstBranch without 'remotes/origin/'
-  tdiBranch.name = releaseBranches[0].replace(/remotes\/origin\//g, '');
-
-  // In case of branch switch set from.name to the old branch and name to the new branch
-  if (toBranch) {
-    if (tdiBranch.name > toBranch) _error(`You cannot downgrade to a lower release branch with TCT.`);
-    tdiBranch.from = {name: tdiBranch.name};
-    tdiBranch.name = toBranch;
-
-    const branchHash = execGitCommand(`rev-parse origin/${toBranch}`, tdiPath);
-    const commonAncestorHash = execGitCommand(`merge-base ${_git.commitTdi.local().hash} ${branchHash}`, tdiPath);
-    const commonAncestorDate = execGitCommand(`show ${commonAncestorHash} --no-patch --format=%cd --date=iso-strict `, tdiPath, ['date']).date;
-    tdiBranch.commonAncestor = {date: new Date(commonAncestorDate)};
-  }
-
-  // Get number of commits behind
-  tdiBranch.commitsBehind = execGitCommand(`rev-list HEAD...origin/${tdiBranch.name} --count`, tdiPath);
-  return tdiBranch;
+const execGitCommand = require('./exec-git-command');
+const path           = require('path');
+const compareVersions = require('compare-versions');
+
+module.exports = function getTdiBranch(toBranchName) {
+  const tdiPath = path.join(_paths.repo, _paths.tdi);
+
+  // Fetch all
+  _info(`Fetch TDI submodule`);
+  const cmdFetch = execGitCommand('fetch -pf --all', tdiPath);
+  if (cmdFetch.error) _warn(`Fetch failed\n${cmdFetch.error}`);
+
+  let toBranch;
+  if (toBranchName) {
+    // Check if specified branch exists; we will update to this branch
+    toBranch = String(toBranchName).replace(/(?:release\/)?(\d+(?:\.[\dxt]+)*)/, `release/$1`);
+    const branchExists = execGitCommand(`branch --remote`, tdiPath).match(`origin/${toBranch}`);
+    if (!branchExists) _error(`TDI branch "${toBranch}" does not exist. Note that TCT can only update to a release branch.`);
+  }
+
+  // Get remote release branches containing TDI HEAD commit
+  const releaseBranches = execGitCommand(`branch --all --contains ${_git.commitTdi.local().hash}`, tdiPath).match(/remotes\/origin\/release\/[^\s]+/gsm);
+  if (!releaseBranches || releaseBranches.error) _error(`Could not retrieve TDI release branches`);
+
+  // Create a sorted list of release branches with their versions:
+  const sortedBranches = releaseBranches
+  .map(branch => {
+    return {
+      name: branch.replace('remotes/origin/', ''),
+      version: branch.replace('remotes/origin/release/', '')
+    }
+  })
+  .sort((a, b) => compareVersions(a.version, b.version));
+
+  // Choose the first possible branch; prefer release/5.1 over release/5.2:
+  const tdiBranch = sortedBranches[0];
+
+  // In case of branch switch set from.name to the old branch and name to the new branch
+  if (toBranch) {
+    const toVersion = toBranch?.replace('release/', '');
+    if (compareVersions.compare(tdiBranch.version, toVersion, '>')) _error(`You cannot downgrade to a lower release branch with TCT.`);
+    tdiBranch.from = {name: tdiBranch.name, version: tdiBranch.version};
+    tdiBranch.name = toBranch;
+    tdiBranch.version = toVersion;
+
+    const branchHash = execGitCommand(`rev-parse origin/${toBranch}`, tdiPath);
+    const commonAncestorHash = execGitCommand(`merge-base ${_git.commitTdi.local().hash} ${branchHash}`, tdiPath);
+    const commonAncestorDate = execGitCommand(`show ${commonAncestorHash} --no-patch --format=%cd --date=iso-strict `, tdiPath, ['date']).date;
+    tdiBranch.commonAncestor = {date: new Date(commonAncestorDate)};
+  }
+
+  // Get number of commits behind
+  tdiBranch.commitsBehind = execGitCommand(`rev-list HEAD...origin/${tdiBranch.name} --count`, tdiPath);
+  return tdiBranch;
 };

package/src/lib/gulp-batch-replace-with-filter.js

@@ -1,19 +1,19 @@
-// based on gulp-batch-replace
-
-const es = require('event-stream'), minimatch = require('minimatch'), istextorbinary = require('istextorbinary');
-
-const execReplace = (c, s, r) => Buffer.from(s instanceof RegExp ? String(c).replace(s, r) : String(c).split(s).join(r));
-
-module.exports = arr => {
-  return es.map((file, callback) => {
-    if(file.contents instanceof Buffer) {
-      for (const e of arr) {
-        // exec if no glob is passed or if glob matches, and it's a text file
-        if ((!e[2] || minimatch(file.path, e[2])) && istextorbinary.isText(file.path, file)) {
-          file.contents = execReplace(file.contents, e[0], e[1]);
-        }
-      }
-    }
-    callback(null, file);
-  });
-};
+// based on gulp-batch-replace
+
+const es = require('event-stream'), minimatch = require('minimatch'), istextorbinary = require('istextorbinary');
+
+const execReplace = (c, s, r) => Buffer.from(s instanceof RegExp ? String(c).replace(s, r) : String(c).split(s).join(r));
+
+module.exports = arr => {
+  return es.map((file, callback) => {
+    if(file.contents instanceof Buffer) {
+      for (const e of arr) {
+        // exec if no glob is passed or if glob matches, and it's a text file
+        if ((!e[2] || minimatch(file.path, e[2])) && istextorbinary.isText(file.path, file)) {
+          file.contents = execReplace(file.contents, e[0], e[1]);
+        }
+      }
+    }
+    callback(null, file);
+  });
+};

package/src/lib/gulp-simple-rename.js

@@ -1,11 +1,11 @@
-// replacement for the official (but deprecated) gulp-simple-rename
-// kept same name because of usage in tdi
-
-const through2  = require('through2');
-
-module.exports = (fn) => {
-  return through2.obj((file, enc, cb) => {
-    file.path = fn(file.path);
-    cb(null, file);
-  });
-};
+// replacement for the official (but deprecated) gulp-simple-rename
+// kept same name because of usage in tdi
+
+const through2  = require('through2');
+
+module.exports = (fn) => {
+  return through2.obj((file, enc, cb) => {
+    file.path = fn(file.path);
+    cb(null, file);
+  });
+};

package/src/modules/build/oxygen.js

@@ -1,178 +1,178 @@
-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);
+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/git/index.js

@@ -172,14 +172,14 @@ function updateRepo () {
  */
 function updateSubmodule({dates = [], updateSubmodule: releaseBranchName}) {
   const [dateCustomFrom, dateCustomTo] = dates;
-  const toBranchName = typeof releaseBranchName !== 'boolean' ? releaseBranchName : null;
+  const targetVersion = typeof releaseBranchName !== 'boolean' ? releaseBranchName : null;
 
   if (dateCustomFrom) _warn(`While testing the "TDI commits requiring migration" note that the submodule is not changed.`);
-  if (dateCustomFrom && !toBranchName) _error(`Specify a release branch for testing the migration, e.g. "--us 5.6".`);
+  if (dateCustomFrom && !targetVersion) _error(`Specify a release branch for testing the migration, e.g. "--us 5.6".`);
 
   // For testing the migrations (dates argument is specified); submodule pull, fetch, updates fail or result in switching to the release-branch; while we want to test the migration in the current submodule branch / symlink to TDI-project. Therefore all submodule actions should not be applied when the dates argument is specified. As the release of the current submodule cannot be determined you also need to specify the toBranchName so you can test the migrations you want.
-  const branch = !dateCustomFrom ? getTdiBranch(toBranchName) : {'name': `release/${toBranchName}`};
-  const branchUpgrade = branch.from ? branch.from.name < branch.name : false;
+  const branch = !dateCustomFrom ? getTdiBranch(targetVersion) : {'name': `release/${targetVersion}`, 'version': targetVersion};
+  const branchUpgrade = branch.from ? compare(branch.from.version, branch.version, '<') : false;
 
   if (branchUpgrade) _info(`Current branch '${branch.from.name}' will be updated to '${branch.name}'\nCommon ancestor will be used in selecting TDI commits requiring migration: ${_formatDate(branch.commonAncestor.date)}`);
   _info(`Branch ${branch.name} is ${branch.commitsBehind} commits behind.\n`);
@@ -203,8 +203,6 @@ function updateSubmodule({dates = [], updateSubmodule: releaseBranchName}) {
     const migrations = _modulesTdi.require('git/tdiCommitsRequiringMigration.js');
     const fromDate = dateCustomFrom ? new Date(dateCustomFrom) : branch.commonAncestor?.date ?? dateBeforeUpdate;
     const toDate = dateCustomTo ? new Date(dateCustomTo) : new Date();
-    const fromVersion = branch.from?.name?.replace('release/', '');
-    const toVersion = branch.name.replace('release/', '');
 
     _info(`TDI commits requiring migration between ${_formatDate(fromDate)} and ${_formatDate(toDate)}`);
     // Filter the migrations that should be applied/considered; Also display older releases migrations
@@ -214,11 +212,11 @@ function updateSubmodule({dates = [], updateSubmodule: releaseBranchName}) {
       
       if (branchUpgrade) {
         // For branch upgrades, include all migrations for versions newer than the current one, and include new migrations for the current version
-        const isTargetBranch = compare(r.release, toVersion, '<=') && compare(r.release, fromVersion, '>');
-        return isTargetBranch || (r.release === fromVersion && withinDateRange);
+        const isTargetBranch = compare(r.release, branch.version, '<=') && compare(r.release, branch.from.version, '>');
+        return isTargetBranch || (r.release === branch.from.version && withinDateRange);
       } else {
         // For non-branch upgrades, only include new migrations for the current branch
-        return r.release === toVersion && withinDateRange;
+        return r.release === branch.version && withinDateRange;
       }
     }));
 
@@ -227,7 +225,7 @@ function updateSubmodule({dates = [], updateSubmodule: releaseBranchName}) {
     migrationsFiltered
       .sort((a, b) => Date(a.releases[0].date) > Date(b.releases[0].date) ? 1 : -1)
       .forEach(m => {
-        const date = _formatDate(new Date(m.releases.filter(r => branch.name >= `release/${r.release}`)[0].date));
+        const date = _formatDate(new Date(m.releases.filter(r => compare(branch.version, r.release, '>='))[0].date));
         relevantMigrationCount += m.callback(date, relevantMigrationCount+1) === 1 ? 1 : 0;
       });
 

package/src/modules/info/index.js

@@ -1,201 +1,201 @@
-const fs      = require('fs-extra');
-const globby  = require('globby');
-const path    = require('path');
-const {Table} = require('console-table-printer');
-
-const execGitCommand  = require('../../lib/exec-git-command');
-const getTdiBranch    = require('../../lib/get-tdi-branch');
-const c               = require('../deploy/config');
-const RemoteExec      = require('../../lib/remote-exec');
-
-
-const getGitInfo = () => {
-  // Version info TDI submodule
-  const gitSubmoduleInfo = new Table({
-    columns: [
-      {name: 'property', title: 'TDI - submodule', alignment: 'left'},
-      {name: 'value', alignment: 'left'}
-    ],
-  });
-
-  // Fetch all
-  const cmdFetch = execGitCommand('fetch -pf --all', path.join(_paths.repo, _paths.tdi));
-  if (cmdFetch.error) _warn(`Fetch failed\n${cmdFetch.error}`);
-
-  // Set branch name of firstBranch without 'remotes/origin/'
-  const tdiBranch = getTdiBranch();
-
-  // Get number of commits behind
-  tdiBranch.commitsBehind = execGitCommand(`rev-list HEAD...origin/${tdiBranch.name} --count`, path.join(_paths.repo, _paths.tdi));
-
-  // Create table rows for TDI submodule info
-  gitSubmoduleInfo.addRow({
-    property: 'Commit date',
-    value: _formatDate(_git.commitTdi.local().date)
-  });
-  if (tdiBranch) {
-    gitSubmoduleInfo.addRow({
-      property: 'Branch',
-      value: tdiBranch.name
-    });
-    gitSubmoduleInfo.addRow({
-      property: 'Commits behind',
-      value: tdiBranch.commitsBehind
-    });
-  } else {
-    gitSubmoduleInfo.addRow({
-      property: 'Branch could not be determined',
-      value: ''
-    });
-  }
-
-  // Print TDI submodule info
-  gitSubmoduleInfo.printTable();
-};
-
-const getFileExtractInfo = (sorting) => {
-  // version info miscellaneous
-  const projects = new Set;
-  const types = new Set;
-  const versionInfo = new Table({
-    columns: [
-      {name: 'path', alignment: 'left'},
-      {name: 'type', alignment: 'left'},
-      {name: 'version', alignment: 'left'},
-      {name: 'sort'}
-    ],
-    disabledColumns: ['sort'],
-    sort: (a, b) => a.sort.toLowerCase() > b.sort.toLowerCase() ? 1 : -1
-  });
-
-  const versionInfoConfig = _modulesTdi.require('version/versionInfo.js');
-  if (versionInfoConfig) {
-
-    versionInfoConfig.forEach(v => {
-      const location = path.join(_paths.repo, v.glob);
-
-      globby
-        .sync(location)
-        .forEach(f => {
-          const filePathExtract = f.match(/.*(?<path>(cmscustom|site-stylesheets)\/(?<customer>[^/]*)\/(?<project>[^/]*)\/.*)/);
-          const path = filePathExtract.groups.path || '';
-          const project = filePathExtract.groups.project || '';
-
-          const fileContent = fs.readFileSync(f).toString();
-          v.extracts.forEach(e => {
-            const extract = fileContent.match(e.regex);
-            if (extract) {
-              projects.add(project); // Store the projects where versioninfo is found
-              types.add(e.type); // Store the types for which versioninfo is found
-              versionInfo.addRow({ // Create row with version information to output
-                path,
-                sort: `${sorting=='project' ? project : e.type}_2${sorting=='project' ? e.type : extract.groups.version}`, // Output is sorted on project or type: '_2' ensures it is rendered after the empty row and the row with the project name
-                type: e.type,
-                version: extract.groups.version
-              });
-            }
-          });
-        });
-    });
-
-    if (sorting=='project') {
-      // For projects containing version information
-      projects.forEach(p => {
-        versionInfo.addRow({ // Add empty row after project
-          path: '',
-          sort: `${p}_3`,
-          type: '',
-          version: ''
-        });
-        versionInfo.addRow({ // Add row with project name
-          path: `-- ${p}:`,
-          sort: `${p}_1`,
-          type: '',
-          version: ''
-        }, {
-          color: 'yellow'
-        });
-      });
-    }
-    else if (sorting=='type') {
-      types.forEach(t => {
-        versionInfo.addRow({ // Add empty row after type
-          path: '',
-          sort: `${t}_3`,
-          type: '',
-          version: ''
-        });
-      });
-    }
-    versionInfo.printTable();
-  }
-  else {
-    _warn('Version info of miscellaneous items cannot be extracted:\nCannot find required files in TDI submodule. Try updating TDI submodule.');
-  }
-};
-
-const getServerInfo = (server) => {
-  // Remote server info
-  // common setup
-  _write();
-  c.setServer(server);
-
-  if (!c.envDev) {
-    _info(`Remote version info for '${c.server.ftpConfig.host}':\n`);
-    new RemoteExec(c.server.ftpConfig).add('sudo ~root/scripts/version.sh', 'STDOUT').process();
-  }
-  else {
-    _info('For development environments no server version information is available. Check rancher / database for this information.\nAdd the --server option with a non-dev environment to see version information for that server.');
-  }
-};
-
-
-module.exports = function info (argv) {
-
-  if (argv.doctypes) {
-    _info('Document type information for this git repository\n');
-
-    const doctypesInfo = new Table({
-      columns: [
-        {name: 'id', alignment: 'right'},
-        {name: 'name', alignment: 'left'},
-        {name: 'paths', alignment: 'left'}
-      ],
-    });
-
-    globby
-      .sync(_paths.repo + '/database/config/**/txd_document_types.sql')
-      .forEach((p, i, a) => {
-        fs.readFileSync(p).toString().match(/select([\s\S]+?)from\s+dual/gmi)
-          .forEach((dtRow, i, a) => {
-            const ntSqlInsert = fs.readFileSync(p.replace('txd_document_types', 'txd_node_types')).toString().match(/select(.*?)from\s+dual/s)[1];
-            const id      = dtRow.match(/(\d+) id/)?.[1];
-            const name    = dtRow.match(/'([^']+)' display_name/)?.[1];
-            const dbPath  = p.match(/(database\/config\/(:?.*)\/)txd_document_types.sql/i)?.[1];
-            const xincl   = ntSqlInsert.match(/'([^']+)' xsl_prep_inc/)?.[1] ??  dtRow.match(/'([^']+)' xsl_xincludes/)[1];
-            const prPath  = xincl.replace('prepare_xincludes.xsl', '');
-
-            doctypesInfo.addRows([
-              {id, name, paths: 'config/cmscustom/'+ prPath},
-              {paths: dbPath}
-            ]);
-
-            if (i!==a.length-1) doctypesInfo.addRow({});
-          });
-
-        if (i!==a.length-1) doctypesInfo.addRow({});
-      });
-
-
-    doctypesInfo.printTable();
-  }
-
-  if (argv.versions) {
-    _info('Version information for this git repository\n');
-
-    getGitInfo();
-    getFileExtractInfo(argv.versions);
-    getServerInfo(argv.server);
-  }
-
-};
+const fs      = require('fs-extra');
+const globby  = require('globby');
+const path    = require('path');
+const {Table} = require('console-table-printer');
+
+const execGitCommand  = require('../../lib/exec-git-command');
+const getTdiBranch    = require('../../lib/get-tdi-branch');
+const c               = require('../deploy/config');
+const RemoteExec      = require('../../lib/remote-exec');
+
+
+const getGitInfo = () => {
+  // Version info TDI submodule
+  const gitSubmoduleInfo = new Table({
+    columns: [
+      {name: 'property', title: 'TDI - submodule', alignment: 'left'},
+      {name: 'value', alignment: 'left'}
+    ],
+  });
+
+  // Fetch all
+  const cmdFetch = execGitCommand('fetch -pf --all', path.join(_paths.repo, _paths.tdi));
+  if (cmdFetch.error) _warn(`Fetch failed\n${cmdFetch.error}`);
+
+  // Set branch name of firstBranch without 'remotes/origin/'
+  const tdiBranch = getTdiBranch();
+
+  // Get number of commits behind
+  tdiBranch.commitsBehind = execGitCommand(`rev-list HEAD...origin/${tdiBranch.name} --count`, path.join(_paths.repo, _paths.tdi));
+
+  // Create table rows for TDI submodule info
+  gitSubmoduleInfo.addRow({
+    property: 'Commit date',
+    value: _formatDate(_git.commitTdi.local().date)
+  });
+  if (tdiBranch) {
+    gitSubmoduleInfo.addRow({
+      property: 'Branch',
+      value: tdiBranch.name
+    });
+    gitSubmoduleInfo.addRow({
+      property: 'Commits behind',
+      value: tdiBranch.commitsBehind
+    });
+  } else {
+    gitSubmoduleInfo.addRow({
+      property: 'Branch could not be determined',
+      value: ''
+    });
+  }
+
+  // Print TDI submodule info
+  gitSubmoduleInfo.printTable();
+};
+
+const getFileExtractInfo = (sorting) => {
+  // version info miscellaneous
+  const projects = new Set;
+  const types = new Set;
+  const versionInfo = new Table({
+    columns: [
+      {name: 'path', alignment: 'left'},
+      {name: 'type', alignment: 'left'},
+      {name: 'version', alignment: 'left'},
+      {name: 'sort'}
+    ],
+    disabledColumns: ['sort'],
+    sort: (a, b) => a.sort.toLowerCase() > b.sort.toLowerCase() ? 1 : -1
+  });
+
+  const versionInfoConfig = _modulesTdi.require('version/versionInfo.js');
+  if (versionInfoConfig) {
+
+    versionInfoConfig.forEach(v => {
+      const location = path.join(_paths.repo, v.glob);
+
+      globby
+        .sync(location)
+        .forEach(f => {
+          const filePathExtract = f.match(/.*(?<path>(cmscustom|site-stylesheets)\/(?<customer>[^/]*)\/(?<project>[^/]*)\/.*)/);
+          const path = filePathExtract.groups.path || '';
+          const project = filePathExtract.groups.project || '';
+
+          const fileContent = fs.readFileSync(f).toString();
+          v.extracts.forEach(e => {
+            const extract = fileContent.match(e.regex);
+            if (extract) {
+              projects.add(project); // Store the projects where versioninfo is found
+              types.add(e.type); // Store the types for which versioninfo is found
+              versionInfo.addRow({ // Create row with version information to output
+                path,
+                sort: `${sorting=='project' ? project : e.type}_2${sorting=='project' ? e.type : extract.groups.version}`, // Output is sorted on project or type: '_2' ensures it is rendered after the empty row and the row with the project name
+                type: e.type,
+                version: extract.groups.version
+              });
+            }
+          });
+        });
+    });
+
+    if (sorting=='project') {
+      // For projects containing version information
+      projects.forEach(p => {
+        versionInfo.addRow({ // Add empty row after project
+          path: '',
+          sort: `${p}_3`,
+          type: '',
+          version: ''
+        });
+        versionInfo.addRow({ // Add row with project name
+          path: `-- ${p}:`,
+          sort: `${p}_1`,
+          type: '',
+          version: ''
+        }, {
+          color: 'yellow'
+        });
+      });
+    }
+    else if (sorting=='type') {
+      types.forEach(t => {
+        versionInfo.addRow({ // Add empty row after type
+          path: '',
+          sort: `${t}_3`,
+          type: '',
+          version: ''
+        });
+      });
+    }
+    versionInfo.printTable();
+  }
+  else {
+    _warn('Version info of miscellaneous items cannot be extracted:\nCannot find required files in TDI submodule. Try updating TDI submodule.');
+  }
+};
+
+const getServerInfo = (server) => {
+  // Remote server info
+  // common setup
+  _write();
+  c.setServer(server);
+
+  if (!c.envDev) {
+    _info(`Remote version info for '${c.server.ftpConfig.host}':\n`);
+    new RemoteExec(c.server.ftpConfig).add('sudo ~root/scripts/version.sh', 'STDOUT').process();
+  }
+  else {
+    _info('For development environments no server version information is available. Check rancher / database for this information.\nAdd the --server option with a non-dev environment to see version information for that server.');
+  }
+};
+
+
+module.exports = function info (argv) {
+
+  if (argv.doctypes) {
+    _info('Document type information for this git repository\n');
+
+    const doctypesInfo = new Table({
+      columns: [
+        {name: 'id', alignment: 'right'},
+        {name: 'name', alignment: 'left'},
+        {name: 'paths', alignment: 'left'}
+      ],
+    });
+
+    globby
+      .sync(_paths.repo + '/database/config/**/txd_document_types.sql')
+      .forEach((p, i, a) => {
+        fs.readFileSync(p).toString().match(/select([\s\S]+?)from\s+dual/gmi)
+          .forEach((dtRow, i, a) => {
+            const ntSqlInsert = fs.readFileSync(p.replace('txd_document_types', 'txd_node_types')).toString().match(/select(.*?)from\s+dual/s)[1];
+            const id      = dtRow.match(/(\d+) id/)?.[1];
+            const name    = dtRow.match(/'([^']+)' display_name/)?.[1];
+            const dbPath  = p.match(/(database\/config\/(:?.*)\/)txd_document_types.sql/i)?.[1];
+            const xincl   = ntSqlInsert.match(/'([^']+)' xsl_prep_inc/)?.[1] ??  dtRow.match(/'([^']+)' xsl_xincludes/)[1];
+            const prPath  = xincl.replace('prepare_xincludes.xsl', '');
+
+            doctypesInfo.addRows([
+              {id, name, paths: 'config/cmscustom/'+ prPath},
+              {paths: dbPath}
+            ]);
+
+            if (i!==a.length-1) doctypesInfo.addRow({});
+          });
+
+        if (i!==a.length-1) doctypesInfo.addRow({});
+      });
+
+
+    doctypesInfo.printTable();
+  }
+
+  if (argv.versions) {
+    _info('Version information for this git repository\n');
+
+    getGitInfo();
+    getFileExtractInfo(argv.versions);
+    getServerInfo(argv.server);
+  }
+
+};