@tangelo/tangelo-configuration-toolkit 1.14.0 → 1.14.2

package/.vscode/settings.json

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

package/package.json

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

package/src/lib/get-tdi-branch.js

@@ -3,16 +3,19 @@ const path           = require('path');
 
 module.exports = function getTdiBranch(toBranchName) {
   const tdiBranch = {};
+  // Fetch all
+  _info(`Fetch TDI submodule`);
+  const cmdFetch = execGitCommand('fetch -pf --all', path.join(_paths.repo, _paths.tdi));
+  if (cmdFetch.error) _warn(`Fetch failed\n${cmdFetch.error}`);
+
   let toBranch;
   if (toBranchName) {
     // Check if specified branch exists; we will update to this branch
-    toBranch = String(toBranchName).replace(/(?:release\/)?(\d+(?:\.[\dx]+)*)/, `release/$1`);
+    toBranch = String(toBranchName).replace(/(?:release\/)?(\d+(?:\.[\dxt]+)*)/, `release/$1`);
     const branchExists = execGitCommand(`branch --remote`, path.join(_paths.repo, _paths.tdi)).match(`origin/${toBranch}`);
     if (!branchExists) _error(`TDI branch "${toBranch}" does not exist. Note that TCT can only update to a release branch.`);
   }
 
-  // Get the current TDI branch:
-
   // Get remote release branches containing TDI HEAD commit
   const releaseBranches = execGitCommand(`branch --all --contains ${_git.commitTdi.local().hash}`, path.join(_paths.repo, _paths.tdi)).match(/remotes\/origin\/release\/[^\s]+/gsm);
   if (!releaseBranches || releaseBranches.error) _error(`Could not retrieve TDI release branches`);

package/src/modules/build/index.js

@@ -9,7 +9,7 @@ const createSymlink = (t, p) => {
   fs.symlink(path.join(up, _paths.tdi, t), p, 'dir', err => {
     if (err) {
       if (err.code=='EEXIST') _write(`Symlink already exists: ${p}`);
-      else _error((err.code=='EPERM' ? 'Start your console as admin for symlink creation!' : err));
+      else _error((err.code!=='EPERM' ? err : `Can't create symlinks, restart your console as admin, or fix it permanently:\n  1. Open 'Local Security Policy' (secpol.msc)\n  2. Go to 'Security Settings > Local Policies > User Rights Assignment > Create symbolic links'\n  3. Add your own account\n  4. Restart Windows`));
     }
     else _write(`Symlink created: ${p}`);
   });
@@ -112,5 +112,5 @@ module.exports = function build (argv) {
       });
   }
 
-  if (argv.oxygen) oxygen();
+  if (argv.oxygen) oxygen(argv.oxygen);
 };

package/src/modules/build/oxygen.js

@@ -11,18 +11,25 @@ const siteStylesheetsPath = 'config/txp/site-stylesheets/';
 const masterFiles = new Set;
 const transformationScenarios = [];
 
-const convertToValidFilename = (string) => string.replace(/[\/|\\:*?"<>]/g, " ");
+const convertToValidFilename = (string) => string.replace(/[/|\\:*?"<>]/g, ' ');
 
-const createProjectFile = (config) => {
+const createProjectFile = (config, filename) => {
   _info('Initializing xpr file(s):');
-  const xprFiles = globby.sync(`*.xpr`);
+  const xprFiles = [...globby.sync(`*.xpr`)];
+  const newXprFile = (typeof filename === 'string') ? convertToValidFilename(filename) + '.xpr' : null;
+  // Add newXprFile at the start of xprFiles if it does not already exists:
+  if (xprFiles.indexOf(newXprFile)===-1) xprFiles.unshift(newXprFile);
 
   // Copy xpr file from TDI if it does not exists yet;
-  if (xprFiles[0]) _write(`Found: ${xprFiles.join(', ')}`);
+  if (xprFiles[0] && !newXprFile) _write(`Found: ${xprFiles.join(', ')}`);
   else {
-    const customers = new Set;
-    _repoconfig.forEach(p => customers.add(p.customer_name));
-    xprFiles.push(convertToValidFilename([...customers].join(' - ')) + '.xpr');
+    if (!newXprFile) {
+      // Set xpr filename to customer name (assumes correct upsert scripts structure)
+      const customers = new Set;
+      _repoconfig.forEach(p => customers.add(p.customer_name));
+      xprFiles.push(convertToValidFilename([...customers].join(' - ')) + '.xpr');
+    }
+    // Copy new xpr file
     fs.copySync(path.join(_paths.repo, 'tangelo-default-implementation/src/[customer].xpr'), path.join(_paths.repo, xprFiles[0]));
     _write(`Created: '${xprFiles[0]}'`);
   }
@@ -60,7 +67,7 @@ const getTransformations = (config) => {
         const fileString = fs.readFileSync(f).toString();
         const baseStrings = fileString.match(RegExp(config.extracts.base, 'gm'));
 
-        if (fileString.replace(/\s|^prompt\s.*$/gm,'')!=='') {
+        if (fileString.replace(/\s|^prompt\s.*$/gm, '')!=='') {
           if (baseStrings) {
             baseStrings.forEach(s => {
             // extract type, name, files info from baseString
@@ -97,7 +104,7 @@ const getMasterfiles = (config) => {
     .forEach(cf => {
     // Check if masterfile should be extracted from file
       const fileString = fs.readFileSync(cf).toString();
-      if (fileString.replace(/\s|^prompt\s.*$/gm,'')!=='') {
+      if (fileString.replace(/\s|^prompt\s.*$/gm, '')!=='') {
         if (config.extracts) {
         // extract baseStrings from file
           const baseStrings = fileString.match(RegExp(config.extracts.base, 'gm'));
@@ -155,7 +162,7 @@ const transformXprFile = (xprFiles) => {
 };
 
 
-module.exports = function oxygen () {
+module.exports = function oxygen (filename) {
   // Set projects transformation scenarios and masterfiles in oXygen project file
   // - Will try to preserve manually added entries in the transformation scenarios and masterfiles
   // - Will remove non existing masterfiles or masterfiles that start with a '_'
@@ -164,5 +171,5 @@ module.exports = function oxygen () {
     _error(`Cannot find required files in TDI submodule. Try updating TDI submodule.`);
   }
 
-  createProjectFile(require(spConfigPath));
+  createProjectFile(require(spConfigPath), filename);
 };

package/src/modules/git/index.js

@@ -67,13 +67,13 @@ module.exports = function git (argv) {
         _write();
         cmdExec([
           ['git init', 'Initialize repo:'],
-          [`git remote add origin git@${_paths.gitremote.replace(/\//, ':')}/${path.basename(process.cwd())}.git`],
+          [`git remote add origin ${_paths.gitremote.replace(/\//, ':')}/${path.basename(process.cwd()).replace(/\W/, '-')}.git`],
           [`git submodule add -b ${a.branch} ${remoteTdiUrl}`, 'Add TDI submodule:'],
           ['git commit -m "added tdi submodule"', 'Commit:']
         ])
           .then(() => {
             _info(`Next steps:
-          1. Go to https://bitbucket.org/repo/create?workspace=tangelosoftware and create a repository named "${path.basename(process.cwd())}", with options for including README/.gitignore disabled.
+          1. Go to https://bitbucket.org/repo/create?workspace=tangelosoftware and create a repository named "${path.basename(process.cwd()).replace(/\W/, '-')}", with options for including README/.gitignore disabled.
           2. Open this folder in Sourcetree (ctrl+O), and push master branch to origin.
         `.replace(/^\s{8}/gm, ''));
           });
@@ -104,6 +104,8 @@ module.exports = function git (argv) {
           ['git submodule update --init', 'Fetch submodules such as TDI'],
           // Create symlinks for TDI
           ['tct b -s', 'Create TDI symlinks'],
+          // Create Oxygen project file and set name equal to repo name
+          [`tct b -x ${argv.clone}`, 'Create Oxygen project file'],
         ]);
       }).catch((e) => {
       // Show warnings for missing, expected, system environment variables
@@ -124,8 +126,9 @@ module.exports = function git (argv) {
     if (update === `tdi`) {
 
       const tdiBranch = getTdiBranch(argv.branch);
+      const tdiBranchUpgrade = tdiBranch.from ? (tdiBranch.from.name < tdiBranch.name) : false;
 
-      if (tdiBranch.from) _info(`Current branch '${tdiBranch.from.name}' will be updated to '${tdiBranch.name}'\nCommon ancestor will be used in selecting TDI commits requiring migration: ${_formatDate(tdiBranch.commonAncestor.date)}`);
+      if (tdiBranchUpgrade) _info(`Current branch '${tdiBranch.from.name}' will be updated to '${tdiBranch.name}'\nCommon ancestor will be used in selecting TDI commits requiring migration: ${_formatDate(tdiBranch.commonAncestor.date)}`);
       _info(`Branch ${tdiBranch.name} is ${tdiBranch.commitsBehind} commits behind.`);
 
       // Set branch in .gitmodules file; This ensures submodule update will follow this branch to the latest commit
@@ -150,7 +153,7 @@ module.exports = function git (argv) {
           const migrationsFiltered = migrations
             .filter((m) => m.releases.find((r) => {
               const time = new Date(r.date).getTime();
-              return ((tdiBranch.from)
+              return ((tdiBranchUpgrade)
                 ? `release/${r.release}` == tdiBranch.name || (tdiBranch.from.name <= `release/${r.release}` && `release/${r.release}` < tdiBranch.name && (fromTdiDate.getTime() < time && time < toTdiDate.getTime()))
                 : `release/${r.release}` == tdiBranch.name && (fromTdiDate.getTime() < time && time < toTdiDate.getTime())
               );

package/src/modules/migrate/steps.js

@@ -52,9 +52,11 @@ module.exports = function steps (step, dry, filter) {
       }
 
       let filesModCount = 0;
-      for (let i=0; i<20 && r.files[0]; i++) { // execute repeatedly for modified files only (with safety limit of 20)
+      let maxRepeat = 20;
+      for (let i=0; i<maxRepeat && r.files[0]; i++) { // execute repeatedly for modified files only (with safety limit of 20)
         r.files = rif.sync(r).filter(f => f.hasChanged).map(f => f.file);
         if (i===0) filesModCount = r.files.length; // save count only after first run (after this only subsets are processed)
+        if (i===maxRepeat-1 && r.files[0]) _warn(`Repeated replacement stopped by safety limit - check file changes for too many content occurrences`);
         if (dry) break;
       }