@tangelo/tangelo-configuration-toolkit 1.14.4 → 1.15.1

package/index.js

@@ -124,9 +124,34 @@ else {
 }
 
 
-global._tdiSubmoduleExists = fs.existsSync(path.join(_paths.repo, _paths.tdi));
-global._isPre42 = fs.existsSync(path.join(_paths.repo, _paths.tdi, 'create_new_project')); // folder changed in 4.2
-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)
+global._tdiSubmoduleExists = () => fs.existsSync(path.join(_paths.repo, _paths.tdi));
+global._isPre42 = () => fs.existsSync(path.join(_paths.repo, _paths.tdi, 'create_new_project')); // folder changed in 4.2
+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)
+
+global._modulesTdi = {
+  absolutePathTdi: path.join(_paths.repo, _paths.tdi),
+  ensureDepsUpToDate() {
+    if (this.depsUpToDate) return;
+    try {
+      _info('Checking installed dependencies in submodule');
+      execSync('npm list', {cwd: this.absolutePathTdi, stdio: 'ignore'});
+    } catch (e) {
+      _info('Updating dependencies in submodule');
+      execSync('npm update', {cwd: this.absolutePathTdi, stdio: 'ignore'});
+    }
+    this.depsUpToDate = true;
+  },
+  require(module) {
+    this.ensureDepsUpToDate();
+    _info(`Loading ${path.join(_paths.tdi, 'tct', module)}\n`);
+    try {
+      return require(path.join(this.absolutePathTdi, 'tct', module));
+    }
+    catch (e) {
+      _error('Module could not be loaded');
+    }
+  }
+};
 
 
 process.on('beforeExit', () => {

package/package.json

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

package/src/cli.js

@@ -119,10 +119,9 @@ module.exports = function cli () {
       ['$0 git --update tdi --branch 5.4', 'Update TDI submodule to latest in specified branch']
     ])
     .check((argv, options) => {
-      const passedOpts  = Object.keys(argv).filter(k => !['_', '$0', 'server', 's', 'filter', 'f', 'branch', 'b'].includes(k)); // also filter options with defaults
-      const hasOpts     = Object.keys(options)[0];
-      if (hasOpts && !passedOpts[0]) yargs.showHelp();
-      return true;
+      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");
     })
     .strict()
     .wrap(100)

package/src/modules/build/index.js

@@ -17,7 +17,7 @@ const createSymlink = (t, p) => {
 
 const createSymlinks = () => {
   _info('Creating symlinks:');
-  const src = _isPre51 ? 'sources' : 'src';
+  const src = _isPre51() ? 'sources' : 'src';
   createSymlink(src + '/config/cmscustom/tdi', 'config/cmscustom/tdi');
   globby
     .sync('config/cmscustom/!(tdi)/**/fonto')
@@ -30,15 +30,15 @@ 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 (_isPre51()) _error('This option only works when using branch release/5.1 and up.');
 
-    require(path.join(_paths.repo, _paths.tdi, 'tct/build/init'))(createSymlinks);
+    _modulesTdi.require('build/init')(createSymlinks);
   }
 
   if (argv.project) {
-    if (_isPre51) _error('This option only works when using branch release/5.1 and up.');
+    if (_isPre51()) _error('This option only works when using branch release/5.1 and up.');
 
-    const {projectNew, projectCopy} = require(path.join(_paths.repo, _paths.tdi, 'tct/build/project'));
+    const {projectNew, projectCopy} = _modulesTdi.require('build/project');
 
     inquirer
       .prompt([{

package/src/modules/build/oxygen.js

@@ -3,14 +3,16 @@ const globby  = require('globby');
 const path    = require('path');
 const SaxonJS = require('saxon-js');
 
-const spConfigPath  = path.join(_paths.repo, _paths.tdi, 'tct/build/oxygen/stylesheetPaths.json');
-const sefFilePath   = path.join(_paths.repo, _paths.tdi, 'tct/build/oxygen/createProjectFile.sef.json');
+const spConfigPath  = 'build/oxygen/stylesheetPaths.json';
+const sefFilePath   = 'build/oxygen/createProjectFile.sef.json';
 const cmscustomPath = 'config/cmscustom/';
 const siteStylesheetsPath = 'config/txp/site-stylesheets/';
 
 const masterFiles = new Set;
 const transformationScenarios = [];
 
+let spConfig, sefFile;
+
 const convertToValidFilename = string => string.replace(/[/|\\:*?"<>]/g, ' ');
 
 const createProjectFile = (config, newXprFile) => {
@@ -143,7 +145,7 @@ const transformXprFile = xprFiles => {
     // Transform xpr; add masterfiles and transformationScenarios as parameters of the stylesheet
       _write(`${xprFile}\n`);
       SaxonJS.transform({
-        stylesheetText: fs.readFileSync(sefFilePath),
+        stylesheetText: JSON.stringify(sefFile),
         stylesheetBaseURI: 'createProjectFile.sef.json',
         sourceFileName: path.join(_paths.repo, xprFile),
         destination: 'serialized',
@@ -166,10 +168,11 @@ module.exports = function oxygen (arg) {
   // - Will try to preserve manually added entries in the transformation scenarios and masterfiles
   // - Will remove non existing masterfiles or masterfiles that start with a '_'
 
-  if (!fs.existsSync(spConfigPath) || !fs.existsSync(sefFilePath)) {
-    _error(`Cannot find required files in TDI submodule. Try updating TDI submodule.`);
-  }
+  spConfig = _modulesTdi.require(spConfigPath);
+  sefFile = _modulesTdi.require(sefFilePath);
+
+  if (!spConfig || !sefFile) _error(`Cannot find required files in TDI submodule. Try updating TDI submodule.`);
 
   const newXprFile = (typeof arg === 'string') ? convertToValidFilename(arg) + '.xpr' : null;
-  createProjectFile(require(spConfigPath), newXprFile);
+  createProjectFile(spConfig, newXprFile);
 };

package/src/modules/fonto/index.js

@@ -5,13 +5,13 @@ 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 fdtCommand = fv => `npx -y ${_packages.FDT.name}@${fv.replace(/^(7\.|8\.[012]\.).*/, '3.12.0')}`;
 
 module.exports = function fonto (argv) {
 
   const allowedFontoVersionRegex = (() => {
-    const cfvPath = path.join(_paths.repo, _paths.tdi, 'tct/fonto/compatibleVersions.json');
-    if (fs.pathExistsSync(cfvPath)) return RegExp(fs.readJsonSync(cfvPath).regex);
+    const cvRegex = _modulesTdi.require('fonto/compatibleVersions.json')?.regex;
+    if (cvRegex) return RegExp(cvRegex);
 
     // old way: a regex for each basecommit is stored in global._git.commitTdi
     for (const fv of _git.commitTdi.fontoVersions) {
@@ -19,7 +19,7 @@ module.exports = function fonto (argv) {
     }
   })();
 
-  if (!_tdiSubmoduleExists) _error('TDI submodule folder is missing.');
+  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))) {
@@ -30,8 +30,8 @@ module.exports = function fonto (argv) {
 
   // find fonto instances by searching for fonto/manifest.json files
   const fontoPaths = globby.sync(['**/fonto/manifest.json', 'manifest.json', `!${_paths.tdi}/**`])
-    .map(p => ([p.replace('manifest.json', ''), fs.readJsonSync(p).sdkVersion.replace(/Nightlies.*/, 'nightly')])
-    );
+    .map(p => ([p.replace('manifest.json', ''), fs.readJsonSync(p).sdkVersion.replace(/Nightlies.*/, 'nightly')]))
+  ;
 
   if (fontoPaths.length===0) _error('No Fonto instance found.');
 
@@ -43,14 +43,14 @@ module.exports = function fonto (argv) {
       .then(() => {
         process.chdir(path.join(_paths.repo, _paths.apply, fontoPath));
 
-        if (fontoPath!='.') _info(`${i>0 ? '\n' : ''}Fonto instance #${i+1}: ${path.join(_paths.apply, fontoPath)}\n`);
+        if (fontoPath !== '.') _info(`${i>0 ? '\n' : ''}Fonto instance #${i+1}: ${path.join(_paths.apply, fontoPath)}\n`);
 
         // execute commands sequentially and in correct order
-        return new Promise((resolve) => {
+        return new Promise(resolve => {
           _info('Determining Fonto version:');
           let fontoVersionNew = typeof argv.init == 'string' ? argv.init : fontoVersionCurrent;
 
-          if (fontoVersionNew == 'latest') {
+          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];
           }

package/src/modules/git/index.js

@@ -36,7 +36,6 @@ const cmdExec = commands => new Promise(resolve => {
   });
 });
 
-const tdiMigrationFilePath  = path.join(_paths.repo, _paths.tdi, 'tct/git/tdiCommitsRequiringMigration.js');
 
 module.exports = function git (argv) {
 
@@ -143,8 +142,8 @@ module.exports = function git (argv) {
         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
-        if (fs.existsSync(tdiMigrationFilePath)) {
-          const migrations = require(tdiMigrationFilePath);
+        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 toTdiDate = tdiToDateCustom ? new Date(tdiToDateCustom) : new Date();
 

package/src/modules/info/index.js

@@ -57,7 +57,6 @@ const getFileExtractInfo = (sorting) => {
   // version info miscellaneous
   const projects = new Set;
   const types = new Set;
-  const versionInfoConfigPath  = path.join(_paths.repo, _paths.tdi, 'tct/version/versionInfo.js');
   const versionInfo = new Table({
     columns: [
       {name: 'path', alignment: 'left'},
@@ -69,10 +68,10 @@ const getFileExtractInfo = (sorting) => {
     sort: (a, b) => a.sort.toLowerCase() > b.sort.toLowerCase() ? 1 : -1
   });
 
-  if (fs.existsSync(versionInfoConfigPath)) {
-    const config = require(versionInfoConfigPath);
+  const versionInfoConfig = _modulesTdi.require('version/versionInfo.js');
+  if (versionInfoConfig) {
 
-    config.forEach(v => {
+    versionInfoConfig.forEach(v => {
       const location = path.join(_paths.repo, v.glob);
 
       globby

package/src/modules/migrate/index.js

@@ -4,7 +4,7 @@ const path      = require('path');
 
 
 module.exports = function migrate (argv) {
-  if (_isPre51) _error('This command only works when using branch release/5.1 and up.');
+  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
 
@@ -76,8 +76,8 @@ module.exports = function migrate (argv) {
           _write();
           const startTime = new Date();
 
-          const scriptPath = path.join(_paths.repo, _paths.tdi, 'tct/migrate', a.script);
-          require(scriptPath).forEach(step => require('./steps')(step, argv.dry, filter));
+          const scriptPath = path.join('migrate', a.script);
+          _modulesTdi.require(scriptPath).forEach(step => require('./steps')(step, argv.dry, filter));
 
           _perf(startTime);
         });

package/src/modules/sql/index.js

@@ -43,7 +43,7 @@ module.exports = function sql (argv) {
 
   if (argv.install) {
     // tdi
-    const dir = `${_paths.tdi}/${_isPre51 ? 'sources' : 'src'}/database/tdi/${_isPre42 ? 'install/' : ''}`;
+    const dir = `${_paths.tdi}/${_isPre51() ? 'sources' : 'src'}/database/tdi/${_isPre42() ? 'install/' : ''}`;
     runSqlScript(dir + 'install.sql');
     checkLog(dir + 'tdi-install.log', false);
     // custom
@@ -96,7 +96,7 @@ module.exports = function sql (argv) {
   }
 
   if (argv.generate) {
-    const dir = _paths.tdi + (_isPre51 ? '/util/db-config-generator/' : '/tct/sql/generate/');
+    const dir = _paths.tdi + (_isPre51() ? '/util/db-config-generator/' : '/tct/sql/generate/');
     fs.ensureSymlinkSync(_paths.apply, dir + 'dist', 'junction');
     runSqlScript(dir + 'start.sql');
     fs.removeSync(dir + 'dist');
@@ -104,7 +104,7 @@ module.exports = function sql (argv) {
   }
 
   if (argv.remove) {
-    const dir = _paths.tdi + (_isPre51 ? '/util/db-config-remover/' : '/tct/sql/remove/');
+    const dir = _paths.tdi + (_isPre51() ? '/util/db-config-remover/' : '/tct/sql/remove/');
     runSqlScript(dir + 'start.sql');
     checkLog(dir + 'remove-config.log');
   }

package/.eslintrc.js

@@ -1,47 +0,0 @@
-module.exports = {
-  'env': {
-    'browser': true,
-    'commonjs': true,
-    'es2021': true
-  },
-  'extends': 'eslint:recommended',
-  'overrides': [],
-  'parserOptions': {'ecmaVersion': 'latest'},
-  'globals': {
-    'process': 'readonly',
-    'Buffer': 'readonly',
-    '__dirname': 'readonly',
-    '_write': 'writable',
-    '_info': 'writable',
-    '_warn': 'writable',
-    '_formatDate': 'writable',
-    '_error': 'writable',
-    '_perf': 'writable',
-    '_paths': 'writable',
-    '_appdata': 'writable',
-    '_packages': 'writable',
-    '_appconfig': 'writable',
-    '_git': 'writable',
-    '_repoconfig': 'writable',
-    '_tdiSubmoduleExists': 'writable',
-    '_isPre42': 'writable',
-    '_isPre51': 'writable'
-  },
-  'rules': {
-    'no-var': ['error'],
-    'indent': ['error', 2],
-    'quotes': [
-      'error',
-      'single',
-      {'avoidEscape': true, 'allowTemplateLiterals': true}
-    ],
-    'semi': ['error', 'always'],
-    'comma-style': ['error', 'last'],
-    'array-bracket-spacing': ['error', 'never'],
-    'object-curly-spacing': ['error', 'never'],
-    'key-spacing': ['error'],
-    'comma-spacing': ['error'],
-    'rest-spread-spacing': ['error', 'never'],
-    'spaced-comment': ['error', 'always'],
-  }
-};

package/.pre-commit-config.yaml

@@ -1,35 +0,0 @@
-# See https://pre-commit.com for more information
-# See https://pre-commit.com/hooks.html for more hooks
-
-repos:
-
-- repo: https://github.com/pre-commit/pre-commit-hooks
-  rev: v4.4.0
-  hooks:
-  - id: trailing-whitespace
-  - id: check-json
-  - id: check-merge-conflict # checks for files that contain merge conflict strings
-  - id: check-added-large-files
-    args: [--maxkb=100]
-
-- repo: https://github.com/pre-commit/pygrep-hooks
-  rev: v1.10.0
-  hooks:
-  - id: text-unicode-replacement-char # forbid files which have a UTF-8 Unicode replacement character
-
-- repo: https://github.com/macisamuele/language-formatters-pre-commit-hooks
-  rev: v2.10.0
-  hooks:
-  - id: pretty-format-yaml
-    args: [--autofix, --indent, '2']
-
-- repo: https://github.com/pre-commit/mirrors-eslint
-  rev: v8.49.0
-  hooks:
-  - id: eslint # javascript linter and formatter
-    args: [--fix]
-
-- repo: https://github.com/crate-ci/typos
-  rev: v1.16.11
-  hooks:
-  - id: typos # spell checker

package/.vscode/settings.json

@@ -1,6 +0,0 @@
-{
-  "sonarlint.connectedMode.project": {
-    "connectionId": "tangelosoftware",
-    "projectKey": "tangelosoftware_tangelo-configuration-toolkit"
-  }
-}

package/bitbucket-pipelines.yml

@@ -1,32 +0,0 @@
-image: atlassian/default-image:4
-
-clone:
-  depth: full # SonarCloud scanner needs the full history to assign issues properly
-
-definitions:
-  caches:
-    sonar: ~/.sonar/cache # Caching SonarCloud artifacts will speed up your build
-  services:
-    docker:
-      memory: 2048 # For large file line code
-  steps:
-  - step: &build-test-sonarcloud
-      name: Build, test and analyze on SonarCloud
-      caches:
-      - sonar
-      script:
-      - pipe: sonarsource/sonarcloud-scan:2.0.0
-  - step: &check-quality-gate-sonarcloud
-      name: Check the Quality Gate on SonarCloud
-      script:
-      - pipe: sonarsource/sonarcloud-quality-gate:0.1.6
-
-pipelines:
-  branches:
-    master:
-    - step: *build-test-sonarcloud
-    - step: *check-quality-gate-sonarcloud
-  pull-requests:
-    '**':
-    - step: *build-test-sonarcloud
-    - step: *check-quality-gate-sonarcloud