@tangelo/tangelo-configuration-toolkit 1.17.1 → 1.19.0

package/src/modules/deploy/config.js

@@ -3,141 +3,136 @@ const objMerge  = require('object-assign-deep');
 const path      = require('path');
 
 
-module.exports = {
-
-  getRemotePath (...arr) {
-    const fp = path.join(this.server.remotedir, ...arr);
-    return this.server.remotedir.match(/:/) ? fp : fp.toFws();
-  },
-
-  setServer (server) {
-    if (!server) _error('No server was passed.');
-
-    let serverConfigs = [];
-
-    // find server in local config
-    if (_appconfig.servers)
-      serverConfigs = _appconfig.servers.filter(obj =>
-        obj.name == server || (obj.domains && obj.domains.find(d => d.startsWith(server)))
-      );
-
-    // if nothing found, find server in shared config
-    if (!serverConfigs[0] && _appconfig.shared.servers)
-      serverConfigs = _appconfig.shared.servers.filter(obj =>
-        obj.name == server || (obj.domains && obj.domains.find(d => d.startsWith(server)))
-      );
-
-    // complement configs with defaults and filter domains
-    serverConfigs = serverConfigs.map(obj =>
-      objMerge(
-        {config: {}}, // make sure key is present
-        _appconfig.shared.serverDefaults, // override with shared defaults
-        _appconfig.serverDefaults, obj, //  override with local defaults
-        {domains: (obj.domains||[]).filter(d => obj.name == server || d.startsWith(server))} // make sure key is present and filter for domain (if not matched for name)
-      )
-    );
+function getRemotePath (...arr) {
+  const fp = path.join(this.server.remotedir, ...arr);
+  return this.server.remotedir.includes(':') ? fp : fp.toFws;
+}
+
+
+function setServer (searchString) {
+  if (!searchString) _error('No server was passed.');
+
+  const stringsToArrays = stringOrArray => [stringOrArray].flat();
+  const filterDomains = domain => domain[0].startsWith(searchString) || domain.slice(1).includes(searchString);
+  const filterServerConfigs = (arr, cfg) => {
+    if (cfg.domains) cfg.domains = cfg.domains.map(stringsToArrays).filter(filterDomains);
+    if (cfg.name === searchString || cfg.domains?.[0]) arr.push(cfg);
+    return arr;
+  };
+
+  // find server in local config and filter domains
+  let serverConfigs = _appconfig.servers?.reduce(filterServerConfigs, []);
+  // if nothing found, find server in shared config and filter domains
+  if (!serverConfigs?.[0]) serverConfigs = _appconfig.shared.servers?.reduce(filterServerConfigs, []);
+
+  // abort if no config is found, or if multiple configs or domains are found for server
+  if (!serverConfigs?.[0]) _error(`No config found for "${searchString}".`);
+  if (serverConfigs.length > 1 || serverConfigs[0].domains?.length > 1) {
+    const matches = serverConfigs.map(obj => obj.name === searchString ? obj.name : obj.domains);
+    const matchesFlatten = matches.flat().map(stringsToArrays).map(m => m[0] + (m[1] ? ` [${m.slice(1).join(', ')}]` : '')).join(', ');
+    _error(`Passed server name "${searchString}" gives multiple results:\n${matchesFlatten}`);
+  }
 
-    // abort if no config is found, or multiple configs, or multiple domains, are found for server
-    if (!serverConfigs[0]) _error(`No config found for "${server}".`);
-    if (serverConfigs.length > 1 || serverConfigs[0].domains.length > 1) {
-      const matches = serverConfigs.map(obj => obj.name == server ? obj.name : obj.domains.filter(d => d.startsWith(server)));
-      _error(`Passed server name "${server}" gives multiple results:\n${matches.flat().join(', ')}`);
-    }
-
-    // compose final server config in usable format
-    const [serverConfig] = serverConfigs;
-    this.server = {
-      remotedir: serverConfig.config.remotedir,
-      ftpConfig: {
-        host: serverConfig.domains[0],
-        port: serverConfig.config.port,
-        parallel: serverConfig.config.parallel,
-        username: serverConfig.config.username,
-        agent: process.platform=='win32' ? 'pageant' : process.env.SSH_AUTH_SOCK,
-        agentForward: process.platform!='win32',
-        readyTimeout: 15000,
-        retries: 1
-      }
+  // complement serverconfig with defaults
+  const serverConfig = objMerge(
+    {config: {}, domains: [[]]}, // make sure keys are present
+    _appconfig.shared.serverDefaults, // override with shared defaults
+    _appconfig.serverDefaults, // override with local defaults
+    serverConfigs[0]
+  );
+
+  // compose final server config in usable format
+  const {config, domains: [[host]], mode} = serverConfig;
+
+  this.server = {remotedir: config.remotedir};
+
+  if (host) {
+    const {parallel, port, username} = config;
+    if (!(port && parallel && username)) _error('Config is incomplete!');
+    this.server.ftpConfig = {
+      host, port, parallel, username,
+      agent: process.platform === 'win32' ? 'pageant' : process.env.SSH_AUTH_SOCK,
+      agentForward: process.platform !== 'win32',
+      readyTimeout: 15000,
+      retries: 1
     };
+  }
+
+  if (mode === 'delivery-pack') {
+    const dateStr = new Date().toISOString().replace(/(.*)T(\d+):(\d+):(\d+).*/g, '$1_$2$3$4');
+    this.deliveryPackName = `tangelo-config-delivery-pack_${_paths.repo.split(/[\\/]/).pop()}_${dateStr}`;
+    this.server.remotedir += '/' + this.deliveryPackName; // output to temp folder
+    this.deliveryPack = true;
+  }
+
+  this.envDev = !host && !this.deliveryPack || /\.dev\.tangelo\.nl$/.test(host);
+}
+
+
+function prepareForCopy (filter) {
+  const {remotedir, ftpConfig} = this.server;
+  if (!path.isAbsolute(remotedir)) _error('"remotedir" must contain an absolute path!');
+
+  this.giPatterns = !fs.existsSync('.gitignore') ? [] :
+    fs.readFileSync('.gitignore').toString()
+      .trim()
+      .replace(/^#.+/gm, '') // remove comments
+      .split(/\s+/) // split on lines
+      .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 **
+  ;
+
+  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*\})?\/|\*\/)?\*\*/;
+  const tdiPattern  = tdiIncRegex.test(transferPattern) ? transferPattern.replace(tdiIncRegex, `${this.deliveryPack ? 'config/' : ''}cmscustom/tdi/**`) : 'nomatch';
+
+  if (!transferPattern)
+    _error('Invalid glob expression passed!');
+  else if (this.deliveryPack && transferPattern.startsWith('*'))
+    transferPattern = `{config,database,${_paths.tdi}/src/database/tdi}/${transferPattern}`;
+  else if (!this.deliveryPack) {
+    // for normal deployment to server, set config-dir so no other files in repo are unintentionally transferred
+    transferPattern = transferPattern.replace(/^config\/|^\//, '');
+    try { process.chdir('config'); }
+    catch(e) { _error('No config dir present!'); }
+  }
+
+  this.transferPatterns = [transferPattern, tdiPattern, ...this.giPatterns, '!**/*.crdownload']; // ignore patterns must come last
+
+  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);
+  this.replaceStrings = [
+    [/((xsd|xsl|src|iconsrc)="[^"?]+)"/g, `$1?_=${ts}"`, '**/xopus/xml/*'],
+    [/(schemaLocation="[^"?]+)"/g, `$1?_=${ts}"`, '**/xopus/xsd/*'],
+    [/(href="[^"?]+.xsl)"/g, `$1?_=${ts}"`, '**/xopus/xsl/*']
+  ];
+  // depending on env, enable debug mode and change track functionality
+  if (this.envDev) {
+    this.transferPatterns.push('!ldap.xml');
+    this.replaceStrings.push(
+      ['debug.on=false', 'debug.on=true', '**/util.js'],
+      ['debugMode>false', 'debugMode>true', '**/xopus/xml/*'],
+      ['allowAccept>false', 'allowAccept>true', '**/xopus/xml/*'],
+      ['allowReject>false', 'allowReject>true', '**/xopus/xml/*'],
+      [/(id="generateSampleText" available=")false/, '$1true', '**/xopus/xml/*']
+    );
+  }
+  else this.replaceStrings.push(['debugMode>true', 'debugMode>false', '**/xopus/xml/*']);
+
+  _info(`Branch: ${_git.commitLocal().branch}`);
+  _info(`Source: ${path.join(process.cwd(), transferPattern)}`);
+  _info(`Server: ${ftpConfig ? `${ftpConfig.host}:${ftpConfig.port}` : 'local'}`);
+  _info(`Target: ${this.getRemotePath(transferPattern)}`);
+  _write();
 
-    const {ftpConfig} = this.server;
-
-    if (ftpConfig.host && !(ftpConfig.port && ftpConfig.parallel && ftpConfig.username)) _error('Config is incomplete!');
-
-    this.localTransfer  = !ftpConfig.host;
-    this.deliveryPack   = serverConfig.mode == 'delivery-pack';
-    this.envDev         = this.localTransfer && !this.deliveryPack || /\.dev\.tangelo\.nl$/.test(ftpConfig.host);
-
-    if (this.deliveryPack) {
-      const dateStr = new Date().toISOString().replace(/(.*)T(\d+):(\d+):(\d+).*/g, '$1_$2$3$4');
-      this.deliveryPackName = `tangelo-config-delivery-pack_${_paths.repo.split(/[\\/]/).pop()}_${dateStr}`;
-      this.server.remotedir += '/' + this.deliveryPackName; // output to temp folder
-    }
-  },
-
-  prepareForCopy (filter) {
-    const {remotedir, ftpConfig} = this.server;
-    if (!path.isAbsolute(remotedir)) _error('"remotedir" must contain an absolute path!');
-
-    this.giPatterns = !fs.existsSync('.gitignore') ? [] :
-      fs.readFileSync('.gitignore').toString()
-        .trim()
-        .replace(/^#.+/gm, '') // remove comments
-        .split(/\s+/) // split on lines
-        .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 **
-    ;
-
-    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*\})?\/|\*\/)?\*\*/;
-    const tdiPattern  = tdiIncRegex.test(transferPattern) ? transferPattern.replace(tdiIncRegex, `${this.deliveryPack ? 'config/' : ''}cmscustom/tdi/**`) : 'nomatch';
-
-    if (!transferPattern)
-      _error('Invalid glob expression passed!');
-    else if (this.deliveryPack && transferPattern.startsWith('*'))
-      transferPattern = `{config,database,${_paths.tdi}/src/database/tdi}/${transferPattern}`;
-    else if (!this.deliveryPack) {
-      // for normal deployment to server, set config-dir so no other files in repo are unintentionally transferred
-      transferPattern = transferPattern.replace(/^config\/|^\//, '');
-      try { process.chdir('config'); }
-      catch(e) { _error('No config dir present!'); }
-    }
-
-    this.transferPatterns = [transferPattern, tdiPattern, ...this.giPatterns, '!**/*.crdownload']; // ignore patterns must come last
-
-    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);
-    this.replaceStrings = [
-      [/((xsd|xsl|src|iconsrc)="[^"?]+)"/g, `$1?_=${ts}"`, '**/xopus/xml/*'],
-      [/(schemaLocation="[^"?]+)"/g, `$1?_=${ts}"`, '**/xopus/xsd/*'],
-      [/(href="[^"?]+.xsl)"/g, `$1?_=${ts}"`, '**/xopus/xsl/*']
-    ];
-    // depending on env, enable debug mode and change track functionality
-    if (this.envDev) {
-      this.transferPatterns.push('!ldap.xml');
-      this.replaceStrings.push(
-        ['debug.on=false', 'debug.on=true', '**/util.js'],
-        ['debugMode>false', 'debugMode>true', '**/xopus/xml/*'],
-        ['allowAccept>false', 'allowAccept>true', '**/xopus/xml/*'],
-        ['allowReject>false', 'allowReject>true', '**/xopus/xml/*'],
-        [/(id="generateSampleText" available=")false/, '$1true', '**/xopus/xml/*']
-      );
-    }
-    else this.replaceStrings.push(['debugMode>true', 'debugMode>false', '**/xopus/xml/*']);
-
-    _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 (_git.commitLocal().date < _git.commitRemote().date) {
-      _warn(`You're not deploying from the most recent git commit!\n`);
-    }
+  if (_git.commitLocal().date < _git.commitRemote().date) {
+    _warn(`You're not deploying from the most recent git commit!\n`);
   }
+}
+
 
-};
+module.exports = {getRemotePath, setServer, prepareForCopy};

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   = [];
@@ -149,7 +150,7 @@ const transfer = (paths, lrServer) => {
   });
 
   // disable file logging for ftp (gulp-sftp does it already)
-  g_print.setLogFunction((filepath) => c.localTransfer ? _write(filepath.nostyle) : null);
+  g_print.setLogFunction(filepath => c.server.ftpConfig ? null : _write(filepath.nostyle));
 
   _info('Start transferring', true);
 
@@ -181,7 +182,7 @@ const transfer = (paths, lrServer) => {
       cb(null, file);
     }))
     .pipe(g_print.default())
-    .pipe(c.localTransfer ? gulp.dest(c.server.remotedir) : g_sftp(c.server.ftpConfig, c.server.remotedir))
+    .pipe(c.server.ftpConfig ? g_sftp(c.server.ftpConfig, c.server.remotedir) : gulp.dest(c.server.remotedir))
     .on('end', () => {
       _info('Finished transferring\n', true);
       if (fontoPaths.outdated[0]) _warn(`Fonto build files in the following folders were outdated and therefore skipped:\n  ${fontoPaths.outdated.map(v => v.slice(0, -1)).join('\n  ')}`);

package/src/modules/deploy/index.js

@@ -16,8 +16,8 @@ module.exports = function deploy (argv) {
   c.setServer(argv.server);
   c.prepareForCopy(argv.filter);
 
-  if (!c.localTransfer) {
-    c.server.ftpConfig.eventPut = (file) => {
+  if (c.server.ftpConfig) {
+    c.server.ftpConfig.eventPut = file => {
       _write(file.destination.replace(c.server.remotedir, ''));
       if      (path.extname(file.destination)=='.sh')
         remote.add('chmod 755 '+file.destination, 'Permissions set: '+file.destination);
@@ -64,7 +64,7 @@ module.exports = function deploy (argv) {
     };
 
     // check connection
-    if (!c.localTransfer) {
+    if (c.server.ftpConfig) {
       const sftp = new sftpClient();
       sftp.connect(c.server.ftpConfig).then(() => sftp.end()).catch(err => _error(`Could not connect to server${err ? ': '+err.message : ''}`));
     }
@@ -90,8 +90,8 @@ module.exports = function deploy (argv) {
           if (!path.parse(filepath).base.match(/\.scss/)) {
             const rp  = c.getRemotePath(filepath);
             const msg = 'Removed: ' + rp.replace(c.server.remotedir, '').white;
-            if (c.localTransfer) del([rp], {force: true}).then(() => _info(msg, true));
-            else remote.add(`rm -rf "${rp}"`, msg).process();
+            if (c.server.ftpConfig) remote.add(`rm -rf "${rp}"`, msg).process();
+            else del([rp], {force: true}).then(() => _info(msg, true));
           }
         }
       });

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/commands.js

@@ -279,7 +279,7 @@ module.exports = {
           });
         _write('Done.\n');
       })
-      .then(() => cmdExec(`${fdt} editor run --write-to-disk`))
+      .then(() => cmdExec(`${fdt} editor run --port 8888 --write-to-disk`))
     ;
   }
 

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,10 +52,10 @@ 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`);
+            _error(`Fonto version ${fontoVersionNew} is not compatible with the current TDI submodule commit!\nExecute: ${'tct fonto --init latest'.cyan}`);
           }
 
           _write(fontoVersionNew+'\n');