@tangelo/tangelo-configuration-toolkit 1.14.3 → 1.15.1

package/src/modules/info/index.js

@@ -1,201 +1,200 @@
-const fs      = require('fs-extra');
-const globby  = require('globby');
-const path    = require('path');
-const {Table} = require('console-table-printer');
-
-const execGitCommand  = require('../../lib/exec-git-command');
-const getTdiBranch    = require('../../lib/get-tdi-branch');
-const c               = require('../deploy/config');
-const {remote}        = require('../deploy/execute');
-
-
-const getGitInfo = () => {
-  // Version info TDI submodule
-  const gitSubmoduleInfo = new Table({
-    columns: [
-      {name: 'property', title: 'TDI - submodule', alignment: 'left'},
-      {name: 'value', alignment: 'left'}
-    ],
-  });
-
-  // Fetch all
-  const cmdFetch = execGitCommand('fetch -pf --all', path.join(_paths.repo, _paths.tdi));
-  if (cmdFetch.error) _warn(`Fetch failed\n${cmdFetch.error}`);
-
-  // Set branch name of firstBranch without 'remotes/origin/'
-  const tdiBranch = getTdiBranch();
-
-  // Get number of commits behind
-  tdiBranch.commitsBehind = execGitCommand(`rev-list HEAD...origin/${tdiBranch.name} --count`, path.join(_paths.repo, _paths.tdi));
-
-  // Create table rows for TDI submodule info
-  gitSubmoduleInfo.addRow({
-    property: 'Commit date',
-    value: _formatDate(_git.commitTdi.local().date)
-  });
-  if (tdiBranch) {
-    gitSubmoduleInfo.addRow({
-      property: 'Branch',
-      value: tdiBranch.name
-    });
-    gitSubmoduleInfo.addRow({
-      property: 'Commits behind',
-      value: tdiBranch.commitsBehind
-    });
-  } else {
-    gitSubmoduleInfo.addRow({
-      property: 'Branch could not be determined',
-      value: ''
-    });
-  }
-
-  // Print TDI submodule info
-  gitSubmoduleInfo.printTable();
-};
-
-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'},
-      {name: 'type', alignment: 'left'},
-      {name: 'version', alignment: 'left'},
-      {name: 'sort'}
-    ],
-    disabledColumns: ['sort'],
-    sort: (a, b) => a.sort.toLowerCase() > b.sort.toLowerCase() ? 1 : -1
-  });
-
-  if (fs.existsSync(versionInfoConfigPath)) {
-    const config = require(versionInfoConfigPath);
-
-    config.forEach(v => {
-      const location = path.join(_paths.repo, v.glob);
-
-      globby
-        .sync(location)
-        .forEach(f => {
-          const filePathExtract = f.match(/.*(?<path>(cmscustom|site-stylesheets)\/(?<customer>[^/]*)\/(?<project>[^/]*)\/.*)/);
-          const path = filePathExtract.groups.path || '';
-          const project = filePathExtract.groups.project || '';
-
-          const fileContent = fs.readFileSync(f).toString();
-          v.extracts.forEach(e => {
-            const extract = fileContent.match(e.regex);
-            if (extract) {
-              projects.add(project); // Store the projects where versioninfo is found
-              types.add(e.type); // Store the types for which versioninfo is found
-              versionInfo.addRow({ // Create row with version information to output
-                path,
-                sort: `${sorting=='project' ? project : e.type}_2${sorting=='project' ? e.type : extract.groups.version}`, // Output is sorted on project or type: '_2' ensures it is rendered after the empty row and the row with the project name
-                type: e.type,
-                version: extract.groups.version
-              });
-            }
-          });
-        });
-    });
-
-    if (sorting=='project') {
-      // For projects containing version information
-      projects.forEach(p => {
-        versionInfo.addRow({ // Add empty row after project
-          path: '',
-          sort: `${p}_3`,
-          type: '',
-          version: ''
-        });
-        versionInfo.addRow({ // Add row with project name
-          path: `-- ${p}:`,
-          sort: `${p}_1`,
-          type: '',
-          version: ''
-        }, {
-          color: 'yellow'
-        });
-      });
-    }
-    else if (sorting=='type') {
-      types.forEach(t => {
-        versionInfo.addRow({ // Add empty row after type
-          path: '',
-          sort: `${t}_3`,
-          type: '',
-          version: ''
-        });
-      });
-    }
-    versionInfo.printTable();
-  }
-  else {
-    _warn('Version info of miscellaneous items cannot be extracted:\nCannot find required files in TDI submodule. Try updating TDI submodule.');
-  }
-};
-
-const getServerInfo = (server) => {
-  // Remote server info
-  // common setup
-  _write();
-  c.setServer(server);
-
-  if (!c.envDev) {
-    _info(`Remote version info for '${c.server.ftpConfig.host}':\n`);
-    remote.add('sudo ~root/scripts/version.sh', '').process();
-  }
-  else {
-    _info('For development environments no server version information is available. Check rancher / database for this information.\nAdd the --server option with a non-dev environment to see version information for that server.');
-  }
-};
-
-
-module.exports = function info (argv) {
-
-  if (argv.doctypes) {
-    _info('Document type information for this git repository\n');
-
-    const doctypesInfo = new Table({
-      columns: [
-        {name: 'id', alignment: 'right'},
-        {name: 'name', alignment: 'left'},
-        {name: 'paths', alignment: 'left'}
-      ],
-    });
-
-    globby
-      .sync(_paths.repo + '/database/config/**/txd_document_types.sql')
-      .forEach((p, i, a) => {
-        fs.readFileSync(p).toString().match(/select([\s\S]+?)from\s+dual/gmi)
-          .forEach((dtRow, i, a) => {
-            const ntSqlInsert = fs.readFileSync(p.replace('txd_document_types', 'txd_node_types')).toString().match(/select(.*?)from\s+dual/s)[1];
-            const id      = dtRow.match(/(\d+) id/)?.[1];
-            const name    = dtRow.match(/'([^']+)' display_name/)?.[1];
-            const dbPath  = p.match(/(database\/config\/(:?.*)\/)txd_document_types.sql/i)?.[1];
-            const prPath  = ntSqlInsert.match(/'([^']+)' xsl_prep_inc/)[1].replace('prepare_xincludes.xsl', '');
-
-            doctypesInfo.addRows([
-              {id, name, paths: 'config/cmscustom/'+ prPath},
-              {paths: dbPath}
-            ]);
-
-            if (i!==a.length-1) doctypesInfo.addRow({});
-          });
-
-        if (i!==a.length-1) doctypesInfo.addRow({});
-      });
-
-
-    doctypesInfo.printTable();
-  }
-
-  if (argv.versions) {
-    _info('Version information for this git repository\n');
-
-    getGitInfo();
-    getFileExtractInfo(argv.versions);
-    getServerInfo(argv.server);
-  }
-
-};
+const fs      = require('fs-extra');
+const globby  = require('globby');
+const path    = require('path');
+const {Table} = require('console-table-printer');
+
+const execGitCommand  = require('../../lib/exec-git-command');
+const getTdiBranch    = require('../../lib/get-tdi-branch');
+const c               = require('../deploy/config');
+const {remote}        = require('../deploy/execute');
+
+
+const getGitInfo = () => {
+  // Version info TDI submodule
+  const gitSubmoduleInfo = new Table({
+    columns: [
+      {name: 'property', title: 'TDI - submodule', alignment: 'left'},
+      {name: 'value', alignment: 'left'}
+    ],
+  });
+
+  // Fetch all
+  const cmdFetch = execGitCommand('fetch -pf --all', path.join(_paths.repo, _paths.tdi));
+  if (cmdFetch.error) _warn(`Fetch failed\n${cmdFetch.error}`);
+
+  // Set branch name of firstBranch without 'remotes/origin/'
+  const tdiBranch = getTdiBranch();
+
+  // Get number of commits behind
+  tdiBranch.commitsBehind = execGitCommand(`rev-list HEAD...origin/${tdiBranch.name} --count`, path.join(_paths.repo, _paths.tdi));
+
+  // Create table rows for TDI submodule info
+  gitSubmoduleInfo.addRow({
+    property: 'Commit date',
+    value: _formatDate(_git.commitTdi.local().date)
+  });
+  if (tdiBranch) {
+    gitSubmoduleInfo.addRow({
+      property: 'Branch',
+      value: tdiBranch.name
+    });
+    gitSubmoduleInfo.addRow({
+      property: 'Commits behind',
+      value: tdiBranch.commitsBehind
+    });
+  } else {
+    gitSubmoduleInfo.addRow({
+      property: 'Branch could not be determined',
+      value: ''
+    });
+  }
+
+  // Print TDI submodule info
+  gitSubmoduleInfo.printTable();
+};
+
+const getFileExtractInfo = (sorting) => {
+  // version info miscellaneous
+  const projects = new Set;
+  const types = new Set;
+  const versionInfo = new Table({
+    columns: [
+      {name: 'path', alignment: 'left'},
+      {name: 'type', alignment: 'left'},
+      {name: 'version', alignment: 'left'},
+      {name: 'sort'}
+    ],
+    disabledColumns: ['sort'],
+    sort: (a, b) => a.sort.toLowerCase() > b.sort.toLowerCase() ? 1 : -1
+  });
+
+  const versionInfoConfig = _modulesTdi.require('version/versionInfo.js');
+  if (versionInfoConfig) {
+
+    versionInfoConfig.forEach(v => {
+      const location = path.join(_paths.repo, v.glob);
+
+      globby
+        .sync(location)
+        .forEach(f => {
+          const filePathExtract = f.match(/.*(?<path>(cmscustom|site-stylesheets)\/(?<customer>[^/]*)\/(?<project>[^/]*)\/.*)/);
+          const path = filePathExtract.groups.path || '';
+          const project = filePathExtract.groups.project || '';
+
+          const fileContent = fs.readFileSync(f).toString();
+          v.extracts.forEach(e => {
+            const extract = fileContent.match(e.regex);
+            if (extract) {
+              projects.add(project); // Store the projects where versioninfo is found
+              types.add(e.type); // Store the types for which versioninfo is found
+              versionInfo.addRow({ // Create row with version information to output
+                path,
+                sort: `${sorting=='project' ? project : e.type}_2${sorting=='project' ? e.type : extract.groups.version}`, // Output is sorted on project or type: '_2' ensures it is rendered after the empty row and the row with the project name
+                type: e.type,
+                version: extract.groups.version
+              });
+            }
+          });
+        });
+    });
+
+    if (sorting=='project') {
+      // For projects containing version information
+      projects.forEach(p => {
+        versionInfo.addRow({ // Add empty row after project
+          path: '',
+          sort: `${p}_3`,
+          type: '',
+          version: ''
+        });
+        versionInfo.addRow({ // Add row with project name
+          path: `-- ${p}:`,
+          sort: `${p}_1`,
+          type: '',
+          version: ''
+        }, {
+          color: 'yellow'
+        });
+      });
+    }
+    else if (sorting=='type') {
+      types.forEach(t => {
+        versionInfo.addRow({ // Add empty row after type
+          path: '',
+          sort: `${t}_3`,
+          type: '',
+          version: ''
+        });
+      });
+    }
+    versionInfo.printTable();
+  }
+  else {
+    _warn('Version info of miscellaneous items cannot be extracted:\nCannot find required files in TDI submodule. Try updating TDI submodule.');
+  }
+};
+
+const getServerInfo = (server) => {
+  // Remote server info
+  // common setup
+  _write();
+  c.setServer(server);
+
+  if (!c.envDev) {
+    _info(`Remote version info for '${c.server.ftpConfig.host}':\n`);
+    remote.add('sudo ~root/scripts/version.sh', '').process();
+  }
+  else {
+    _info('For development environments no server version information is available. Check rancher / database for this information.\nAdd the --server option with a non-dev environment to see version information for that server.');
+  }
+};
+
+
+module.exports = function info (argv) {
+
+  if (argv.doctypes) {
+    _info('Document type information for this git repository\n');
+
+    const doctypesInfo = new Table({
+      columns: [
+        {name: 'id', alignment: 'right'},
+        {name: 'name', alignment: 'left'},
+        {name: 'paths', alignment: 'left'}
+      ],
+    });
+
+    globby
+      .sync(_paths.repo + '/database/config/**/txd_document_types.sql')
+      .forEach((p, i, a) => {
+        fs.readFileSync(p).toString().match(/select([\s\S]+?)from\s+dual/gmi)
+          .forEach((dtRow, i, a) => {
+            const ntSqlInsert = fs.readFileSync(p.replace('txd_document_types', 'txd_node_types')).toString().match(/select(.*?)from\s+dual/s)[1];
+            const id      = dtRow.match(/(\d+) id/)?.[1];
+            const name    = dtRow.match(/'([^']+)' display_name/)?.[1];
+            const dbPath  = p.match(/(database\/config\/(:?.*)\/)txd_document_types.sql/i)?.[1];
+            const prPath  = ntSqlInsert.match(/'([^']+)' xsl_prep_inc/)[1].replace('prepare_xincludes.xsl', '');
+
+            doctypesInfo.addRows([
+              {id, name, paths: 'config/cmscustom/'+ prPath},
+              {paths: dbPath}
+            ]);
+
+            if (i!==a.length-1) doctypesInfo.addRow({});
+          });
+
+        if (i!==a.length-1) doctypesInfo.addRow({});
+      });
+
+
+    doctypesInfo.printTable();
+  }
+
+  if (argv.versions) {
+    _info('Version information for this git repository\n');
+
+    getGitInfo();
+    getFileExtractInfo(argv.versions);
+    getServerInfo(argv.server);
+  }
+
+};

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,36 +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: v3.2.0
-  hooks:
-  - id: trailing-whitespace
-  - id: check-json
-  - id: check-xml
-  - 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.9.0
-  hooks:
-  - id: text-unicode-replacement-char # forbid files which have a UTF-8 Unicode replacement character
-
-- repo: https://github.com/crate-ci/typos
-  rev: v1.12.14
-  hooks:
-  - id: typos # spell checker
-
-- repo: https://github.com/macisamuele/language-formatters-pre-commit-hooks
-  rev: v2.4.0
-  hooks:
-  - id: pretty-format-yaml
-    args: [--autofix, --indent, '2']
-
-- repo: https://github.com/pre-commit/mirrors-eslint
-  rev: v8.28.0
-  hooks:
-  - id: eslint # javascript linter and formatter
-    args: [--fix]

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:1.4.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