@tangelo/tangelo-configuration-toolkit 1.8.0-beta.2 → 1.8.3

package/index.js

@@ -5,9 +5,10 @@ String.prototype.toFws = function(){
 };
 
 
-const findUp  = require('find-up');
-const fs      = require('fs-extra');
-const path    = require('path');
+const findUp    = require('find-up');
+const fs        = require('fs-extra');
+const {getPath} = require('global-modules-path');
+const path      = require('path');
 
 const execGitCommand = require('./src/lib/exec-git-command');
 
@@ -56,8 +57,12 @@ _paths.repoconfig = path.join(_paths.repo, appname+'-repoconfig.json');
 _paths.apply = process.cwd().replace(_paths.repo, '').substr(1);
 
 
-global._package = require('./package.json');
-global._appdata = fs.readJsonSync(_paths.appdata, {throws: false}) || {versionLastChecked: 0, versionIsLatest: true};
+global._appdata  = fs.readJsonSync(_paths.appdata, {throws: false}) || {};
+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;
 
 try { global._appconfig = _paths.appconfig && fs.readJsonSync(_paths.appconfig) || {}; }
 catch({message}) { _error('Error in '+message); }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tangelo/tangelo-configuration-toolkit",
-  "version": "1.8.0-beta.2",
+  "version": "1.8.3",
   "description": "Tangelo Configuration Toolkit is a command-line toolkit which offers support for developing a Tangelo configuration.",
   "bin": {
     "tct": "bin/index.js",
@@ -25,6 +25,7 @@
     "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": "^7.0.1",
@@ -33,17 +34,17 @@
     "gulp-plumber": "^1.2.1",
     "gulp-print": "^5.0.2",
     "gulp-sass": "^5.0.0",
-    "gulp-simple-rename": "^0.1.3",
     "gulp-sourcemaps": "^3.0.0",
     "inquirer": "^8.2.0",
     "istextorbinary": "^6.0.0",
     "minimatch": "^3.0.4",
     "node-ssh": "^12.0.2",
     "object-assign-deep": "^0.4.0",
-    "replace-in-file": "^6.0.0",
-    "sass": "^1.43.4",
+    "replace-in-file": "^3.4.4",
+    "sass": "^1.43.5",
     "saxon-js": "^2.3.0",
     "scp2": "^0.5.0",
+    "through2": "^4.0.2",
     "tiny-lr": "^2.0.0",
     "yargs": "^16.2.0"
   },

package/src/cli.js

@@ -1,13 +1,32 @@
+const {compare} = require('compare-versions');
+const exec  = require('util').promisify(require('child_process').exec);
 const fs    = require('fs-extra');
 const yargs = require('yargs');
-const {getCurrentPackageVersion, getLatestPackageVersion, updatePackage} = require('./lib/npm-package-update');
+
+
+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();
 
   const txtTitle    = 'Tangelo Configuration Toolkit'.bold.underline.cyan;
-  const txtVersion  = `v${_package.version}${_appdata.versionIsLatest ? '' : ' (new version available)'}`.lblack;
+  const txtVersion  = `v${_packages.TCT.version}`.lblack;
 
   const {argv} = yargs
   .scriptName('tct')
@@ -95,8 +114,6 @@ module.exports = function cli () {
   })
   .recommendCommands()
   .option('config', {alias: 'c', desc: 'Show loaded appconfig', global: false})
-  .option('update', {alias: 'u', desc: 'Update this package', global: false})
-  .option('update-fdt', {alias: 'uf', desc: 'Update the FDT package', global: false})
   .version(false)
   .help(false)
   .example([
@@ -123,53 +140,36 @@ module.exports = function cli () {
       _write(_appconfig);
     }
 
-    if (argv.update) {
-      _info('Updating TCT...');
-      getLatestPackageVersion({package: 'TCT', version: _package.version})
-      .then(updatePackage)
-      ;
-    }
-
-    if (argv.updateFdt) {
-      _info('Updating FDT...');
-      getCurrentPackageVersion({package: 'FDT'})
-      .then(getLatestPackageVersion)
-      .then(updatePackage)
-      ;
-    }
-
   }
 
 
   let checkUpdatesDone = false;
 
   process.on('beforeExit', () => {
-
-    if (_appdata._changed) {
-      delete _appdata._changed;
-      fs.writeJsonSync(_paths.appdata, _appdata, {spaces: 2});
-    }
-
     _write(); // print empty line before and after update check
 
-    if (!(argv.update || argv.updateFdt) && // not when doing update
-        (!_appdata.updateCheckTCT?.versionAvailable || !_appdata.updateCheckFDT?.versionAvailable) && // not if already known that update is available
-        ( new Date() - new Date(_appdata.updateCheckTCT?.executed || 0) > 1000*3600*24*3 ||
-          new Date() - new Date(_appdata.updateCheckFDT?.executed || 0) > 1000*3600*24*3
-        )  && // check every 3 days
-        !checkUpdatesDone // check if updatecheck has ran before because async calls below trigger beforeExit again
-    ) {
+    if (!checkUpdatesDone) { // check if updatecheck has ran before because async calls below trigger beforeExit again
       checkUpdatesDone = true;
-      _info('Checking for updates...');
 
-      // check tct version
-      getLatestPackageVersion({package: 'TCT', version: _package.version});
+      ['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()}});
+        }
+      });
+    }
 
-      // check fdt version
-      getCurrentPackageVersion({package: 'FDT'})
-      .then(getLatestPackageVersion)
-      ;
+    if (_appdata._changed) {
+      delete _appdata._changed;
+      fs.writeJsonSync(_paths.appdata, _appdata, {spaces: 2});
     }
+
   });
 
 }

package/src/lib/gulp-simple-rename.js

@@ -0,0 +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);
+  });
+};

package/src/modules/deploy/execute.js

@@ -2,17 +2,15 @@ const fs            = require('fs-extra');
 const globby        = require('globby');
 const gulp          = require('gulp');
 const {NodeSSH}     = require('node-ssh');
-const path          = require('path');
 const through2      = require('through2');
 const {spawnSync}   = require('child_process');
 
-const g_babel       = require('gulp-babel');
 const g_babel_env   = require('babel-preset-es2015-without-strict');
+const g_babel       = require('gulp-babel');
 const g_eol         = require('gulp-eol');
 const g_filter      = require('gulp-filter');
 const g_plumber     = require('gulp-plumber');
 const g_print       = require('gulp-print');
-const g_rename      = require('gulp-simple-rename');
 const g_replace     = require('../../lib/gulp-batch-replace-with-filter');
 const g_resolveIncl = require('../../lib/gulp-resolve-includes');
 const g_sass        = require('gulp-sass')(require('sass'));
@@ -157,7 +155,7 @@ const transfer = (paths, lrServer) => {
   .pipe(xpsF.restore)
   .pipe(jsF)
   .pipe(g_sourcemaps.init())
-  .pipe(g_babel({ presets: [g_babel_env], comments: false, minified: true }))
+  .pipe(g_babel({presets: [g_babel_env], comments: false, minified: true}))
   .pipe(g_sourcemaps.write('.'))
   .pipe(jsF.restore)
   .pipe(sassF)
@@ -170,8 +168,8 @@ const transfer = (paths, lrServer) => {
   .pipe(shF.restore)
   .pipe(g_plumber.stop())
   .pipe(g_replace(c.replaceStrings))
-  .pipe(g_rename(path => path.replace(/fonto[\\\/]dist/, 'fonto').replace(/(fonto[\\\/]).+(assets[\\\/]schemas)/, '$1$2'))) // change destination path for fonto build and schemas
   .pipe(through2.obj((file, enc, cb) => {
+    file.path = file.path.replace(/(fonto)(?:[\\\/]dist|.+([\\\/]assets[\\\/]schemas))/, '$1$2'); // change destination path for fonto build and schemas
     if (!file.relative.endsWith('.map')) files.push(file.relative); // collect all file paths in array for livereload
     cb(null, file);
   }))

package/src/modules/git/index.js

@@ -37,9 +37,12 @@ module.exports = function git (argv) {
 
   if (argv.hasOwnProperty('init')) {
     const remoteTdiUrl = `${_paths.gitremote}/${_paths.tdi}.git`;
-    const branches =
-      execSync('git ls-remote --heads ' + remoteTdiUrl)
-      .toString()
+    let branches;
+
+    try { branches = execSync('git ls-remote --heads ' + remoteTdiUrl, {encoding: 'UTF-8'}) }
+    catch (e) { _error(' '); } // execSync already prints an error to the console
+
+    branches = branches
       .match(/refs\/heads\/\S+/g)
       .map(s => s.replace('refs/heads/', ''))
       .sort((a, b) => {

package/src/modules/migrate/steps.js

@@ -5,7 +5,6 @@ const path      = require('path');
 const rif       = require('replace-in-file');
 
 
-const rifSync   = (options)         => rif.sync(options).filter(result => result.hasChanged).map(result => result.file);
 const getPaths  = (search, filter)  =>
   globby
   .sync(search, {dot: true, ignore: [_paths.tdi + '/**','**/cmscustom/tdi/**']})
@@ -48,9 +47,9 @@ module.exports = function steps (step, dry, filter) {
         r.to    = r.fromtoPairs.map(p => p[1]);
       }
 
-      r.files = rifSync(r);                                                 // execute first time
+      r.files = rif.sync(r);                                                // execute first time
       const filesModCount = r.files.length;                                 // save file count
-      for (let i=0; i<20 && !dry && r.files[0]; i++) r.files = rifSync(r);  // execute repeatedly for modified files only (with safety limit of 20)
+      for (let i=0; i<20 && !dry && r.files[0]; i++) r.files = rif.sync(r); // execute repeatedly for modified files only (with safety limit of 20)
 
       _write('Files modified:', filesModCount);
     });

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

@@ -1,51 +0,0 @@
-const {compare} = require('compare-versions');
-const util = require('util');
-const exec = util.promisify(require('child_process').exec);
-
-
-const packageNames = {
-  TCT: '@tangelo/tangelo-configuration-toolkit',
-  FDT: '@fontoxml/fontoxml-development-tools'
-};
-
-const updateAppdata = (data) => Object.assign(_appdata, data, {_changed: true});
-
-const getCurrentPackageVersion = ({package}) => (
-  exec(`npm list -g ${packageNames[package]}`)
-  .then(r => ({package, version: r.stdout.match(/@([\d/.]+)/)[1]}))
-  .catch(e => _warn(`Failed checking current version of ${package}.`))
-);
-
-const getLatestPackageVersion = ({package, version}) => (
-  exec(`npm view -g ${packageNames[package]} version`)
-  .then(r => {
-    const versionAvailable = r.stdout.match(/([\d/.]+)/)[1];
-    if (compare(version, versionAvailable, '>=')) {
-      updateAppdata({[`updateCheck${package}`]: {executed: new Date()}});
-      _write(`Using latest version of ${package}.`);
-    }
-    else {
-      updateAppdata({[`updateCheck${package}`]: {executed: new Date(), versionAvailable}});
-      _write(`New version of ${package} available!`);
-    }
-    return {package, version, versionAvailable};
-  })
-  .catch(e => _warn(`Failed checking latest version of ${package}.`))
-);
-
-const updatePackage = ({package, version, versionAvailable}) => (
-  compare(version, versionAvailable, '<') &&
-  exec(`npm install -g ${packageNames[package]}`)
-  .then(r => {
-    updateAppdata({[`updateCheck${package}`]: {executed: new Date()}});
-    _write(`Updated ${package} to version ${versionAvailable}.`);
-  })
-  .catch(e => _warn(`Failed updating latest version of ${package}.`))
-);
-
-
-module.exports = {
-  getCurrentPackageVersion,
-  getLatestPackageVersion,
-  updatePackage
-};