@tangelo/tangelo-configuration-toolkit 1.14.3 → 1.15.1

package/README.md

@@ -1,67 +1,67 @@
-# 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 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:
-
-    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
-
-The `deploy` command requires server connection information. So you'll have to create a configuration file named `tangelo-configuration-toolkit-appconfig.json` in which such information can be stored. This file will be searched for in an ancestor directory of the current working directory.
-
-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.
-
-### Repo
-
-The `build` and `sql` commands make use of a configuration file in the repository named `tangelo-configuration-toolkit-repoconfig.json`. This contains information about the customer projects.
-
-For a new repository, using `tct build --init` also creates the repoconfig-file. For existing projects not having the repoconfig-file, you can use `tct build --config` to generate it.
-
-### 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
+# 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
+
+The `deploy` command requires server connection information. So you'll have to create a configuration file named `tangelo-configuration-toolkit-appconfig.json` in which such information can be stored. This file will be searched for in an ancestor directory of the current working directory.
+
+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.
+
+### Repo
+
+The `build` and `sql` commands make use of a configuration file in the repository named `tangelo-configuration-toolkit-repoconfig.json`. This contains information about the customer projects.
+
+For a new repository, using `tct build --init` also creates the repoconfig-file. For existing projects not having the repoconfig-file, you can use `tct build --config` to generate it.
+
+### 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

package/bin/index.js

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

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) || {}; }
@@ -124,9 +124,34 @@ else {
 }
 
 
-global._tdiSubmoduleExists = fs.existsSync(path.join(_paths.repo, _paths.tdi));
-global._isPre42 = fs.existsSync(path.join(_paths.repo, _paths.tdi, 'create_new_project')); // folder changed in 4.2
-global._isPre51 = !fs.existsSync(path.join(_paths.repo, _paths.tdi, 'src')); // folder changed in 5.1 (check new folder because old one could still exist after branch switch)
+global._tdiSubmoduleExists = () => fs.existsSync(path.join(_paths.repo, _paths.tdi));
+global._isPre42 = () => fs.existsSync(path.join(_paths.repo, _paths.tdi, 'create_new_project')); // folder changed in 4.2
+global._isPre51 = () => !fs.existsSync(path.join(_paths.repo, _paths.tdi, 'src')); // folder changed in 5.1 (check new folder because old one could still exist after branch switch)
+
+global._modulesTdi = {
+  absolutePathTdi: path.join(_paths.repo, _paths.tdi),
+  ensureDepsUpToDate() {
+    if (this.depsUpToDate) return;
+    try {
+      _info('Checking installed dependencies in submodule');
+      execSync('npm list', {cwd: this.absolutePathTdi, stdio: 'ignore'});
+    } catch (e) {
+      _info('Updating dependencies in submodule');
+      execSync('npm update', {cwd: this.absolutePathTdi, stdio: 'ignore'});
+    }
+    this.depsUpToDate = true;
+  },
+  require(module) {
+    this.ensureDepsUpToDate();
+    _info(`Loading ${path.join(_paths.tdi, 'tct', module)}\n`);
+    try {
+      return require(path.join(this.absolutePathTdi, 'tct', module));
+    }
+    catch (e) {
+      _error('Module could not be loaded');
+    }
+  }
+};
 
 
 process.on('beforeExit', () => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tangelo/tangelo-configuration-toolkit",
-  "version": "1.14.3",
+  "version": "1.15.1",
   "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/cli.js

@@ -119,10 +119,9 @@ module.exports = function cli () {
       ['$0 git --update tdi --branch 5.4', 'Update TDI submodule to latest in specified branch']
     ])
     .check((argv, options) => {
-      const passedOpts  = Object.keys(argv).filter(k => !['_', '$0', 'server', 's', 'filter', 'f', 'branch', 'b'].includes(k)); // also filter options with defaults
-      const hasOpts     = Object.keys(options)[0];
-      if (hasOpts && !passedOpts[0]) yargs.showHelp();
-      return true;
+      const nonDefaultOptions = Object.keys(options.key).filter(o => !Object.keys(options.default).includes(o));
+      if (nonDefaultOptions.some(o => argv[o])) return true;
+      else throw new Error("Pass a non-default option");
     })
     .strict()
     .wrap(100)

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/get-tdi-branch.js

@@ -1,44 +1,44 @@
-const execGitCommand = require('./exec-git-command');
-const path           = require('path');
-
-module.exports = function getTdiBranch(toBranchName) {
-  const tdiBranch = {};
-  // Fetch all
-  _info(`Fetch TDI submodule`);
-  const cmdFetch = execGitCommand('fetch -pf --all', path.join(_paths.repo, _paths.tdi));
-  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`, path.join(_paths.repo, _paths.tdi)).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}`, path.join(_paths.repo, _paths.tdi)).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}`, path.join(_paths.repo, _paths.tdi));
-    const commonAncestorHash = execGitCommand(`merge-base ${_git.commitTdi.local().hash} ${branchHash}`, path.join(_paths.repo, _paths.tdi));
-    const commonAncestorDate = execGitCommand(`show ${commonAncestorHash} --no-patch --format=%cd --date=iso-strict `, path.join(_paths.repo, _paths.tdi), ['date']).date;
-    tdiBranch.commonAncestor = {date: new Date(commonAncestorDate)};
-  }
-
-  // Get number of commits behind
-  tdiBranch.commitsBehind = execGitCommand(`rev-list HEAD...origin/${tdiBranch.name} --count`, path.join(_paths.repo, _paths.tdi));
-  return tdiBranch;
+const execGitCommand = require('./exec-git-command');
+const path           = require('path');
+
+module.exports = function getTdiBranch(toBranchName) {
+  const tdiBranch = {};
+  // Fetch all
+  _info(`Fetch TDI submodule`);
+  const cmdFetch = execGitCommand('fetch -pf --all', path.join(_paths.repo, _paths.tdi));
+  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`, path.join(_paths.repo, _paths.tdi)).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}`, path.join(_paths.repo, _paths.tdi)).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}`, path.join(_paths.repo, _paths.tdi));
+    const commonAncestorHash = execGitCommand(`merge-base ${_git.commitTdi.local().hash} ${branchHash}`, path.join(_paths.repo, _paths.tdi));
+    const commonAncestorDate = execGitCommand(`show ${commonAncestorHash} --no-patch --format=%cd --date=iso-strict `, path.join(_paths.repo, _paths.tdi), ['date']).date;
+    tdiBranch.commonAncestor = {date: new Date(commonAncestorDate)};
+  }
+
+  // Get number of commits behind
+  tdiBranch.commitsBehind = execGitCommand(`rev-list HEAD...origin/${tdiBranch.name} --count`, path.join(_paths.repo, _paths.tdi));
+  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) {
-      arr.forEach(e => {
-        // 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) {
+      arr.forEach(e => {
+        // 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/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/index.js

@@ -17,7 +17,7 @@ const createSymlink = (t, p) => {
 
 const createSymlinks = () => {
   _info('Creating symlinks:');
-  const src = _isPre51 ? 'sources' : 'src';
+  const src = _isPre51() ? 'sources' : 'src';
   createSymlink(src + '/config/cmscustom/tdi', 'config/cmscustom/tdi');
   globby
     .sync('config/cmscustom/!(tdi)/**/fonto')
@@ -30,15 +30,15 @@ const createSymlinks = () => {
 module.exports = function build (argv) {
 
   if (argv.init) {
-    if (_isPre51) _error('This option only works when using branch release/5.1 and up.');
+    if (_isPre51()) _error('This option only works when using branch release/5.1 and up.');
 
-    require(path.join(_paths.repo, _paths.tdi, 'tct/build/init'))(createSymlinks);
+    _modulesTdi.require('build/init')(createSymlinks);
   }
 
   if (argv.project) {
-    if (_isPre51) _error('This option only works when using branch release/5.1 and up.');
+    if (_isPre51()) _error('This option only works when using branch release/5.1 and up.');
 
-    const {projectNew, projectCopy} = require(path.join(_paths.repo, _paths.tdi, 'tct/build/project'));
+    const {projectNew, projectCopy} = _modulesTdi.require('build/project');
 
     inquirer
       .prompt([{