Adding a New Feature and Fixing Diffs

- [X] Added new `--filter` flag to allow filtering results to matches only
- [X] Fixed DIFF as I had the order backwards so modifications were shown in reverse

Author: manifestinteractive

README.md

@@ -55,6 +55,7 @@ Name          | Param             | Alias | Definition
 Cartridge     | `--cartridge`     | `-c`  | Source Cartridge
 Diff          | `--diff`          | `-d`  | Show Full Diff
 Exclude       | `--exclude`       | `-e`  | List of Cartridges to Exclude
+Filter        | `--filter`        | `-f`  | Filter Results for Match
 Include       | `--include`       | `-i`  | List of Cartridges to Include
 Junk Only     | `--junk-only`     | `-j`  | Junk Files Only
 Modified Only | `--modified-only` | `-m`  | Modified Files Only
@@ -107,6 +108,15 @@ sfcc-diff --cartridge app_client_name --junk-only
 sfcc-diff -c app_client_name -j
 ```
 
+#### Comparing Client Cartridge to All Cartridges and Filtering for ISML Files:
+
+> If you want to limit the results to just what matches a filter, you can use the `--filter` flag.  This will match on the entire relative URL, not just the file name.
+
+```bash
+sfcc-diff --cartridge app_client_name --filter .isml
+sfcc-diff -c app_client_name -f .isml
+```
+
 #### Comparing Client Cartridge to Specific Cartridge and Generate Diff:
 
 > Want to actually see the changes between cartridge files? Just pass in a the Diff option and it will render it in your terminal window.

bin/cli.js

@@ -27,6 +27,11 @@ const cli = yargs
       describe: 'List of Cartridges to Exclude',
       type: 'array'
     },
+    filter: {
+      alias: 'f',
+      describe: 'Filter Results for Match',
+      type: 'string'
+    },
     include: {
       alias: 'i',
       describe: 'List of Cartridges to Include',
@@ -49,6 +54,8 @@ const cli = yargs
   .example('sfcc-diff -c app_client_name --modified-only', 'Use Git Commit for Compare')
   .example('sfcc-diff -c app_client_name --junk-only', 'Just list Junk Files')
   .example('sfcc-diff -c app_client_name -m -d ksdiff', 'Modified Only and Diff')
+  .example('sfcc-diff -c app_client_name -f .isml', 'Filter for ISML files')
+  .example('sfcc-diff -c app_client_name -f common.properties', 'Filter for Specific File')
   .example('sfcc-diff -c app_client_name -i rvw_autobahn_core', 'Compare Two Cartridges')
   .updateStrings({
     'Options:': chalk.cyan('Options:\n'),

lib/cartridgeCompare.js

@@ -57,14 +57,19 @@ module.exports = (cartridges, options) => {
 
           // Only track file if requested
           if (!options.junkOnly || (options.junkOnly && fileIsJunk)) {
-            diffs.push({
-              fileIsJunk: fileIsJunk,
-              relativePath: `${dif.relativePath}/${dif.name1 || dif.name2}`,
-              sourceFile: sourceFile,
-              sourceName: source[0].name,
-              targetFile: targetFile,
-              targetName: cartridge.name
-            })
+            const relPath = `${dif.relativePath}/${dif.name1 || dif.name2}`
+
+            // Check for File Filter
+            if (!options.filter || relPath.indexOf(options.filter) > -1) {
+              diffs.push({
+                fileIsJunk: fileIsJunk,
+                relativePath: relPath,
+                sourceFile: sourceFile,
+                sourceName: source[0].name,
+                targetFile: targetFile,
+                targetName: cartridge.name
+              })
+            }
           }
         }
       })

lib/diff.js

@@ -60,10 +60,10 @@ module.exports = (files, options) => {
           // Check if we provided a custom tool we want to diff with, otherwise output to terminal
           if (options.diff.length > 0) {
             console.log(`${chalk.dim('DIFF:'.padStart(leftPad, ' '))} ${chalk.dim(`Opened in ${options.diff}`)}`)
-            execSync(`git difftool --tool=${options.diff} --no-prompt  --exit-code --no-index ${sourceFile} ${targetFile}`)
+            execSync(`git difftool --tool=${options.diff} --no-prompt  --exit-code --no-index ${targetFile} ${sourceFile}`)
           } else if (hasChanges) {
             console.log(`${chalk.dim('DIFF:'.padStart(leftPad, ' '))} ${chalk.dim('↓ ↓ ↓ ↓ ↓ ↓ ↓ ↓ ↓ ↓ ↓ ↓ ↓ ↓ ↓')}\n`)
-            execSync(`git diff --color-words --ignore-all-space --ignore-blank-lines --ignore-cr-at-eol --unified=0 --exit-code --no-index ${sourceFile} ${targetFile} 2> /dev/null | tail -n +5`, { stdio: 'inherit' })
+            execSync(`git diff --color-words --ignore-all-space --ignore-blank-lines --ignore-cr-at-eol --unified=0 --exit-code --no-index ${targetFile} ${sourceFile} 2> /dev/null | tail -n +5`, { stdio: 'inherit' })
           }
         }
       }

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "sfcc-cartridge-diff",
-  "version": "1.0.1",
+  "version": "1.1.0",
   "description": "SFCC Cartridge Diff Tool",
   "homepage": "https://github.com/redvanworkshop/sfcc-cartridge-diff#readme",
   "license": "MIT",