fix: issue with path separator conversion in xml file and path portab…

…ility (#153)

Co-authored-by: Mehdi Cherfaoui <>

CONTRIBUTING.md

@@ -200,4 +200,12 @@ The repo contains a script to increment the Salesforce API version supported by
 To upgrade the API version, run the following command:
 ```
 yarn && yarn increment:apiversion
-```
+```
+## Testing the plugin from a pull request
+
+To test SGD as a Salesforce CLI plugin from a pending pull request:
+1. uninstall the previous version you may have `sfdx plugins:uninstall sfdx-git-delta`
+2. clone the repository
+3. checkout the branch to test
+3. run `sfdx plugins:link` from that local repository
+4. test the plugin!

README.md

@@ -131,7 +131,7 @@ OPTIONS
                                                                                     this command invocation
 ```
 
-_See code: [src/commands/sgd/source/delta.ts](https://github.com/scolladon/sfdx-git-delta/blob/v4.5.0/src/commands/sgd/source/delta.ts)_
+_See code: [src/commands/sgd/source/delta.ts](https://github.com/scolladon/sfdx-git-delta/blob/v4.6.0/src/commands/sgd/source/delta.ts)_
 <!-- commandsstop -->
 
 ### Important note for Windows users:

__tests__/integration/main.test.js

@@ -43,6 +43,45 @@ describe(`test if the appli`, () => {
     ).toHaveProperty('warnings', [])
   })
 
+  test('can execute with posix  path', () => {
+    expect(
+      app({ output: './output', repo: '', to: 'test', apiVersion: '46' })
+    ).toHaveProperty('warnings', [])
+  })
+
+  test('can execute with posix relative path', () => {
+    expect(
+      app({
+        output: './output/../output',
+        repo: '',
+        to: 'test',
+        apiVersion: '46',
+      })
+    ).toHaveProperty('warnings', [])
+  })
+
+  test('can execute with windows path', () => {
+    expect(
+      app({
+        output: '.\\output',
+        repo: '',
+        to: 'test',
+        apiVersion: '46',
+      })
+    ).toHaveProperty('warnings', [])
+  })
+
+  test('can execute with windows relative path', () => {
+    expect(
+      app({
+        output: '.\\output\\..\\output',
+        repo: '',
+        to: 'test',
+        apiVersion: '46',
+      })
+    ).toHaveProperty('warnings', [])
+  })
+
   test('catch and reject big issues', () => {
     fsMocked.errorMode = true
     fseMocked.errorMode = true

package.json

@@ -60,7 +60,7 @@
     "postrelease": "npm run release:tags && npm run release:github",
     "prepack": "rm -rf lib && tsc -b && oclif-dev manifest && oclif-dev readme",
     "prepare": "husky install",
-    "release": "standard-version --no-verify",
+    "release": "standard-version --no-verify --commit-all",
     "release:github": "conventional-github-releaser -p angular",
     "release:tags": "git push --follow-tags origin master -f --no-verify",
     "increment:apiversion": "jq '.sfdc.latestApiVersion = (.sfdc.latestApiVersion|tonumber + 1 |tostring)' package.json | sponge package.json && filename=`ls src/metadata/v*.json | tail -1` && version=${filename//[!0-9]/} && ((version++)) && targetname=\"src/metadata/v${version}.json\" && \\cp $filename $targetname && yarn pack"
@@ -106,6 +106,11 @@
   "publishConfig": {
     "access": "public"
   },
+  "standard-version": {
+    "scripts": {
+      "postbump": "yarn pack && git add README.md"
+    }
+  },
   "sfdc": {
     "latestApiVersion": "52"
   }

src/main.js

@@ -1,6 +1,7 @@
 'use strict'
 const PackageConstructor = require('./utils/packageConstructor')
 const TypeHandlerFactory = require('./service/typeHandlerFactory')
+const { sanitizePath } = require('./utils/childProcessUtils')
 const metadataManager = require('./metadata/metadataManager')
 const repoSetup = require('./utils/repoSetup')
 const repoGitDiff = require('./utils/repoGitDiff')
@@ -36,13 +37,23 @@ const checkConfig = config => {
   return errors
 }
 
+const sanitizeConfig = config => {
+  config.apiVersion = parseInt(config.apiVersion)
+  repoSetup(config)
+  config.repo = config.repo ? sanitizePath(config.repo) : config.repo
+  config.output = config.output ? sanitizePath(config.output) : config.output
+  config.ignore = config.ignore ? sanitizePath(config.ignore) : config.ignore
+  config.ignoreDestructive = config.ignoreDestructive
+    ? sanitizePath(config.ignoreDestructive)
+    : config.ignoreDestructive
+}
+
 module.exports = config => {
+  sanitizeConfig(config)
   const inputError = checkConfig(config)
   if (inputError.length > 0) {
     throw new Error(inputError)
   }
-  config.apiVersion = parseInt(config.apiVersion)
-  repoSetup(config)
 
   const metadata = metadataManager.getDefinition(
     'directoryName',

src/utils/childProcessUtils.js

@@ -2,5 +2,10 @@
 const os = require('os')
 const path = require('path')
 
-module.exports.treatDataFromSpawn = data =>
-  data.replace(/[/\\]+/g, path.sep).replace(/\r?\n/g, os.EOL)
+const treatEOL = data => data.replace(/\r?\n/g, os.EOL)
+const treatPathSep = data => data.replace(/[/\\]+/g, path.sep)
+const sanitizePath = data => path.normalize(treatPathSep(data))
+
+module.exports.treatDataFromSpawn = data => treatEOL(treatPathSep(data))
+module.exports.treatEOL = treatEOL
+module.exports.sanitizePath = sanitizePath

src/utils/fileGitDiff.js

@@ -12,5 +12,5 @@ module.exports = (filePath, config) => {
     { cwd: config.repo, encoding: gc.UTF8_ENCODING }
   )
 
-  return cpUtils.treatDataFromSpawn(diff)
+  return cpUtils.treatEOL(diff)
 }