@tangelo/tangelo-configuration-toolkit 1.13.0 → 1.14.1

package/.eslintrc.js

@@ -14,6 +14,7 @@ module.exports = {
     '_write': 'writable',
     '_info': 'writable',
     '_warn': 'writable',
+    '_formatDate': 'writable',
     '_error': 'writable',
     '_perf': 'writable',
     '_paths': 'writable',

package/LICENSE.md

@@ -1 +1 @@
-Copyright © 2020 Tangelo Software BV <info@tangelo-software.com>
+Copyright © 2020 Tangelo Software BV <mailto:info@tangelo-software.com>

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 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

package/bin/index.js

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

package/bitbucket-pipelines.yml

@@ -0,0 +1,32 @@
+image: atlassian/default-image:4
+
+clone:
+  depth: full # SonarCloud scanner needs the full history to assign issues properly
+
+definitions:
+  caches:
+    sonar: ~/.sonar/cache # Caching SonarCloud artifacts will speed up your build
+  services:
+    docker:
+      memory: 2048 # For large file line code
+  steps:
+  - step: &build-test-sonarcloud
+      name: Build, test and analyze on SonarCloud
+      caches:
+        - sonar
+      script:
+        - pipe: sonarsource/sonarcloud-scan:1.4.0
+  - step: &check-quality-gate-sonarcloud
+      name: Check the Quality Gate on SonarCloud
+      script:
+        - pipe: sonarsource/sonarcloud-quality-gate:0.1.6
+
+pipelines:
+  branches:
+    master:
+      - step: *build-test-sonarcloud
+      - step: *check-quality-gate-sonarcloud
+  pull-requests:
+    '**':
+      - step: *build-test-sonarcloud
+      - step: *check-quality-gate-sonarcloud

package/index.js

@@ -24,7 +24,7 @@ global._write = (...msg) => {
 global._info = (msg, time = false) => {
   if (time) {
     const tzDiff  = new Date().getTimezoneOffset() * 60000;
-    const time    = new Date(Date.now() - tzDiff).toISOString().replace(/.*T(.*)\..*/g, '$1');
+    const time    = new Date(Date.now() - tzDiff).toISOString().match(/\d\d:\d\d:\d\d/)[0];
     msg = `[${time}] ${msg}`;
   }
   console.log(msg.lgreen);
@@ -44,6 +44,9 @@ global._perf = (t1) => {
   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._paths = {
   app: __dirname,

package/package.json

@@ -1,6 +1,9 @@
 {
   "name": "@tangelo/tangelo-configuration-toolkit",
-  "version": "1.13.0",
+  "version": "1.14.1",
+  "engines": {
+    "node": ">=14.0.0"
+  },
   "description": "Tangelo Configuration Toolkit is a command-line toolkit which offers support for developing a Tangelo configuration.",
   "bin": {
     "tct": "bin/index.js",

package/src/cli.js

@@ -64,9 +64,11 @@ module.exports = function cli () {
       aliases: ['g'],
       desc: 'Git repo actions (requires global git installation)',
       builder: {
-        init: {alias: 'i', desc: 'Initialize repository and add submodule', conflicts: ['r']},
-        reset: {alias: 'r', desc: 'Reset repository to last commit', conflicts: ['i']},
-        clone: {alias: 'c', desc: 'Clone a client repository and do basic setup'},
+        init: {alias: 'i', desc: 'Initialize repository and add submodule', conflicts: ['r', 'c', 'u']},
+        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: {alias: 'u', desc: 'Update repository or TDI submodule', conflicts: ['i', 'r', 'c']},
+        branch: {alias: 'b', desc: 'Pass tdi release branch, e.g. "5.4"', conflicts: ['i', 'r', 'c']}
       },
       handler: require('./modules/git')
     })
@@ -111,10 +113,13 @@ module.exports = function cli () {
     .example([
       ['$0 deploy --copy --server demo', 'Copy files to server "demo"'],
       ['$0 d -c -s demo', 'Same as above'],
-      ['$0 f -sb && $0 d -c', 'Compile schema and build Fonto, then deploy to default server']
+      ['$0 f -sb && $0 d -c', 'Compile schema and build Fonto, then deploy to default server'],
+      ['$0 git --update', 'Pull git repository and submodule to latest repository commit'],
+      ['$0 git --update tdi', 'Update TDI submodule to latest within current TDI branch'],
+      ['$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'].includes(k)); // also filter options with defaults
+      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;

package/src/lib/exec-git-command.js

@@ -1,14 +1,15 @@
 const {spawnSync} = require('child_process');
 
 
-module.exports = function execGitCommand(args, path, returnProperties = [], expectedStatus) {
+module.exports = function execGitCommand(args, path, returnProperties, expectedStatus) {
 
   const cmd = spawnSync('git', [args], {cwd: path, shell: true});
 
+  if (cmd.status !== 0) return {error: `${cmd.stderr}`};
   if (expectedStatus!=undefined) return cmd.status == expectedStatus;
 
   let retObj = (cmd.stdout||'').toString().trim().split(';');
-  if (returnProperties[0]) {
+  if (returnProperties?.[0]) {
     const o = {};
     retObj = (
       retObj.forEach((v, i) => {
@@ -21,6 +22,6 @@ module.exports = function execGitCommand(args, path, returnProperties = [], expe
       o
     );
   }
-  return retObj.length==1 ? retObj[0] : retObj;
+  return retObj.length === 1 ? retObj[0] : retObj;
 
 };

package/src/lib/get-repoconfig.js

@@ -16,7 +16,7 @@ module.exports = function getRepoconfig() {
       const ntName        = ntSqlInsert.match(/'([^']+)' name/)[1];
       const xpiDir        = ntSqlInsert.match(/'([^']+)' xsl_prep_inc/)[1];
 
-      const path_cmscustom  = xpiDir.replace(/\/[^/]+$/, '').split(/[/]/);
+      const path_cmscustom  = xpiDir.replace(/\/[^/]+$/, '').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

@@ -0,0 +1,46 @@
+const execGitCommand = require('./exec-git-command');
+const path           = require('path');
+
+module.exports = function getTdiBranch(toBranchName) {
+  const tdiBranch = {};
+  let toBranch;
+  if (toBranchName) {
+    // Check if specified branch exists; we will update to this branch
+    toBranch = String(toBranchName).replace(/(?:release\/)?(\d+(?:\.[\dx]+)*)/, `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 the current TDI branch:
+
+  // 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}`);
+
+  // 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-resolve-includes.js

@@ -15,8 +15,8 @@ const resolveImports = (fp, file) => {
         fs.readFileSync(xiPath).toString()
           .replace(/[\s\S]*?<x:config[^>]*>([\s\S]*?)<\/x:config>/, '$1')                 // only return contents of x:config element
           .replace(/<(\w+)\/>/g, '<$1></$1>')                                             // self-closing html tags can cause problems
-          .replace(/url="(\.\.\/)+pls\//g, 'url="#{plsservlet}')                          // replace relative references to plsservlet by bind (4.1 compatibility)
-          .replace(/url="(\.\.\/)+/g, 'url="#{cmspath}')                                  // replace relative references to cmspath by bind (4.1 compatibility)
+          .replace(/url="(?:\.\.\/)+pls\//g, 'url="#{plsservlet}')                        // replace relative references to plsservlet by bind (4.1 compatibility)
+          .replace(/url="(?:\.\.\/)+/g, 'url="#{cmspath}')                                // replace relative references to cmspath by bind (4.1 compatibility)
           .replace(/(<x:javascript\s+src=")([^#].*?)("\s*\/>)/g, (match, g1, g2, g3) => { // correct all javascript refs to paths relative to cmscustompath bind
             const newPath = path.resolve(fp.dir, path.resolve(path.dirname(xiPath), g2))
               .replace(/.*cmscustom./, '#{cmscustompath}')
@@ -54,6 +54,7 @@ const resolveIncludes = (fp, file) => {
       }
       catch (e) {
         console.log('Illegal reference to path: '.red + e.path);
+        return match;
       }
     });
   }

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/package-update-check.js

@@ -2,18 +2,19 @@ const {compare}   = require('compare-versions');
 const exec        = require('util').promisify(require('child_process').exec);
 
 
-const doUpdateCheck = (package) => (
-  exec(`npm view -g ${_packages[package].name} version`)
+const doUpdateCheck = (pkg) => (
+  exec(`npm view -g ${_packages[pkg].name} version`)
     .then(r => {
       const versionAvailable = r.stdout.match(/([\d/.]+)/)[1];
-      if (!_packages[package].version) _warn(`${package} is not installed! Run ` + `npm i -g ${_packages[package].name}`.white);
-      else if (compare(_packages[package].version, versionAvailable, '<')) {
-        _appdata._update({[`updateCheck${package}`]: {executed: new Date(), versionAvailable}});
+      if (!_packages[pkg].version) _warn(`${pkg} is not installed! Run ` + `npm i -g ${_packages[pkg].name}`.white);
+      else if (compare(_packages[pkg].version, versionAvailable, '<')) {
+        _appdata._update({[`updateCheck${pkg}`]: {executed: new Date(), versionAvailable}});
         return versionAvailable;
       }
-      else _appdata._update({[`updateCheck${package}`]: {executed: new Date()}});
+      else _appdata._update({[`updateCheck${pkg}`]: {executed: new Date()}});
+      return;
     })
-    .catch(e => _warn(`Failed checking latest version of ${package}.`))
+    .catch(() => _warn(`Failed checking latest version of ${pkg}.`))
 );
 
 let checkUpdatesDone = false;
@@ -23,16 +24,16 @@ module.exports = function packageUpdateCheck () {
   if (!checkUpdatesDone) { // check if updatecheck has ran before because async calls below trigger beforeExit again
     checkUpdatesDone = true;
 
-    ['TCT'].forEach(p => {
-      const updateMsg = (va) => `| Update ${p} to ${va} | ` + `npm i -g ${_packages[p].name}`.white;
-      const {versionAvailable} = _appdata[`updateCheck${p}`] || {};
+    ['TCT'].forEach(pkg => {
+      const updateMsg = (va) => `| Update ${pkg} to ${va} | ` + `npm i -g ${_packages[pkg].name}`.white;
+      const {versionAvailable} = _appdata[`updateCheck${pkg}`] || {};
 
-      if (new Date() - new Date(_appdata[`updateCheck${p}`]?.executed || 0) > 1000*3600*24*7) { // check every week
-        doUpdateCheck(p).then(r => r && _warn(updateMsg(r)));
+      if (new Date() - new Date(_appdata[`updateCheck${pkg}`]?.executed || 0) > 1000*3600*24*7) { // check every week
+        doUpdateCheck(pkg).then(r => r && _warn(updateMsg(r)));
       }
       else if (versionAvailable) {
-        if (compare(_packages[p].version, versionAvailable, '<')) _warn(updateMsg(versionAvailable));
-        else _appdata._update({[`updateCheck${p}`]: {executed: new Date()}});
+        if (compare(_packages[pkg].version, versionAvailable, '<')) _warn(updateMsg(versionAvailable));
+        else _appdata._update({[`updateCheck${pkg}`]: {executed: new Date()}});
       }
     });
   }

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

@@ -9,5 +9,5 @@ for (const name in styles ) {
 }
 
 String.prototype.__defineGetter__('nostyle', function () {
-  return this.replace(/[\u001b\u009b][[()#;?]*(?:[0-9]{1,4}(?:;[0-9]{0,4})*)?[0-9A-ORZcf-nqry=><]/g, '');
+  return this.replace(/[\u001b\u009b][[()#;?]*(?:\d{1,4}(?:;\d{0,4})*)?[0-9A-ORZcf-nqry=><]/g, '');
 });

package/src/modules/build/index.js

@@ -9,7 +9,7 @@ const createSymlink = (t, p) => {
   fs.symlink(path.join(up, _paths.tdi, t), p, 'dir', err => {
     if (err) {
       if (err.code=='EEXIST') _write(`Symlink already exists: ${p}`);
-      else _error((err.code=='EPERM' ? 'Start your console as admin for symlink creation!' : err));
+      else _error((err.code!=='EPERM' ? err : `Can't create symlinks, restart your console as admin, or fix it permanently:\n  1. Open 'Local Security Policy' (secpol.msc)\n  2. Go to 'Security Settings > Local Policies > User Rights Assignment > Create symbolic links'\n  3. Add your own account\n  4. Restart Windows`));
     }
     else _write(`Symlink created: ${p}`);
   });