@tangelo/tangelo-configuration-toolkit 1.18.0 → 1.19.0

package/index.js

@@ -1,10 +1,7 @@
 global._appStartTime = new Date();
 
-require('./src/lib/style-string-getters');
-
-String.prototype.toFws = function(){
-  return this.replace(/\\/g, '/');
-};
+require('./src/lib/set-string-getters.js');
+require('./src/lib/set-global-functions.js');
 
 
 const {execSync}  = require('child_process');
@@ -17,51 +14,12 @@ const execGitCommand = require('./src/lib/exec-git-command');
 const memoize = require('./src/lib/memoize');
 
 
-const appname = 'tangelo-configuration-toolkit';
-
-
-global._write = (...msg) => {
-  msg = msg.map(m => typeof m == 'object' ? JSON.stringify(m, null, 2).cyan : m);
-  console.log(msg.join(' ').replace(/^/gm, '  ')); // indent each line
-};
-
-global._info = (msg, time = false) => {
-  if (time) {
-    const tzDiff  = new Date().getTimezoneOffset() * 60000;
-    const time    = new Date(Date.now() - tzDiff).toISOString().match(/\d\d:\d\d:\d\d/)[0];
-    msg = `[${time}] ${msg}`;
-  }
-  console.log(msg.lgreen);
-};
-
-global._warn = msg => {
-  console.log(msg.lyellow);
-};
-
-global._error = msg => {
-  console.log(msg.red, '\n');
-  process.exit();
-};
-
-global._perf = t1 => {
-  const t2 = new Date();
-  console.log(`\nExecution time: ${t2 - t1}ms`.blue);
-};
-
-global._formatDate = date =>
-  date?.toLocaleDateString('en-gb', {day: 'numeric', month: 'short', year: 'numeric', hour: '2-digit', minute: '2-digit'})
-;
+global._package = require('./package.json');
 
 
 global._devmode = !__dirname.includes('node_modules');
 
 
-global._packages = {
-  TCT: {name: '@tangelo/tangelo-configuration-toolkit', version: require('./package.json')?.version},
-  FDT: {name: '@fontoxml/fontoxml-development-tools'}
-};
-
-
 global._paths = {
   app: __dirname,
   apphome: path.join(homedir, '.tct'),
@@ -71,8 +29,7 @@ global._paths = {
 };
 _paths.appdata = path.join(_paths.apphome, 'appdata.json');
 _paths.appconfig = path.join(_paths.apphome, 'appconfig.json');
-_paths.repoconfig = path.join(_paths.repo, appname+'-repoconfig.json');
-_paths.apply = process.cwd().replace(_paths.repo, '').substr(1);
+_paths.apply = process.cwd().replace(_paths.repo, '').slice(1);
 
 
 global._appdata = fs.readJsonSync(_paths.appdata, {throws: false}) || {};
@@ -105,7 +62,8 @@ catch({code, message}) {
 global._repoconfig = require('./src/lib/get-repoconfig')(_paths.repo);
 
 
-_appconfig.sharedConfigPath = path.resolve(_paths.appconfig, '..', _appconfig.sharedConfigPath || '', appname+'-appconfig.json');
+const filenameSC = _package.name.split('/').pop() + '-appconfig.json';
+_appconfig.sharedConfigPath = path.resolve(_paths.appconfig, '..', _appconfig.sharedConfigPath || '', filenameSC);
 _appconfig.shared = fs.readJsonSync(_appconfig.sharedConfigPath, {throws: false}) || {};
 
 
@@ -145,18 +103,21 @@ global._modulesTdi = {
     }
     this.depsUpToDate = true;
   },
-  require(module) {
+  require(module, {throws = true, message = true} = {}) {
     if (path.extname(module) !== '.json') this.ensureDepsUpToDate();
-    _info(`Loading ${path.join(_paths.tdi, 'tct', module)}\n`);
+    if (message) _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');
+      if (throws) _error('Module could not be loaded: ' + module);
+      else return undefined;
     }
   }
 };
 
+global._settingsTdi = memoize(() => Object.assign(_package.settingsTdiDefault, _modulesTdi.require('settings.json', {throws: false, message: false}) ?? {}));
+
 
 process.on('beforeExit', () => {
   _write(); // print empty line before and after update check

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tangelo/tangelo-configuration-toolkit",
-  "version": "1.18.0",
+  "version": "1.19.0",
   "engines": {
     "node": ">=14.0.0"
   },
@@ -56,5 +56,9 @@
     "type": "git",
     "url": "git+ssh://git@bitbucket.org/tangelosoftware/tangelo-configuration-toolkit.git"
   },
-  "homepage": "https://bitbucket.org/tangelosoftware/tangelo-configuration-toolkit#readme"
+  "homepage": "https://bitbucket.org/tangelosoftware/tangelo-configuration-toolkit#readme",
+  "settingsTdiDefault": {
+    "#": "Defaults for tangelo-default-implementation/tct/settings.json",
+    "transpileToES5": true
+  }
 }

package/src/cli.js

@@ -6,7 +6,7 @@ module.exports = function cli () {
   _write();
 
   const txtTitle    = 'Tangelo Configuration Toolkit'.bold.underline.cyan;
-  const txtVersion  = `v${_packages.TCT.version}`.lblack;
+  const txtVersion  = `v${_package.version}`.lblack;
 
   yargs
     .scriptName('tct')
@@ -77,7 +77,7 @@ module.exports = function cli () {
         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']},
-        dates: {alias: 'd', desc: '[hidden] Use i.c.w. update-submodule, pass 2 dates in format dd-mm-yyyy', conflicts: ['i', 'r', 'c'], implies: 'update-submodule', requiresArg: true, array: true, hidden: !_devmode}
+        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/gulp-sftp.js

@@ -16,7 +16,7 @@ module.exports = function(ftpConfig, remotedir) {
       if (file.isStream()) return cb(new Error('Streaming not supported.'));
       if (file.stat.isDirectory()) return cb();
 
-      file.destination = path.join(remotedir, file.relative).toFws();
+      file.destination = path.join(remotedir, file.relative).toFws;
       files.push(file); // collect all files in array
       return cb();
     },

package/src/lib/package-update-check.js

@@ -2,12 +2,14 @@ const {compare}   = require('compare-versions');
 const exec        = require('util').promisify(require('child_process').exec);
 
 
+const packages = {TCT: _package};
+
 const doUpdateCheck = (pkg) => (
-  exec(`npm view -g ${_packages[pkg].name} version`)
+  exec(`npm view -g ${packages[pkg].name} version`)
     .then(r => {
       const versionAvailable = r.stdout.match(/([\d/.]+)/)[1];
-      if (!_packages[pkg].version) _warn(`${pkg} is not installed! Run ` + `npm i -g ${_packages[pkg].name}`.white);
-      else if (compare(_packages[pkg].version, 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;
       }
@@ -25,14 +27,14 @@ module.exports = function packageUpdateCheck () {
     checkUpdatesDone = true;
 
     ['TCT'].forEach(pkg => {
-      const updateMsg = (va) => `| Update ${pkg} to ${va} | ` + `npm i -g ${_packages[pkg].name}`.white;
+      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${pkg}`]?.executed || 0) > 1000*3600*24*1) { // check every day
         doUpdateCheck(pkg).then(r => r && _warn(updateMsg(r)));
       }
       else if (versionAvailable) {
-        if (compare(_packages[pkg].version, versionAvailable, '<')) _warn(updateMsg(versionAvailable));
+        if (compare(packages[pkg].version, versionAvailable, '<')) _warn(updateMsg(versionAvailable));
         else _appdata._update({[`updateCheck${pkg}`]: {executed: new Date()}});
       }
     });

package/src/lib/set-global-functions.js

@@ -0,0 +1,24 @@
+global._write = (...msg) => {
+  msg = msg.map(m => typeof m == 'object' ? JSON.stringify(m, null, 2).cyan : m);
+  console.log(msg.join(' ').replace(/^/gm, '  ')); // indent each line
+};
+global._info = (msg, time = false) => {
+  if (time) {
+    const tzDiff = new Date().getTimezoneOffset() * 60000;
+    const time = new Date(Date.now() - tzDiff).toISOString().match(/\d\d:\d\d:\d\d/)[0];
+    msg = `[${time}] ${msg}`;
+  }
+  console.log(msg.lgreen);
+};
+global._warn = msg => {
+  console.log(msg.lyellow);
+};
+global._error = msg => {
+  console.log(msg.red, '\n');
+  process.exit();
+};
+global._perf = t1 => {
+  const t2 = new Date();
+  console.log(`\nExecution time: ${t2 - t1}ms`.blue);
+};
+global._formatDate = date => date?.toLocaleDateString('en-gb', {day: 'numeric', month: 'short', year: 'numeric', hour: '2-digit', minute: '2-digit'});

package/src/lib/{style-string-getters.js → set-string-getters.js}

@@ -15,4 +15,10 @@ Object.defineProperty(String.prototype, 'nostyle', {
   get () {
     return this.replace(/[\u001b\u009b][[()#;?]*(?:\d{1,4}(?:;\d{0,4})*)?[0-9A-ORZcf-nqry=><]/g, '');
   }
+});
+
+Object.defineProperty(String.prototype, 'toFws', {
+  get () {
+    return this.replace(/\\/g, '/');
+  }
 });

package/src/modules/deploy/config.js

@@ -5,7 +5,7 @@ const path      = require('path');
 
 function getRemotePath (...arr) {
   const fp = path.join(this.server.remotedir, ...arr);
-  return this.server.remotedir.includes(':') ? fp : fp.toFws();
+  return this.server.remotedir.includes(':') ? fp : fp.toFws;
 }
 
 
@@ -82,7 +82,7 @@ function prepareForCopy (filter) {
       .map(p => '!' + (p.match(/^config/) ? p : '**/' + p.split('**/').pop()) + (p.match(/\/$/) ? '**' : '')) // negate expressions, remove base dir, suffix folders with **
   ;
 
-  let transferPattern = path.join(_paths.apply, filter).toFws();
+  let transferPattern = path.join(_paths.apply, filter).toFws;
 
   // test if 'cmscustom/tdi' would be included, then add specifically, because following symlinks doesnt work with glob stars
   const tdiIncRegex = /^(config\/)?((\{\w*,?)?cmscustom(,?\w*\})?\/|\*\/)?\*\*/;

package/src/modules/deploy/execute.js

@@ -120,9 +120,10 @@ const createDeliveryPack = () => { // create install scripts if necessary, zip o
 
 
 const transfer = (paths, lrServer) => {
+  const jsFGlob = _settingsTdi().transpileToES5 ? ['**/*.js', '!**/hce/**/template_*', '!**/fonto/**', '!**/vendor/**', '!**/*.min.js'] : [];
+  const jsF     = g_filter(jsFGlob, {restore: true});
   const xpsF    = g_filter(['**/xopus/**/*.x*'], {restore: true});
   const sassF   = g_filter(['**/*.scss'], {restore: true});
-  const jsF     = g_filter(['**/*.js', '!**/hce/**/template_*', '!**/fonto/**', '!**/vendor/**', '!**/*.min.js'], {restore: true});
   const shF     = g_filter(['**/*.sh'], {restore: true});
   const srcset  = s.create(paths);
   const files   = [];

package/src/modules/deploy/index.js

@@ -77,7 +77,7 @@ module.exports = function deploy (argv) {
         // the "dist" folder isn't watched properly: it does not detect "assets" anymore after building once
           !/cmscustom.+fonto[\\/]/.test(filepath) ||
             /fonto[\\/]dist[\\/]/.test(filepath) ||
-            (/fonto[\\/]dev[\\/]/.test(filepath)) ||
+            (/fonto[\\/]dev[\\/]/.test(filepath) && c.envDev) ||
             /fonto[\\/]packages[\\/]sx-shell-.*?[\\/]assets[\\/]schemas[\\/]/.test(filepath)
         )
         ) {

package/src/modules/deploy/srcset.js

@@ -3,7 +3,7 @@ const globby  = require('globby');
 const path    = require('path');
 
 
-const relPath     = (d, p) => path.relative(d, p).toFws();
+const relPath     = (d, p) => path.relative(d, p).toFws;
 const resolveBind = (d, p) => p.replace('#{cmscustompath}', 'cmscustom/').replace('{$rsrcPath}', (d.replace('stylesheets', 'resources')+'/'));
 
 
@@ -98,11 +98,11 @@ module.exports = {
   },
 
   addToCache (filepath) {
-    if (this.potentialBaseFilesCache) this.potentialBaseFilesCache.push(filepath.toFws());
+    if (this.potentialBaseFilesCache) this.potentialBaseFilesCache.push(filepath.toFws);
   },
 
   removeFromCache (filepath) {
-    if (this.potentialBaseFilesCache) this.potentialBaseFilesCache = this.potentialBaseFilesCache.filter(fp => fp != filepath.toFws());
+    if (this.potentialBaseFilesCache) this.potentialBaseFilesCache = this.potentialBaseFilesCache.filter(fp => fp != filepath.toFws);
   }
 
 };

package/src/modules/fonto/index.js

@@ -5,23 +5,25 @@ const globby      = require('globby');
 const path        = require('path');
 
 
-const fdtCommand = fv => `npx -y ${_packages.FDT.name}@${fv.replace(/^(7\.|8\.[012]\.).*/, '3.12.0')}`;
+const fdtPackage = '@fontoxml/fontoxml-development-tools';
+const fdtCommand = fv => `npx -y ${fdtPackage}@${fv.replace(/^(7\.|8\.[012]\.).*/, '3.12.0')}`;
 
 module.exports = function fonto (argv) {
 
   const allowedFontoVersionRegex = (() => {
-    const cvRegex = _modulesTdi.require('fonto/compatibleVersions.json')?.regex;
+    const cvRegex = _settingsTdi().compatibleFontoVersions ?? _modulesTdi.require('fonto/compatibleVersions.json', {throws: false})?.regex;
     if (cvRegex) return RegExp(cvRegex);
 
     // old way: a regex for each basecommit is stored in global._git.commitTdi
+    _info('Fallback to list of commits for determining compatible Fonto versions\n');
     for (const fv of _git.commitTdi.fontoVersions) {
       if (_git.commitTdi.after(fv.commitHash)) return fv.regex;
     }
   })();
 
   // check if FDT is not installed globally, because then it won't be possible to use specific versions with npx
-  if (fs.pathExistsSync(path.join(_appdata.npmPath, 'node_modules', _packages.FDT.name))) {
-    _error(`A global installation of FDT has been found! Remove it first.\nExecute: npm r -g ${_packages.FDT.name}`);
+  if (fs.pathExistsSync(path.join(_appdata.npmPath, 'node_modules', fdtPackage))) {
+    _error(`A global installation of FDT has been found! Remove it first.\nExecute: npm r -g ${fdtPackage}`);
   }
 
   process.chdir(_paths.apply || '.');
@@ -50,7 +52,7 @@ module.exports = function fonto (argv) {
 
           if (fontoVersionNew === 'latest') {
             const data = execSync(`${fdtCommand(fontoVersionCurrent)} editor versions`, {encoding: 'UTF-8'});
-            fontoVersionNew = data.match(/\d+\.\d+\.\d+/g).filter(v => allowedFontoVersionRegex.test(v))[0];
+            fontoVersionNew = data.match(/\d+\.\d+\.\d+/g).find(v => allowedFontoVersionRegex.test(v));
           }
           else if (!allowedFontoVersionRegex.test(fontoVersionNew)) {
             _error(`Fonto version ${fontoVersionNew} is not compatible with the current TDI submodule commit!\nExecute: ${'tct fonto --init latest'.cyan}`);

package/src/modules/git/index.js

@@ -123,6 +123,7 @@ function updateRepo () {
   const fontoLocations = globby.sync('*/*/fonto/manifest.json', {cwd: path.join(_paths.repo, 'config/cmscustom')});
   const fontoVersions = {};
   fontoLocations.forEach(p => {fontoVersions[p] = readFontoVersionFromFile(p);});
+  const tdiLogBeforeUpdate = _git.commitTdi.local();
 
   _info(`Fetch all`);
   const cmdFetch = execGitCommand('fetch -pf --all', _paths.repo);
@@ -138,11 +139,24 @@ function updateRepo () {
 
   if (fontoLocations.find(p => fontoVersions[p] !== readFontoVersionFromFile(p))) _warn(`\nChanges in Fonto instance versions have been pulled. Therefore you must execute ${'tct fonto --init'.cyan} before building and deploying Fonto.`);
 
-  _info(`\nRetrieve submodules that belong to this repo-commit`); // update submodule recursively (set to version that belongs to repo)
-  _write(execGitCommand(`submodule update --recursive`, _paths.repo));
-  _info(`Submodule checked out at commit:`);
+  // update submodule recursively (set to version that belongs to repo)
+  execGitCommand(`submodule update --recursive`, _paths.repo);
+
+  // clear memoize cache; which is filled with the old TDI data due to tdiLogBeforeUpdate
+  _git.commitTdi.local.clear();
   const tdiLog = _git.commitTdi.local();
-  _write([_formatDate(tdiLog.date), tdiLog.tags, tdiLog.hash].filter(v=>v).join(' - '));
+
+  _info(`\nTDI submodule:`);
+  _write(`Submodule in repo-commit: ${[_formatDate(tdiLog.date), tdiLog.tags, tdiLog.hash].filter(v=>v).join(' - ')}`);
+
+  if (tdiLog.date < tdiLogBeforeUpdate.date) {
+    _write(`Restore TDI submodule because it was newer before the repository update:`);
+    execGitCommand(`checkout ${tdiLogBeforeUpdate.hash}`, path.join(_paths.repo, _paths.tdi));
+    _write(`Submodule checked out: ${[_formatDate(tdiLogBeforeUpdate.date), tdiLogBeforeUpdate.tags, tdiLogBeforeUpdate.hash].filter(v=>v).join(' - ')}\n`);
+  }
+  else {
+    _write(`Submodule in repo-commit is checked out\n`);
+  }
 
   const tdiBranch = getTdiBranch();
   _info(`\nTDI branch ${tdiBranch.name} is ${tdiBranch.commitsBehind} commits behind.\nUpdate TDI submodule to latest version with ${'tct git --update-submodule'.cyan}`);

package/src/modules/migrate/index.js

@@ -51,7 +51,7 @@ module.exports = function migrate (argv) {
         a.script = cmdlScript.value;
       }
 
-      let filter = path.join(_paths.apply, argv.filter??'**').toFws(); // Default set filter with filter added to the command argument -f
+      let filter = path.join(_paths.apply, argv.filter??'**').toFws; // Default set filter with filter added to the command argument -f
 
       if (a.filter === 'projects' && _repoconfig.length > a.projects.length) {
       // push paths of chosen active documents to projectFolders (only if not all projects are chosen)

package/src/modules/sql/index.js

@@ -61,10 +61,7 @@ module.exports = function sql (argv) {
         .prompt([
           {
             message: 'Choose projects: ', name: 'projects', type: 'checkbox', validate: v => !!v[0],
-            choices:
-            _repoconfig.projects
-              ? _repoconfig.projects.map(p => ({name: p.name, value: p})) // when using repoconfig file (old)
-              : _repoconfig.map(p => ({name: `${p.customer_name} ${p.project_name}`, value: p}))
+            choices: _repoconfig.map(p => ({name: `${p.customer_name} ${p.project_name}`, value: p}))
           },
           {message: 'Database TNS name: ', name: 'db', default: _appconfig.defaultDatabase},
           {message: 'TANCMS password: ', name: 'pw', default: 'tancms'}