@tangelo/tangelo-configuration-toolkit 1.12.0 → 1.13.0

package/index.js

@@ -72,7 +72,7 @@ try { global._appconfig = _paths.appconfig && fs.readJsonSync(_paths.appconfig)
 catch({message}) { _error('Error in '+message); }
 
 _appconfig.sharedConfigPath = path.resolve(_paths.appconfig || '', '..', _appconfig.sharedConfigPath || '', appname+'-appconfig.json');
-_appconfig.shared           = fs.readJsonSync(_appconfig.sharedConfigPath, {throws: false}) || {};
+_appconfig.shared = fs.readJsonSync(_appconfig.sharedConfigPath, {throws: false}) || {};
 
 
 global._git = {
@@ -81,22 +81,21 @@ global._git = {
     return _appdata.gitUser;
   },
   commitLocal () {
-    return this.cache = this.cache ||
-      execGitCommand(`log -1 --format=%D;%H;%cd --date=iso-strict`, _paths.repo, ['branch', 'hash', 'date']);
+    this.cache ??= execGitCommand(`log -1 --format=%D;%H;%cd --date=iso-strict`, _paths.repo, ['branch', 'hash', 'date']);
+    return this.cache;
   },
   commitRemote () {
-    return this.cache = this.cache ||
-      execGitCommand('log -1 --format=%cd --date=iso-strict origin/'+_git.commitLocal().branch, _paths.repo, ['date']);
+    this.cache ??= execGitCommand('log -1 --format=%cd --date=iso-strict origin/'+_git.commitLocal().branch, _paths.repo, ['date']);
+    return this.cache;
   },
   commitTdi: {
     local () {
-      return this.cache = this.cache ||
-        execGitCommand(`log -1 --format=%D;%H;%cd --date=iso-strict`, path.join(_paths.repo, _paths.tdi), ['tags', 'hash', 'date']);
+      this.cache ??= execGitCommand(`log -1 --format=%D;%H;%cd --date=iso-strict`, path.join(_paths.repo, _paths.tdi), ['tags', 'hash', 'date']);
+      return this.cache;
     },
     after (commitHash) {
-      if (this['cache-'+commitHash] != undefined) return this['cache-'+commitHash];
-      return this['cache-'+commitHash] =
-        execGitCommand(`merge-base --is-ancestor ${commitHash} ${_git.commitTdi.local().hash}`, path.join(_paths.repo, _paths.tdi), null, 0);
+      this['cache-'+commitHash] ??= execGitCommand(`merge-base --is-ancestor ${commitHash} ${_git.commitTdi.local().hash}`, path.join(_paths.repo, _paths.tdi), null, 0);
+      return this['cache-'+commitHash];
     },
     fontoVersions: [ // latest commits first
       {commitHash: 'e599766', regex: /^7\.1[45]\./},
@@ -127,7 +126,6 @@ global._isPre42 = fs.existsSync(path.join(_paths.repo, _paths.tdi, 'create_new_p
 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)
 
 
-
 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.12.0",
+  "version": "1.13.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

@@ -25,7 +25,7 @@ module.exports = function cli () {
         init: {alias: 'i', desc: 'Create repository content structure', conflicts: ['p', 's', 'c']},
         project: {alias: 'p', desc: 'Create project configuration', conflicts: ['i', 's', 'c']},
         symlinks: {alias: 's', desc: 'Recreate symlinks to TDI', conflicts: ['p', 'i', 'c']},
-        config: {alias: 'c', desc: 'Create repo-config file', conflicts: ['p', 'i', 's'], hidden: _git.commitTdi.after(_git.commitTdi.stopUsingRepoconfigFile)},
+        config: {alias: 'c', desc: 'Create repo-config file', conflicts: ['p', 'i', 's'], hidden: true},
         oxygen: {alias: 'x', desc: 'Create or update oXygen project file (.xpr)', conflicts: ['p', 'i', 'c']}
       },
       handler: require('./modules/build')
@@ -92,15 +92,17 @@ module.exports = function cli () {
         remove: {alias: 'r', desc: 'Remove project configuration', conflicts: ['i', 'c', 'g']}
       },
       handler: require('./modules/sql')
-    }).command({
-      command: 'versions',
-      aliases: ['v'],
-      desc: 'Show version information',
+    })
+    .command({
+      command: 'info',
+      aliases: ['i'],
+      desc: 'Show project information',
       builder: {
-        find: {alias: 'f', desc: `Find all version information          [choices: "sort-project"(default),"sort-type"]`},
+        doctypes: {alias: 'd', desc: `List document-types information`},
+        versions: {alias: 'v', desc: `Find all version information, sorted by project or type`, choices: ['project', 'type'], conflicts: ['d']},
         server: {alias: 's', desc: 'Pass server name (set in config file)', default: _appconfig.defaultServer}
       },
-      handler: require('./modules/version')
+      handler: require('./modules/info')
     })
     .recommendCommands()
     .option('config', {alias: 'c', desc: 'Show loaded appconfig', global: false})

package/src/modules/build/index.js

@@ -18,11 +18,11 @@ const createSymlink = (t, p) => {
 const createSymlinks = () => {
   _info('Creating symlinks:');
   const src = _isPre51 ? 'sources' : 'src';
-  createSymlink(src + '/config/cmscustom/tdi', 'config/cmscustom/tdi', 'TDI');
+  createSymlink(src + '/config/cmscustom/tdi', 'config/cmscustom/tdi');
   globby
     .sync('config/cmscustom/!(tdi)/**/fonto')
     .forEach(p => {
-      createSymlink(src + '/config/cmscustom/tdi/fonto/packages-shared', p + '/packages-shared', 'Fonto');
+      createSymlink(src + '/config/cmscustom/tdi/fonto/packages-shared', p + '/packages-shared');
     });
 };
 
@@ -109,7 +109,6 @@ module.exports = function build (argv) {
         _repoconfig.update({customer, projects, applink: 'None'});
 
         _write(`\nFile '${_paths.repoconfig}' has been created.`);
-        _repoconfig.projects;
       });
   }
 

package/src/modules/build/oxygen.js

@@ -11,6 +11,8 @@ const siteStylesheetsPath = 'config/txp/site-stylesheets/';
 const masterFiles = new Set;
 const transformationScenarios = [];
 
+const convertToValidFilename = (string) => string.replace(/[\/|\\:*?"<>]/g, " ");
+
 const createProjectFile = (config) => {
   _info('Initializing xpr file(s):');
   const xprFiles = globby.sync(`*.xpr`);
@@ -20,7 +22,7 @@ const createProjectFile = (config) => {
   else {
     const customers = new Set;
     _repoconfig.forEach(p => customers.add(p.customer_name));
-    xprFiles.push([...customers].join(' - ') + '.xpr');
+    xprFiles.push(convertToValidFilename([...customers].join(' - ')) + '.xpr');
     fs.copySync(path.join(_paths.repo, 'tangelo-default-implementation/src/[customer].xpr'), path.join(_paths.repo, xprFiles[0]));
     _write(`Created: '${xprFiles[0]}'`);
   }

package/src/modules/deploy/config.js

@@ -84,7 +84,7 @@ module.exports = {
         .trim()
         .replace(/^#.+/gm, '') // remove comments
         .split(/\s+/) // split on lines
-        .filter(p => !p.match(/^database\/|\/tdi|\/fonto/)) // filter paths that should be copied
+        .filter(p => !p.match(/(^database\/)|(\/tdi)|(\/fonto)/)) // filter paths that should be copied
         .map(p => '!' + (p.match(/^config/) ? p : '**/' + p.split('**/').pop()) + (p.match(/\/$/) ? '**' : '')) // negate expressions, remove base dir, suffix folders with **
     ;
 
@@ -110,7 +110,7 @@ module.exports = {
     if (this.deliveryPack && transferPattern.includes(_paths.tdi)) this.transferPatterns.push(`${_paths.tdi}/src/database/create*.sql`); // create(_exists).sql is called by tdi install
 
     // add time parameters to all xopus requests to overcome cache
-    const ts = new Date().toISOString().replace(/-|:/g, '').substring(0, 15);
+    const ts = new Date().toISOString().replace(/[-:]/g, '').substring(0, 15);
     this.replaceStrings = [
       [/((xsd|xsl|src|iconsrc)="[^"?]+)"/g, `$1?_=${ts}"`, '**/xopus/xml/*'],
       [/(schemaLocation="[^"?]+)"/g, `$1?_=${ts}"`, '**/xopus/xsd/*'],

package/src/modules/fonto/commands.js

@@ -127,7 +127,7 @@ module.exports = {
       const schemasPerElement = {};
       Object.entries(rootSchemas).forEach(([path, obj]) => {
         const data            = execSync(`${fdt} elements --schema packages/${obj.packageName}/src/assets/schemas/${obj.packageName}.json -C name`, {encoding: 'UTF-8'});
-        const elements        = data.replace(/^.*?Name\*|Printed name\*.*$/gs, '').split(/\s+/);
+        const elements        = data.replace(/(^.*?Name\*)|(Printed name\*.*$)/gs, '').split(/\s+/);
         const customElements  = [...new Set(elements)].filter(e => e && !ignoreElements.includes(e));
 
         customElements.forEach(e => {
@@ -176,7 +176,7 @@ module.exports = {
       const schemasPerAttribute = {};
       Object.entries(rootSchemas).forEach(([path, obj]) => {
         const data              = execSync(`${fdt} attributes --schema packages/${obj.packageName}/src/assets/schemas/${obj.packageName}.json`, {encoding: 'UTF-8'});
-        const attributes        = data.replace(/^.*?Default value\s+|\s+Printed name\*.*$/gs, '').split(/\n\s+/).map(a => a.split(/\s+/)).map(a =>
+        const attributes        = data.replace(/(^.*?Default value\s+)|(\s+Printed name\*.*$)/gs, '').split(/\n\s+/).map(a => a.split(/\s+/)).map(a =>
           a[0] + (a[2]=='required' ? ' (required)' : '') + (a[3]=='-' ? ' (no default)' : '')
         );
         const customAttributes  = [...new Set(attributes)].filter(e => e && !ignoreAttributes.includes(e.replace(/ .*/, '')));

package/src/modules/fonto/index.js

@@ -5,7 +5,7 @@ const globby      = require('globby');
 const path        = require('path');
 
 
-const fdtCommand = (fv) => `npx -y ${_packages.FDT.name}@${fv.replace(/^(7\.|8\.[12]\.).*/, '3.12.0')}`;
+const fdtCommand = (fv) => `npx -y ${_packages.FDT.name}@${fv.replace(/^(7\.|8\.[012]\.).*/, '3.12.0')}`;
 
 module.exports = function fonto (argv) {
 
@@ -29,7 +29,7 @@ module.exports = function fonto (argv) {
   process.chdir(_paths.apply || '.');
 
   // find fonto instances by searching for fonto/manifest.json files
-  const fontoPaths = globby.sync(['**/fonto/manifest.json', `!${_paths.tdi}/**`])
+  const fontoPaths = globby.sync(['**/fonto/manifest.json', 'manifest.json', `!${_paths.tdi}/**`])
     .map(p => ([p.replace('manifest.json', ''), fs.readJsonSync(p).sdkVersion.replace(/Nightlies.*/, 'nightly')])
   );
 

package/src/modules/{version → info}/index.js

@@ -1,14 +1,15 @@
-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 c                    = require('../deploy/config');
-const {remote}             = require('../deploy/execute');
+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 c               = require('../deploy/config');
+const {remote}        = require('../deploy/execute');
+
 
 const getGitInfo = () => {
   // Version info TDI submodule
-  const branchInfo = [];
   const gitSubmoduleInfo = new Table({
     columns: [
       {name: 'property', title: 'TDI - submodule', alignment: 'left'},
@@ -21,18 +22,12 @@ const getGitInfo = () => {
 
   // Get branches containing TDI HEAD commit
   const releaseBranches = execGitCommand(`branch --all --contains ${_git.commitTdi.local().hash}`, path.join(_paths.repo, _paths.tdi)).match(/release\/[^\s]+/gsm);
-  if (releaseBranches) {
-    releaseBranches.forEach(b => {
-      // Get number of commits behind
-      const count = execGitCommand(`rev-list HEAD...origin/${b} --count`, path.join(_paths.repo, _paths.tdi));
-      // _info(`debug: [${b}]:${count}`);
-      // Push number of commits behind to branchInfo
-      branchInfo.push({name: b, commitsBehind: count});
-    });
-  }
-
+  if (!releaseBranches) _error('Could not retrieve TDI release branches');
   // Get the first possible branch; prefer release/5.1 over release/5.2:
-  const firstBranch = branchInfo.sort((a, b) => a.name > b.name ? 1 : -1)[0];
+  releaseBranches.sort((a, b) => a.name > b.name ? 1 : -1);
+  const firstBranch = {name: releaseBranches[0]};
+  // Get number of commits behind
+  firstBranch.commitsBehind = execGitCommand(`rev-list HEAD...origin/${firstBranch.name} --count`, path.join(_paths.repo, _paths.tdi));
 
   // Create table rows for TDI submodule info
   gitSubmoduleInfo.addRow({
@@ -59,9 +54,8 @@ const getGitInfo = () => {
   gitSubmoduleInfo.printTable();
 };
 
-const getFileExtractInfo = (argv) => {
+const getFileExtractInfo = (sorting) => {
   // version info miscellaneous
-  const sorting = argv.find.toString().includes('sort-type') ? 'type' : 'project';
   const projects = new Set;
   const types = new Set;
   const versionInfoConfigPath  = path.join(_paths.repo, _paths.tdi, 'tct/version/versionInfo.js');
@@ -86,8 +80,8 @@ const getFileExtractInfo = (argv) => {
         .sync(location)
         .forEach(f => {
           const filePathExtract = f.match(/.*(?<path>(cmscustom|site-stylesheets)\/(?<customer>[^/]*)\/(?<project>[^/]*)\/.*)/);
-          const path = filePathExtract.groups.path ? filePathExtract.groups.path : '';
-          const project = filePathExtract.groups.project ? filePathExtract.groups.project : '';
+          const path = filePathExtract.groups.path || '';
+          const project = filePathExtract.groups.project || '';
 
           const fileContent = fs.readFileSync(f).toString();
           v.extracts.forEach(e => {
@@ -124,8 +118,8 @@ const getFileExtractInfo = (argv) => {
           color: 'yellow'
         });
       });
-    } else
-    if (sorting=='type') {
+    }
+    else if (sorting=='type') {
       types.forEach(t => {
         versionInfo.addRow({ // Add empty row after type
           path: '',
@@ -136,30 +130,73 @@ const getFileExtractInfo = (argv) => {
       });
     }
     versionInfo.printTable();
-  } else {
+  }
+  else {
     _warn('Version info of miscellaneous items cannot be extracted:\nCannot find required files in TDI submodule. Try updating TDI submodule.');
   }
 };
 
-const getServerInfo = (argv) => {
+const getServerInfo = (server) => {
   // Remote server info
   // common setup
   _write();
-  c.setServer(argv.server);
+  c.setServer(server);
 
   if (!c.envDev) {
     _info(`Remote version info for '${c.server.ftpConfig.host}':\n`);
     remote.add('sudo ~root/scripts/version.sh', '').process();
-  } else {
+  }
+  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 version (argv) {
-  _info('Version information of this git repository\n');
 
-  getGitInfo(argv);
-  getFileExtractInfo(argv);
-  getServerInfo(argv);
+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 prPath  = ntSqlInsert.match(/'([^']+)' xsl_prep_inc/)[1].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);
+  }
+
+};

package/src/modules/migrate/steps.js

@@ -52,9 +52,10 @@ module.exports = function steps (step, dry, filter) {
       }
 
       let filesModCount = 0;
-      for (let i=0; i<20 && !dry && r.files[0]; i++) { // execute repeatedly for modified files only (with safety limit of 20)
+      for (let i=0; i<20 && 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)
+        if (dry) break;
       }
 
       _write('Files modified:', filesModCount);