@tangelo/tangelo-configuration-toolkit 1.15.1 → 1.17.0

package/README.md

@@ -26,7 +26,8 @@ Use the `tct` shorthand instead of `tangelo-configuration-toolkit`:
 
 ### 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.
+TCT requires a config file to work: `${userhome}/.tct/appconfig.json`\
+Several commands, like the `deploy` command, require server connection information, which can be stored in here.
 
 The contents looks like this (all properties are optional):
 
@@ -53,12 +54,6 @@ The contents looks like this (all properties are optional):
 
 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:

package/index.js

@@ -8,6 +8,7 @@ String.prototype.toFws = function(){
 const {execSync}  = require('child_process');
 const findUp      = require('find-up');
 const fs          = require('fs-extra');
+const homedir     = require('os').homedir();
 const path        = require('path');
 
 const execGitCommand = require('./src/lib/exec-git-command');
@@ -45,17 +46,25 @@ global._perf = t1 => {
 };
 
 global._formatDate = date =>
-  date?.toLocaleDateString('en-gb', {day: 'numeric', month: 'short', year: 'numeric', hour: '2-digit', minute: '2-digit'});
+  date?.toLocaleDateString('en-gb', {day: 'numeric', month: 'short', year: 'numeric', hour: '2-digit', minute: '2-digit'})
 ;
 
+
+global._packages = {
+  TCT: {name: '@tangelo/tangelo-configuration-toolkit', version: require('./package.json')?.version},
+  FDT: {name: '@fontoxml/fontoxml-development-tools'}
+};
+
+
 global._paths = {
   app: __dirname,
-  appdata: path.resolve(__dirname, '..', appname+'-appdata.json'),
-  appconfig: findUp.sync(appname+'-appconfig.json'),
+  apphome: path.join(homedir, '.tct'),
   repo: findUp.sync(dir => fs.existsSync(path.join(dir, '.git')) && dir, {type: 'directory'}) || '',
   tdi: 'tangelo-default-implementation',
   gitremote: 'git@bitbucket.org:tangelosoftware'
 };
+_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);
 
@@ -66,15 +75,37 @@ if (!_appdata.npmPath) {
   _appdata._update({npmPath: execSync('npm config get prefix', {encoding: 'UTF-8'}).replace(/\s$/, '')});
 }
 
-global._packages = {
-  TCT: {name: '@tangelo/tangelo-configuration-toolkit', version: require('./package.json')?.version},
-  FDT: {name: '@fontoxml/fontoxml-development-tools'}
+
+if (!fs.existsSync(_paths.appconfig)) { // try to find old appconfig (TCT-162 => remove code block in next version)
+  fs.ensureDirSync(_paths.apphome);
+  const oldPathAppconfig = findUp.sync(appname+'-appconfig.json');
+  if (oldPathAppconfig) {
+    fs.renameSync(oldPathAppconfig, _paths.appconfig);
+    _info(`${appname}-appconfig.json moved to ${_paths.apphome}`);
+  }
+}
+
+global._appconfig = { // default appconfig if file not found
+  'sharedConfigPath': path.join(homedir, 'Dropbox (Tangelo Software)/Product Distribution/tooling'),
+  'servers': [],
+  'defaultServer': 'tdpXX',
+  'defaultDatabase': 'tdpXX'
 };
 
-try { global._appconfig = _paths.appconfig && fs.readJsonSync(_paths.appconfig) || {}; }
-catch({message}) { _error('Error in '+message); }
+try {
+  global._appconfig = fs.readJsonSync(_paths.appconfig);
+}
+catch({code, message}) {
+  if (code === 'ENOENT') { // create appconfig json if not exists
+    fs.ensureDirSync(_paths.apphome);
+    fs.writeJsonSync(_paths.appconfig, global._appconfig, {spaces: 2});
+    _info(`${_paths.appconfig} was created`);
+  }
+  else _error('Could not load app-config: '+message);
+}
+
 
-_appconfig.sharedConfigPath = path.resolve(_paths.appconfig || '', '..', _appconfig.sharedConfigPath || '', appname+'-appconfig.json');
+_appconfig.sharedConfigPath = path.resolve(_paths.appconfig, '..', _appconfig.sharedConfigPath || '', appname+'-appconfig.json');
 _appconfig.shared = fs.readJsonSync(_appconfig.sharedConfigPath, {throws: false}) || {};
 
 
@@ -83,7 +114,8 @@ global._git = {
     if (!_appdata.gitUser) _appdata._update({gitUser: execGitCommand(`config --get user.email`, _paths.repo)});
     return _appdata.gitUser;
   },
-  commitLocal () {
+  commitLocal (clearcache) {
+    if (clearcache) delete this.cache;
     this.cache ??= execGitCommand(`log -1 --format=%D;%H;%cd --date=iso-strict`, _paths.repo, ['branch', 'hash', 'date']);
     return this.cache;
   },
@@ -92,7 +124,8 @@ global._git = {
     return this.cache;
   },
   commitTdi: {
-    local () {
+    local (clearcache) {
+      if (clearcache) delete this.cache;
       this.cache ??= execGitCommand(`log -1 --format=%D;%H;%cd --date=iso-strict`, path.join(_paths.repo, _paths.tdi), ['tags', 'hash', 'date']);
       return this.cache;
     },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tangelo/tangelo-configuration-toolkit",
-  "version": "1.15.1",
+  "version": "1.17.0",
   "engines": {
     "node": ">=14.0.0"
   },

package/src/cli.js

@@ -8,13 +8,22 @@ module.exports = function cli () {
   const txtTitle    = 'Tangelo Configuration Toolkit'.bold.underline.cyan;
   const txtVersion  = `v${_packages.TCT.version}`.lblack;
 
-  const {argv} = yargs
+  yargs
     .scriptName('tct')
     .usage(`${txtTitle} ${txtVersion}\n\nUsage: $0 <command> [options]`)
     .middleware(argv => { // executes before command handlers
-      if (!(['git', 'g'].includes(argv._[0]) && (argv.init || argv.clone))) {
-        if (!_paths.repo) _error('This command can only be used inside a customer git repo!');
-        process.chdir(_paths.repo);
+      const command = argv._[0];
+      const optionsPassed = Object.keys(argv).length > 2;
+      const gitInitOrClone = (command === 'git' || command === 'g') && (argv.init || argv.clone);
+
+      if (!command && argv.config) {
+        _info(`Loaded appconfig:`);
+        _write(_paths.appconfig);
+        _write(_appconfig);
+      }
+      else if (optionsPassed && !gitInitOrClone) {
+        if (_tdiSubmoduleExists()) process.chdir(_paths.repo); // set cwd to repo root before executing an option
+        else _error('This option can only be used inside a git repo having the TDI submodule!');
       }
     })
     .command({
@@ -79,7 +88,7 @@ module.exports = function cli () {
       builder: {
         execute: {alias: 'e', desc: 'Execute migration'},
         dry: {alias: 'd', desc: 'Dry run (does not persist changes)'},
-        filter: {alias: 'f', desc: 'Pass glob filter (only used for applicable steps)', default: '**'}
+        filter: {alias: 'f', desc: 'Pass glob filter (only used for applicable steps)'}
       },
       handler: require('./modules/migrate')
     })
@@ -121,21 +130,11 @@ module.exports = function cli () {
     .check((argv, options) => {
       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");
+      else throw new Error('Pass a non-default option');
     })
     .strict()
     .wrap(100)
+    .parse()
   ;
 
-
-  if (!argv._[0]) { // no command chosen
-
-    if (argv.config) {
-      if (!_paths.appconfig) _error('No config loaded: tangelo-configuration-toolkit-appconfig.json not found');
-      _info(`Loaded appconfig (using ${_paths.appconfig}):`);
-      _write(_appconfig);
-    }
-
-  }
-
 };

package/src/modules/build/index.js

@@ -29,17 +29,16 @@ 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 ((argv.init || argv.project) && _isPre51()) _error('This option only works when using branch release/5.1 and up.');
 
-    _modulesTdi.require('build/init')(createSymlinks);
-  }
-
-  if (argv.project) {
-    if (_isPre51()) _error('This option only works when using branch release/5.1 and up.');
+  const predefinedAnswers = (argv.init === 'file' || argv.project === 'file') ? _appconfig.build : undefined;
+  // if not chosen to use predefined values by passing "file", erase the "build" property for old TDI commits
+  _appconfig.build = predefinedAnswers;
 
-    const {projectNew, projectCopy} = _modulesTdi.require('build/project');
+  if (argv.init) _modulesTdi.require('build/init')(createSymlinks, predefinedAnswers);
 
+  if (argv.project === 'file') _modulesTdi.require('build/project').projectNew(createSymlinks, _repoconfig[0], predefinedAnswers);
+  else if (argv.project) {
     inquirer
       .prompt([{
         message: 'Create project: ', name: 'project', type: 'list',
@@ -53,10 +52,8 @@ module.exports = function build (argv) {
         ]
       }])
       .then(a => {
-        if (a.project=='TDI') projectNew(createSymlinks);
-        else {
-          projectCopy(createSymlinks, a.project);
-        }
+        if (a.project === 'TDI') _modulesTdi.require('build/project').projectNew(createSymlinks, _repoconfig[0]);
+        else _modulesTdi.require('build/project').projectCopy(createSymlinks, a.project);
       });
   }
 
@@ -76,7 +73,6 @@ module.exports = function build (argv) {
   if (argv.config) {
     if (_git.commitTdi.after(_git.commitTdi.stopUsingRepoconfigFile)) _error('This option only works for older repo\'s using a repoconfig file.');
 
-
     inquirer
       .prompt([{message: 'Be sure paths for projects are [customer]/[project]. Continue?', name: 'confirm', type: 'confirm'}])
       .then(({confirm}) => {

package/src/modules/fonto/commands.js

@@ -1,5 +1,7 @@
+const del     = require('del');
 const {exec}  = require('child_process');
 const fs      = require('fs-extra');
+const globby  = require('globby');
 const gulp    = require('gulp');
 const g_print = require('gulp-print');
 const path    = require('path');
@@ -219,15 +221,27 @@ module.exports = {
     ;
 
     _info(`Ensure ${messagesFile} exists:`);
-    if (!fs.existsSync(messagesFile)) fs.outputJsonSync(messagesFile, [], {spaces: 2});
+    if (!fs.existsSync(messagesFile)) fs.outputJsonSync(messagesFile, []);
+    _write('Done.\n');
+
+    _info('Make temporary copies of json files:');
+    const attrCfgTmpFiles = globby.sync('packages/*/src/!(messages.|operations-)*.json');
+    attrCfgTmpFiles.forEach((p, i, a) => {
+      _write(p);
+      a[i] = path.join(path.dirname(p), 'operations-' + path.basename(p));
+      fs.copyFileSync(p, a[i]);
+    });
+    _write();
 
     return cmdExec(`${fdt} localization extract ${templateFile} --paths ` + packagesDirs)
       .then(() => cmdExec(`${fdt} localization update ${messagesFile} ${templateFile}`))
+      .then(() => fs.readFile(messagesFile, {encoding: 'UTF-8'}))
+      .then(data => fs.outputFile(messagesFile, data.replace(/src\/operations-_/g, 'src/_'))) // remove "operations-" prefix from meta[.file]
       .then(() => {
-        _info('Remove template file:');
-        fs.unlinkSync(templateFile);
-        _write('Done.\n');
+        _info('Cleanup temp files:');
+        return del([templateFile, ...attrCfgTmpFiles]);
       })
+      .then(() => _write('Done.\n'))
       .then(() => [fdt])
     ;
   },

package/src/modules/fonto/index.js

@@ -19,8 +19,6 @@ module.exports = function fonto (argv) {
     }
   })();
 
-  if (!_tdiSubmoduleExists()) _error('TDI submodule folder is missing.');
-
   // 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}`);

package/src/modules/git/index.js

@@ -1,8 +1,6 @@
 const {execSync, spawn} = require('child_process');
-const {chdir}   = require('process');
-const inquirer  = require('inquirer');
-const path      = require('path');
-const fs        = require('fs-extra');
+const inquirer          = require('inquirer');
+const path              = require('path');
 
 const execGitCommand  = require('../../lib/exec-git-command');
 const getTdiBranch    = require('../../lib/get-tdi-branch');
@@ -15,7 +13,8 @@ const cmdExec = commands => new Promise(resolve => {
 
       const log = msg => {
         const line = msg.replace(/\s+$/, ''); // remove excessive whitespace
-        if (line) _write(line);
+        if (line?.startsWith('fatal:')) _error(line);
+        else if (line) _write(line);
       };
 
       const cmdArr = command.split(/ (.+)/);
@@ -88,7 +87,7 @@ module.exports = function git (argv) {
   }
 
   if (argv.clone) {
-    if (argv.clone === true) _error('Pass a repository name!');
+    if (typeof argv.clone !== 'string') _error('Pass a repository name!');
 
     _info('Clone a client repository and do basic project initialization');
     cmdExec([
@@ -96,8 +95,8 @@ module.exports = function git (argv) {
       ['git clone git@bitbucket.org:tangelosoftware/' + argv.clone + '.git']
     ])
       .then(() => {
-      // Change directory for the next commands, it should have the same name as the clone argument from commandline at this point
-        chdir('./' + argv.clone);
+        // Change directory for the next commands, it should have the same name as the clone argument from commandline at this point
+        process.chdir('./' + argv.clone);
         cmdExec([
         // Retrieve TDI submodule for this client
           ['git submodule update --init', 'Fetch submodules such as TDI'],
@@ -106,17 +105,9 @@ module.exports = function git (argv) {
           // Create Oxygen project file and set name equal to repo name
           [`tct b -x ${argv.clone}`, 'Create Oxygen project file'],
         ]);
-      }).catch((e) => {
-      // Show warnings for missing, expected, system environment variables
-        if (!process.env.GIT_SSH) {
-          _warn(`System environment variable 'GIT_SSH' is missing. (link to putty plink.exe)`);
-        }
-        if (!process.env.GIT_SSH_COMMAND) {
-          _warn(`System environment variable 'GIT_SSH_COMMAND' is missing. (link to putty plink.exe)`);
-        }
-        // continue display stack trace
-        throw e;
-      });
+      })
+      .catch(e => {throw e;})
+    ;
   }
 
   if (argv.update) {
@@ -139,12 +130,16 @@ module.exports = function git (argv) {
         const updateSubmoduleMsg = execGitCommand(`submodule update --remote`, _paths.repo);
         if (updateSubmoduleMsg.error && !tdiFromDateCustom) _error(`Update submodule failed\n${updateSubmoduleMsg.error}`);
 
+        const tdiDateBeforeUpdate = _git.commitTdi.local().date;
+        // update local TDI commit data
+        _git.commitTdi.local(true);
+
         if (!tdiFromDateCustom) _info(`TDI submodule updated:\n${updateSubmoduleMsg}`);
 
         // tdiMigrationFilePath should exist in latest commits of releases 5.3+; As we updated to the latest version this should work
         const migrations = _modulesTdi.require('git/tdiCommitsRequiringMigration.js');
         if (migrations) {
-          const fromTdiDate = tdiFromDateCustom ? new Date(tdiFromDateCustom) : (tdiBranch.commonAncestor) ? tdiBranch.commonAncestor.date: _git.commitTdi.local().date;
+          const fromTdiDate = tdiFromDateCustom ? new Date(tdiFromDateCustom) : (tdiBranch.commonAncestor) ? tdiBranch.commonAncestor.date: tdiDateBeforeUpdate;
           const toTdiDate = tdiToDateCustom ? new Date(tdiToDateCustom) : new Date();
 
           _info(`TDI commits requiring migration between ${_formatDate(fromTdiDate)} and ${_formatDate(toTdiDate)}`);
@@ -162,6 +157,7 @@ module.exports = function git (argv) {
           let relevantMigrationCount = 0;
           // Apply callback for migrations
           migrationsFiltered
+            .sort((a, b) => Date(a.releases[0].date)>Date(b.releases[0].date)?1:-1)
             .forEach((m) => {
               const date = _formatDate(new Date(m.releases.filter((r) => tdiBranch.name >= `release/${r.release}`)[0].date));
               relevantMigrationCount += (m.callback(date, relevantMigrationCount+1)) === 1 ? 1 : 0;
@@ -195,13 +191,13 @@ module.exports = function git (argv) {
       if (cmdPull.error) _warn(`Pull failed\n${cmdPull.error}`);
 
       _info(`Checked out at commit:`);
-      const repoLog = execGitCommand(`log -1 --format=%D;%H;%cd --date=iso-strict`, _paths.repo, ['tags', 'hash', 'date']);
+      const repoLog = _git.commitLocal(true);
       _write(`${_formatDate(repoLog.date)} - ${repoLog.tags} - ${repoLog.hash}`);
 
       _info(`Retrieve submodules that belong to this repo-commit`); // update submodule recursively (set to version that belongs to repo)
       _write(execGitCommand(`submodule update --recursive`, path.join(_paths.repo)));
       _info(`Submodule checked out at commit:`);
-      const tdiLog = execGitCommand(`log -1 --format=%D;%H;%cd --date=iso-strict`, path.join(_paths.repo, _paths.tdi), ['tags', 'hash', 'date']);
+      const tdiLog = _git.commitTdi.local(true);
       _write(`${_formatDate(tdiLog.date)} - ${tdiLog.tags} - ${tdiLog.hash}`);
       const tdiBranch = getTdiBranch();
 

package/src/modules/migrate/index.js

@@ -6,8 +6,6 @@ const path      = require('path');
 module.exports = function migrate (argv) {
   if (_isPre51()) _error('This command only works when using branch release/5.1 and up.');
 
-  let filter = path.join(_paths.apply, argv.filter).toFws(); // Default set filter with filter added to the command argument -f
-
   const scripts =
     globby
       .sync(_paths.tdi + '/tct/migrate/*.js')
@@ -37,12 +35,12 @@ module.exports = function migrate (argv) {
       when: !(cmdlScript) // Only show choice for migration when no script is set in commandline
     }, {
       message: 'Choose filter: ', name: 'filter', type: 'list', pageSize: 5, loop: false,
-      choices: [{name: `- All`, value: argv.filter}, {name: '- Choose active projects', value: 'projects'}],
-      when: argv.filter === '**' // Only show this message if no custom filter was added to the command argument -f
+      choices: [{name: `- All`, value: '**'}, {name: '- Choose active projects', value: 'projects'}],
+      when: !argv.filter // Only show this message if no custom filter was added to the command argument -f
     }, {
       message: 'Choose active projects: ', name: 'projects', type: 'checkbox', validate: v => !!v[0],
       choices: _repoconfig.map(p => ({name: `${p.customer_name} ${p.project_name}`, value: p})),
-      when: (a) => a.filter === 'projects' // Only show this message if 'Choose active projects' was chosen previously
+      when: a => a.filter === 'projects' // Only show this message if 'Choose active projects' was chosen previously
     }])
     .then(a => {
       _write();
@@ -53,6 +51,8 @@ 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
+
       if (a.filter === 'projects' && _repoconfig.length > a.projects.length) {
       // push paths of chosen active documents to projectFolders (only if not all projects are chosen)
         const projectFolders = [];