@tangelo/tangelo-configuration-toolkit 1.14.2 → 1.14.4

package/.pre-commit-config.yaml

@@ -4,33 +4,32 @@
 repos:
 
 - repo: https://github.com/pre-commit/pre-commit-hooks
-  rev: v3.2.0
+  rev: v4.4.0
   hooks:
   - id: trailing-whitespace
   - id: check-json
-  - id: check-xml
   - id: check-merge-conflict # checks for files that contain merge conflict strings
   - id: check-added-large-files
     args: [--maxkb=100]
 
 - repo: https://github.com/pre-commit/pygrep-hooks
-  rev: v1.9.0
+  rev: v1.10.0
   hooks:
   - id: text-unicode-replacement-char # forbid files which have a UTF-8 Unicode replacement character
 
-- repo: https://github.com/crate-ci/typos
-  rev: v1.12.14
-  hooks:
-  - id: typos # spell checker
-
 - repo: https://github.com/macisamuele/language-formatters-pre-commit-hooks
-  rev: v2.4.0
+  rev: v2.10.0
   hooks:
   - id: pretty-format-yaml
     args: [--autofix, --indent, '2']
 
 - repo: https://github.com/pre-commit/mirrors-eslint
-  rev: v8.28.0
+  rev: v8.49.0
   hooks:
   - id: eslint # javascript linter and formatter
     args: [--fix]
+
+- repo: https://github.com/crate-ci/typos
+  rev: v1.16.11
+  hooks:
+  - id: typos # spell checker

package/README.md

@@ -4,7 +4,7 @@ Tangelo Configuration Toolkit is a command-line toolkit which offers support for
 
 ## Installation
 
-The toolkit requires [NPM](https://www.npmjs.com/get-npm) on [Node.js®](https://nodejs.org/) (at least version 14.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:
+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
 

package/bitbucket-pipelines.yml

@@ -13,20 +13,20 @@ definitions:
   - step: &build-test-sonarcloud
       name: Build, test and analyze on SonarCloud
       caches:
-        - sonar
+      - sonar
       script:
-        - pipe: sonarsource/sonarcloud-scan:1.4.0
+      - pipe: sonarsource/sonarcloud-scan:2.0.0
   - step: &check-quality-gate-sonarcloud
       name: Check the Quality Gate on SonarCloud
       script:
-        - pipe: sonarsource/sonarcloud-quality-gate:0.1.6
+      - pipe: sonarsource/sonarcloud-quality-gate:0.1.6
 
 pipelines:
   branches:
     master:
-      - step: *build-test-sonarcloud
-      - step: *check-quality-gate-sonarcloud
+    - step: *build-test-sonarcloud
+    - step: *check-quality-gate-sonarcloud
   pull-requests:
     '**':
-      - step: *build-test-sonarcloud
-      - step: *check-quality-gate-sonarcloud
+    - step: *build-test-sonarcloud
+    - step: *check-quality-gate-sonarcloud

package/index.js

@@ -30,23 +30,23 @@ global._info = (msg, time = false) => {
   console.log(msg.lgreen);
 };
 
-global._warn = (msg) => {
+global._warn = msg => {
   console.log(msg.lyellow);
 };
 
-global._error = (msg) => {
+global._error = msg => {
   console.log(msg.red, '\n');
   process.exit();
 };
 
-global._perf = (t1) => {
+global._perf = t1 => {
   const t2 = new Date();
   console.log(`\nExecution time: ${t2 - t1}ms`.blue);
 };
 
-global._formatDate = (date) => {
-  return date.toLocaleDateString('en-gb', {day: 'numeric', month: 'short', year: 'numeric', hour: '2-digit', minute: '2-digit'});
-};
+global._formatDate = date =>
+  date?.toLocaleDateString('en-gb', {day: 'numeric', month: 'short', year: 'numeric', hour: '2-digit', minute: '2-digit'});
+;
 
 global._paths = {
   app: __dirname,
@@ -61,7 +61,7 @@ _paths.apply = process.cwd().replace(_paths.repo, '').substr(1);
 
 
 global._appdata = fs.readJsonSync(_paths.appdata, {throws: false}) || {};
-_appdata._update = (data) => Object.assign(_appdata, data, {_changed: true});
+_appdata._update = data => Object.assign(_appdata, data, {_changed: true});
 if (!_appdata.npmPath) {
   _appdata._update({npmPath: execSync('npm config get prefix', {encoding: 'UTF-8'}).replace(/\s$/, '')});
 }
@@ -112,7 +112,7 @@ global._git = {
 
 
 if (_git.commitTdi.after(_git.commitTdi.stopUsingRepoconfigFile)) {
-  global._repoconfig = require('./src/lib/get-repoconfig')();
+  global._repoconfig = require('./src/lib/get-repoconfig')(_paths.repo);
 }
 else {
   try { global._repoconfig = fs.existsSync(_paths.repoconfig) && fs.readJsonSync(_paths.repoconfig) || {}; }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tangelo/tangelo-configuration-toolkit",
-  "version": "1.14.2",
+  "version": "1.14.4",
   "engines": {
     "node": ">=14.0.0"
   },
@@ -28,7 +28,7 @@
     "del": "^6.0.0",
     "event-stream": "^4.0.1",
     "find-up": "^5.0.0",
-    "fs-extra": "^10.0.0",
+    "fs-extra": "^11.1.1",
     "globby": "^6.1.0",
     "gulp": "^4.0.2",
     "gulp-babel": "^8.0.0",
@@ -40,17 +40,17 @@
     "gulp-sourcemaps": "^3.0.0",
     "inquirer": "^8.2.0",
     "istextorbinary": "^6.0.0",
-    "minimatch": "^5.0.0",
-    "node-ssh": "^12.0.2",
+    "minimatch": "^8.0.4",
+    "node-ssh": "^13.1.0",
     "object-assign-deep": "^0.4.0",
     "p-limit": "^3.1.0",
     "replace-in-file": "^6.3.2",
     "sass": "^1.43.5",
     "saxon-js": "^2.3.0",
-    "ssh2-sftp-client": "^7.2.2",
+    "ssh2-sftp-client": "^9.1.0",
     "through2": "^4.0.2",
     "tiny-lr": "^2.0.0",
-    "yargs": "^16.2.0"
+    "yargs": "^17.7.2"
   },
   "repository": {
     "type": "git",

package/src/lib/get-repoconfig.js

@@ -2,12 +2,12 @@ const fs      = require('fs-extra');
 const globby  = require('globby');
 
 
-module.exports = function getRepoconfig() {
+module.exports = function getRepoconfig(repoPath) {
 
   const repoconfig = [];
 
   globby
-    .sync('database/config/**/txd_document_types.sql')
+    .sync('database/config/**/txd_document_types.sql', {cwd: repoPath, absolute: true})
     .forEach(p => {
       const dtSqlInsert = fs.readFileSync(p).toString().match(/select(.*?)from/s)[1];
       const ntSqlInsert = fs.readFileSync(p.replace('txd_document_types', 'txd_node_types')).toString().match(/select(.*?)from/s)[1];
@@ -17,7 +17,7 @@ module.exports = function getRepoconfig() {
       const xpiDir        = ntSqlInsert.match(/'([^']+)' xsl_prep_inc/)[1];
 
       const path_cmscustom  = xpiDir.replace(/\/[^/]+$/, '').split(/\//);
-      const path_dbconfig   = p.replace(/database\/config\/(.*)\/[^/]+/, '$1').split(/[/\\]/);
+      const path_dbconfig   = p.replace(/.*\/database\/config\/(.*)\/[^/]+/, '$1').split(/[/\\]/);
       const dnRegex         = [path_cmscustom[0].replace(/[_'"]/g, '.'), path_dbconfig[0].replace(/[_'"]/g, '.')].sort((a, b) => b.length - a.length).join('|');
       const customer_name   = (dtDisplayName.match(RegExp(dnRegex, 'i')) || dtDisplayName.split(/ (.+)/))[0];
 

package/src/lib/style-string-getters.js

@@ -1,3 +1,5 @@
+/* eslint-disable no-control-regex */
+
 const styles = {bold: 1, underline: 4, black: 30, red: 31, green: 32, yellow: 33, blue: 34, magenta: 35, cyan: 36, white: 37, lblack: 90, lred: 91, lgreen: 92, lyellow: 93, lblue: 94, lmagenta: 95, lcyan: 96, lwhite: 97};
 
 for (const name in styles ) {

package/src/modules/build/oxygen.js

@@ -11,14 +11,13 @@ const siteStylesheetsPath = 'config/txp/site-stylesheets/';
 const masterFiles = new Set;
 const transformationScenarios = [];
 
-const convertToValidFilename = (string) => string.replace(/[/|\\:*?"<>]/g, ' ');
+const convertToValidFilename = string => string.replace(/[/|\\:*?"<>]/g, ' ');
 
-const createProjectFile = (config, filename) => {
+const createProjectFile = (config, newXprFile) => {
   _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 (xprFiles.indexOf(newXprFile)===-1) xprFiles.unshift(newXprFile);
+  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(', ')}`);
@@ -49,10 +48,10 @@ const createProjectFile = (config, filename) => {
   transformXprFile(xprFiles);
 };
 
-const getTransformations = (config) => {
+const getTransformations = config => {
   _repoconfig.forEach(rc => {
     // get pathname of customer/project
-    const [customerPath, projectPath] = config.location == 'database' ? rc.path_dbconfig : rc.path_cmscustom;
+    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(
@@ -67,7 +66,7 @@ const getTransformations = (config) => {
         const fileString = fs.readFileSync(f).toString();
         const baseStrings = fileString.match(RegExp(config.extracts.base, 'gm'));
 
-        if (fileString.replace(/\s|^prompt\s.*$/gm, '')!=='') {
+        if (fileString.replace(/\s|^prompt\s.*$/gm, '') !== '') {
           if (baseStrings) {
             baseStrings.forEach(s => {
             // extract type, name, files info from baseString
@@ -79,12 +78,12 @@ const getTransformations = (config) => {
               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
+                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}`;
+                const filePath = `${config.location === 'txp' ? siteStylesheetsPath : cmscustomPath}${f}`;
                 if (!f.startsWith('tdi')) masterFiles.add(filePath);
               });
             });
@@ -98,7 +97,7 @@ const getTransformations = (config) => {
 };
 
 
-const getMasterfiles = (config) => {
+const getMasterfiles = config => {
   globby
     .sync(`${path.join(_paths.repo, config.files)}`)
     .forEach(cf => {
@@ -118,7 +117,7 @@ const getMasterfiles = (config) => {
               // 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}`;
+                  const filePath = `${config.location === 'txp' ? siteStylesheetsPath : cmscustomPath}${f}`;
                   masterFiles.add(filePath);
                 }
               });
@@ -127,7 +126,7 @@ const getMasterfiles = (config) => {
             _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]}`;
+          const filePath = config.location === 'txp' ? `${siteStylesheetsPath}${cf.split(siteStylesheetsPath)[1]}` : `${cmscustomPath}${cf.split(cmscustomPath)[1]}`;
           masterFiles.add(filePath);
         }
       }
@@ -135,7 +134,7 @@ const getMasterfiles = (config) => {
 
 };
 
-const transformXprFile = (xprFiles) => {
+const transformXprFile = xprFiles => {
   _info('\nUpdating xpr file(s):');
   // create with: xslt3 -t -xsl:createProjectFile.xsl -export:createProjectFile.sef.json v -nogo'
 
@@ -162,7 +161,7 @@ const transformXprFile = (xprFiles) => {
 };
 
 
-module.exports = function oxygen (filename) {
+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 '_'
@@ -171,5 +170,6 @@ module.exports = function oxygen (filename) {
     _error(`Cannot find required files in TDI submodule. Try updating TDI submodule.`);
   }
 
-  createProjectFile(require(spConfigPath), filename);
+  const newXprFile = (typeof arg === 'string') ? convertToValidFilename(arg) + '.xpr' : null;
+  createProjectFile(require(spConfigPath), 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

@@ -31,7 +31,7 @@ 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')])
-  );
+    );
 
   if (fontoPaths.length===0) _error('No Fonto instance found.');
 
@@ -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

@@ -146,7 +146,7 @@ module.exports = function git (argv) {
         if (fs.existsSync(tdiMigrationFilePath)) {
           const migrations = require(tdiMigrationFilePath);
           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

package/src/modules/migrate/steps.js

@@ -52,7 +52,7 @@ module.exports = function steps (step, dry, filter) {
       }
 
       let filesModCount = 0;
-      let maxRepeat = 20;
+      let maxRepeat = 15;
       for (let i=0; i<maxRepeat && r.files[0]; i++) { // execute repeatedly for modified files only (with safety limit of 20)
         r.files = rif.sync(r).filter(f => f.hasChanged).map(f => f.file);
         if (i===0) filesModCount = r.files.length; // save count only after first run (after this only subsets are processed)