@tangelo/tangelo-configuration-toolkit 1.10.3 → 1.10.4

package/index.js

@@ -5,10 +5,10 @@ String.prototype.toFws = function(){
 };
 
 
-const findUp    = require('find-up');
-const fs        = require('fs-extra');
-const {getPath} = require('global-modules-path');
-const path      = require('path');
+const {execSync}  = require('child_process');
+const findUp      = require('find-up');
+const fs          = require('fs-extra');
+const path        = require('path');
 
 const execGitCommand = require('./src/lib/exec-git-command');
 
@@ -57,12 +57,17 @@ _paths.repoconfig = path.join(_paths.repo, appname+'-repoconfig.json');
 _paths.apply = process.cwd().replace(_paths.repo, '').substr(1);
 
 
-global._appdata  = fs.readJsonSync(_paths.appdata, {throws: false}) || {};
+global._appdata = fs.readJsonSync(_paths.appdata, {throws: false}) || {};
+_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$/, '')});
+}
+
 global._packages = {
   TCT: {name: '@tangelo/tangelo-configuration-toolkit', version: require('./package.json')?.version},
   FDT: {name: '@fontoxml/fontoxml-development-tools'}
 }
-_packages.FDT.version = fs.readJsonSync(`${getPath(_packages.FDT.name)}/package.json`, {throws: false})?.version;
+_packages.FDT.version = fs.readJsonSync(path.join(_appdata.npmPath, 'node_modules', _packages.FDT.name, 'package.json'), {throws: false})?.version;
 
 try { global._appconfig = _paths.appconfig && fs.readJsonSync(_paths.appconfig) || {}; }
 catch({message}) { _error('Error in '+message); }
@@ -71,29 +76,27 @@ _appconfig.sharedConfigPath = path.resolve(_paths.appconfig || '', '..', _appcon
 _appconfig.shared           = fs.readJsonSync(_appconfig.sharedConfigPath, {throws: false}) || {};
 
 
-global._commit = {
-  branch: execGitCommand('rev-parse --abbrev-ref HEAD', _paths.repo),
-  hash: execGitCommand('rev-parse HEAD', _paths.repo),
-  date: execGitCommand('log -1 --format=%cd --date=iso-strict', _paths.repo)
-};
-_commit.lastDateRemote = execGitCommand('log -1 --format=%cd --date=iso-strict origin/'+_commit.branch,_paths.repo);
-
-global._tdiCommit = {
-  hash: execGitCommand('rev-parse HEAD', path.join(_paths.repo, _paths.tdi)),
-  after (commitHash) {
-    return execGitCommand(`merge-base --is-ancestor ${commitHash} ${this.hash}`, path.join(_paths.repo, _paths.tdi), 0);
-  },
-  fontoVersions: [ // latest commits first
-    {commitHash: 'e599766', regex: /^7\.1[45]\./},
-    {commitHash: '77b8ea9', regex: /^7\.14\./}, // 7.14.x
-    {commitHash: '8066c44', regex: /^7\.13\./}, // 7.13.x
-    {commitHash: 'a2b2d4e', regex: /^7\.12\./}  // 7.12.x
-  ],
-  stopUsingRepoconfigFile: '1f12bff' // release/5.1 10-05-2021
+global._git = {
+  user: execGitCommand(`config --get user.email`, _paths.repo),
+  commitLocal: execGitCommand(`log -1 --format=%D;%H;%cd --date=iso-strict`, _paths.repo, ['branch', 'hash', 'date']),
+  commitLocalTdi: {
+    hash: execGitCommand('rev-parse HEAD', path.join(_paths.repo, _paths.tdi)),
+    after (commitHash) {
+      return execGitCommand(`merge-base --is-ancestor ${commitHash} ${this.hash}`, path.join(_paths.repo, _paths.tdi), null, 0);
+    },
+    fontoVersions: [ // latest commits first
+      {commitHash: 'e599766', regex: /^7\.1[45]\./},
+      {commitHash: '77b8ea9', regex: /^7\.14\./}, // 7.14.x
+      {commitHash: '8066c44', regex: /^7\.13\./}, // 7.13.x
+      {commitHash: 'a2b2d4e', regex: /^7\.12\./}  // 7.12.x
+    ],
+    stopUsingRepoconfigFile: '1f12bff' // release/5.1 10-05-2021
+  }
 };
+_git.commitRemote = execGitCommand('log -1 --format=%cd --date=iso-strict origin/'+_git.commitLocal.branch, _paths.repo, ['date']);
 
 
-if (_tdiCommit.after(_tdiCommit.stopUsingRepoconfigFile)) {
+if (_git.commitLocalTdi.after(_git.commitLocalTdi.stopUsingRepoconfigFile)) {
   global._repoconfig = require('./src/lib/get-repoconfig')();
 }
 else {
@@ -111,4 +114,19 @@ 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
+
+  require('./src/lib/package-update-check')();
+
+  if (_appdata._changed) {
+    delete _appdata._update;
+    delete _appdata._changed;
+    fs.writeJsonSync(_paths.appdata, _appdata, {spaces: 2});
+  }
+
+});
+
+
 require('./src/cli.js')();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tangelo/tangelo-configuration-toolkit",
-  "version": "1.10.3",
+  "version": "1.10.4",
   "description": "Tangelo Configuration Toolkit is a command-line toolkit which offers support for developing a Tangelo configuration.",
   "bin": {
     "tct": "bin/index.js",
@@ -25,7 +25,6 @@
     "event-stream": "^4.0.1",
     "find-up": "^5.0.0",
     "fs-extra": "^10.0.0",
-    "global-modules-path": "^2.3.1",
     "globby": "^6.1.0",
     "gulp": "^4.0.2",
     "gulp-babel": "^8.0.0",

package/src/cli.js

@@ -1,26 +1,6 @@
-const {compare} = require('compare-versions');
-const exec  = require('util').promisify(require('child_process').exec);
-const fs    = require('fs-extra');
 const yargs = require('yargs');
 
 
-const updateAppdata = (data) => Object.assign(_appdata, data, {_changed: true});
-
-const checkForPackageUpdate = (package) => (
-  exec(`npm view -g ${_packages[package].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, '<')) {
-      updateAppdata({[`updateCheck${package}`]: {executed: new Date(), versionAvailable}});
-      return versionAvailable;
-    }
-    else updateAppdata({[`updateCheck${package}`]: {executed: new Date()}});
-  })
-  .catch(e => _warn(`Failed checking latest version of ${package}.`))
-);
-
-
 module.exports = function cli () {
 
   _write();
@@ -45,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: _tdiCommit.after(_tdiCommit.stopUsingRepoconfigFile)},
+      config: {alias: 'c', desc: 'Create repo-config file', conflicts: ['p', 'i', 's'], hidden: _git.commitLocalTdi.after(_git.commitLocalTdi.stopUsingRepoconfigFile)},
       oxygen: {alias: 'x', desc: 'Create or update oXygen project file (.xpr)', conflicts: ['p', 'i', 'c']}
     },
     handler: require('./modules/build')
@@ -143,34 +123,4 @@ module.exports = function cli () {
 
   }
 
-
-  let checkUpdatesDone = false;
-
-  process.on('beforeExit', () => {
-    _write(); // print empty line before and after update check
-
-    if (!checkUpdatesDone) { // check if updatecheck has ran before because async calls below trigger beforeExit again
-      checkUpdatesDone = true;
-
-      ['TCT', 'FDT'].forEach(p => {
-        const updateMsg = (va) => `| Update ${p} to ${va} | ` + `npm i -g ${_packages[p].name}`.white;
-        const {versionAvailable} = _appdata[`updateCheck${p}`] || {};
-
-        if (new Date() - new Date(_appdata[`updateCheck${p}`]?.executed || 0) > 1000*3600*24*7) { // check every week
-          checkForPackageUpdate(p).then(r => r && _warn(updateMsg(r)));
-        }
-        else if (versionAvailable) {
-          if (compare(_packages[p].version, versionAvailable, '<')) _warn(updateMsg(versionAvailable));
-          else updateAppdata({[`updateCheck${p}`]: {executed: new Date()}});
-        }
-      });
-    }
-
-    if (_appdata._changed) {
-      delete _appdata._changed;
-      fs.writeJsonSync(_paths.appdata, _appdata, {spaces: 2});
-    }
-
-  });
-
 }

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

@@ -1,10 +1,26 @@
 const {spawnSync} = require('child_process');
 
 
-module.exports = function execGitCommand(args, path, status) {
+module.exports = function execGitCommand(args, path, returnProperties = [], expectedStatus) {
 
   const cmd = spawnSync('git', [args], {cwd: path, shell: true});
-  const res = status!=undefined ? cmd.status == status : (cmd.stdout||'').toString().trim();
-  return /^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}/.test(res) ? new Date(res) : res;
+
+  if (expectedStatus!=undefined) return cmd.status == expectedStatus;
+
+  let retObj = (cmd.stdout||'').toString().trim().split(';');
+  if (returnProperties[0]) {
+    retObj = (
+      o = {},
+      retObj.forEach((v,i) => {
+        o[returnProperties[i]] =
+          returnProperties[i] == 'date' ? new Date(v) :
+          returnProperties[i] == 'branch' ? v.replace(/HEAD -> ([^,]+).*/, '$1') :
+          v
+        ;
+      }),
+      o
+    )
+  }
+  return retObj.length==1 ? retObj[0] : retObj;
 
 };

package/src/lib/get-repoconfig.js

@@ -2,7 +2,7 @@ const fs      = require('fs-extra');
 const globby  = require('globby');
 
 
-module.exports = function getRepoconfig(repoconfigPath) {
+module.exports = function getRepoconfig() {
 
   const repoconfig = [];
 

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

@@ -0,0 +1,39 @@
+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`)
+  .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}});
+      return versionAvailable;
+    }
+    else _appdata._update({[`updateCheck${package}`]: {executed: new Date()}});
+  })
+  .catch(e => _warn(`Failed checking latest version of ${package}.`))
+);
+
+let checkUpdatesDone = false;
+
+
+module.exports = function packageUpdateCheck () {
+  if (!checkUpdatesDone) { // check if updatecheck has ran before because async calls below trigger beforeExit again
+    checkUpdatesDone = true;
+
+    ['TCT', 'FDT'].forEach(p => {
+      const updateMsg = (va) => `| Update ${p} to ${va} | ` + `npm i -g ${_packages[p].name}`.white;
+      const {versionAvailable} = _appdata[`updateCheck${p}`] || {};
+
+      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)));
+      }
+      else if (versionAvailable) {
+        if (compare(_packages[p].version, versionAvailable, '<')) _warn(updateMsg(versionAvailable));
+        else _appdata._update({[`updateCheck${p}`]: {executed: new Date()}});
+      }
+    });
+  }
+}

package/src/modules/build/index.js

@@ -74,7 +74,7 @@ module.exports = function build (argv) {
   }
 
   if (argv.config) {
-    if (_tdiCommit.after(_tdiCommit.stopUsingRepoconfigFile)) _error('This option only works for older repo\'s using a repoconfig file.');
+    if (_git.commitLocalTdi.after(_git.commitLocalTdi.stopUsingRepoconfigFile)) _error('This option only works for older repo\'s using a repoconfig file.');
 
 
     inquirer

package/src/modules/deploy/config.js

@@ -55,7 +55,7 @@ module.exports = {
         username: serverConfig.config.username,
         agent: process.platform=='win32' ? 'pageant' : process.env.SSH_AUTH_SOCK,
         agentForward: process.platform!='win32',
-        readyTimeout: 10000,
+        readyTimeout: 15000,
         retries: 1
       }
     };
@@ -129,13 +129,13 @@ module.exports = {
     }
     else this.replaceStrings.push(['debugMode>true', 'debugMode>false', '**/xopus/xml/*']);
 
-    _info(`Branch: ${_commit.branch}`);
+    _info(`Branch: ${_git.commitLocal.branch}`);
     _info(`Source: ${path.join(process.cwd(), transferPattern)}`);
     _info(`Server: ${ftpConfig.host ? `${ftpConfig.host}:${ftpConfig.port}` : 'local'}`);
     _info(`Target: ${this.getRemotePath(transferPattern)}`);
     _write();
 
-    if (_commit.date < _commit.lastDateRemote) {
+    if (_git.commitLocal.date < _git.commitRemote.date) {
       _warn(`You're not deploying from the most recent git commit!\n`)
     }
   }

package/src/modules/deploy/execute.js

@@ -126,15 +126,19 @@ const transfer = (paths, lrServer) => {
   const srcset  = s.create(paths);
   const files   = [];
 
+  // local git repo must be on latest commit containing fonto changes, and fonto build files must be newer than that commit, unless that commit belongs to the current user
   const fontoPaths = {outdated: [], uptodate: []};
-  const removeOutdatedFontoBuild = g_filter(file => { // fonto build files must be newer than the last commit date containing fonto changes
+  const removeOutdatedFontoBuild = g_filter(file => {
     const prPath = 'config\\'+file.relative.replace(/fonto.+$/, '');
     if (fontoPaths.outdated.includes(prPath)) return false;
     if (fontoPaths.uptodate.includes(prPath)) return true;
     if (file.relative.match(/fonto[\\\/]dist/)) {
       const paths = `${prPath}\\fonto ${prPath}\\schema ${_paths.tdi}`; // only check paths containing fonto sources
-      const lastFontoCommitDate = execGitCommand(`log -1 --format=%cd --date=iso-strict origin/${_commit.branch} ${paths}`, _paths.repo);
-      if (fs.statSync(file.relative).mtime < lastFontoCommitDate) {
+      const lastFontoCommit = execGitCommand(`log -1 --format=%ae;%cd --date=iso-strict origin/${_git.commitLocal.branch} ${paths}`, _paths.repo, ['author', 'date']);
+      if (
+        lastFontoCommit.author != _git.user &&
+        (lastFontoCommit.date > _git.commitLocal.date || lastFontoCommit.date > fs.statSync(file.relative).mtime)
+      ) {
         fontoPaths.outdated.push(prPath);
         return false;
       }

package/src/modules/fonto/commands.js

@@ -14,9 +14,9 @@ const allowedFontoVersionRegex = () => {
   const cfvPath = path.join(_paths.repo, _paths.tdi, 'tct/fonto/compatibleVersions.json');
   if (fs.pathExistsSync(cfvPath)) return RegExp(fs.readJsonSync(cfvPath).regex);
 
-  // old way: a regex for each basecommit is stored in global._tdiCommit
-  for (const fv of _tdiCommit.fontoVersions) {
-    if (_tdiCommit.after(fv.commitHash)) return fv.regex;
+  // old way: a regex for each basecommit is stored in global._git.commitLocalTdi
+  for (const fv of _git.commitLocalTdi.fontoVersions) {
+    if (_git.commitLocalTdi.after(fv.commitHash)) return fv.regex;
   }
 };
 

package/src/modules/sql/index.js

@@ -37,7 +37,7 @@ const checkLog = (logFilePath, remove=true) => {
 
 module.exports = function sql (argv) {
 
-  if ((argv.install || argv.configure) && _commit.date < _commit.lastDateRemote) {
+  if ((argv.install || argv.configure) && _git.commitLocal.date < _git.commitRemote.date) {
     _warn(`You're not deploying from the most recent git commit!\n`)
   }