sf-git-merge-driver 1.2.1-dev-137.18569178375-1 → 1.2.1-dev-137.18912604948-1

package/README.md

@@ -105,6 +105,37 @@ Configured for these metadata files by default:
 *.objectTranslation-meta.xml merge=salesforce-source
 ```
 
+## How to disable it for a specific merge
+
+When you don't want to use the merge driver for a specific merge, just backup the `.git/info/attributes` file and put it back after the merge.
+```sh
+mv .git/info/attributes .git/info/attributes.bak
+git merge <branche>
+mv .git/info/attributes.bak .git/info/attributes
+```
+
+If you want to disable the merge driver for a specific file, just comment the merge driver configuration from the `.git/info/attributes` file.
+```sh
+# *.profile-meta.xml merge=salesforce-source
+```
+
+If you want to disable it for all the project, just uninstall the driver: 
+```sh
+sf git merge driver uninstall
+```
+
+## How to know if it is installed and enabled ?
+
+You can check if the merge driver is installed by running the following command:
+```sh
+git config --show-origin --get-regexp '^merge.salesforce-source(\..*)?'
+```
+
+You can check if the merge driver is enabled by running the following command:
+```sh
+grep "merge=salesforce-source" .git/info/attributes
+```
+
 ## Troubleshooting
 
 The plugin uses the [Salesforce CLI logging system](https://developer.salesforce.com/docs/atlas.en-us.sfdx_setup.meta/sfdx_setup/sfdx_dev_cli_log_messages.htm) to log information.
@@ -125,6 +156,111 @@ GIT_TRACE=true
 git merge ...
 ```
 
+## Commands
+
+<!-- commands -->
+* [`sf git merge driver install`](#sf-git-merge-driver-install)
+* [`sf git merge driver run`](#sf-git-merge-driver-run)
+* [`sf git merge driver uninstall`](#sf-git-merge-driver-uninstall)
+
+## `sf git merge driver install`
+
+Installs a local git merge driver for the given org and branch.
+
+```
+USAGE
+  $ sf git merge driver install [--json] [--flags-dir <value>]
+
+GLOBAL FLAGS
+  --flags-dir=<value>  Import flag values from a directory.
+  --json               Format output as json.
+
+DESCRIPTION
+  Installs a local git merge driver for the given org and branch.
+
+  Installs a local git merge driver for the given org and branch, by updating the `.git/info/attributes` files in the
+  project, creating a new merge driver configuration in the `.git/config` of the project, and installing the binary in
+  the node_modules/.bin directory.
+
+EXAMPLES
+  Install the driver for a given project:
+
+    $ sf git merge driver install
+```
+
+_See code: [src/commands/git/merge/driver/install.ts](https://github.com/scolladon/sf-git-merge-driver/blob/v1.2.1-dev-137.18912604948-1/src/commands/git/merge/driver/install.ts)_
+
+## `sf git merge driver run`
+
+Runs the merge driver for the specified files.
+
+```
+USAGE
+  $ sf git merge driver run -O <value> -A <value> -B <value> -P <value> [--json] [--flags-dir <value>] [-L <value>] [-S
+    <value>] [-X <value>] [-Y <value>]
+
+FLAGS
+  -A, --local-file=<value>             (required) path to our version of the file
+  -B, --other-file=<value>             (required) path to their version of the file
+  -L, --conflict-marker-size=<value>   [default: 7] number of characters to show for conflict markers
+  -O, --ancestor-file=<value>          (required) path to the common ancestor version of the file
+  -P, --output-file=<value>            (required) path to the file where the merged content will be written
+  -S, --ancestor-conflict-tag=<value>  [default: BASE] string used to tag ancestor version in conflicts
+  -X, --local-conflict-tag=<value>     [default: LOCAL] string used to tag local version in conflicts
+  -Y, --other-conflict-tag=<value>     [default: REMOTE] string used to tag other version in conflicts
+
+GLOBAL FLAGS
+  --flags-dir=<value>  Import flag values from a directory.
+  --json               Format output as json.
+
+DESCRIPTION
+  Runs the merge driver for the specified files.
+
+  Runs the merge driver for the specified files, handling the merge conflict resolution using Salesforce-specific merge
+  strategies. This command is typically called automatically by Git when a merge conflict is detected.
+
+EXAMPLES
+  Run the merge driver for conflicting files:
+
+    $ sf git merge driver run --ancestor-file=<value> --local-file=<value> --other-file=<value> \
+      --output-file=<value>
+
+  Where:
+  - ancestor-file is the path to the common ancestor version of the file
+  - local-file is the path to our version of the file
+  - other-file is the path to their version of the file
+  - output-file is the path to the file where the merged content will be written
+```
+
+_See code: [src/commands/git/merge/driver/run.ts](https://github.com/scolladon/sf-git-merge-driver/blob/v1.2.1-dev-137.18912604948-1/src/commands/git/merge/driver/run.ts)_
+
+## `sf git merge driver uninstall`
+
+Uninstalls the local git merge driver for the given org and branch.
+
+```
+USAGE
+  $ sf git merge driver uninstall [--json] [--flags-dir <value>]
+
+GLOBAL FLAGS
+  --flags-dir=<value>  Import flag values from a directory.
+  --json               Format output as json.
+
+DESCRIPTION
+  Uninstalls the local git merge driver for the given org and branch.
+
+  Uninstalls the local git merge driver for the given org and branch, by removing the merge driver content in the
+  `.git/info/attributes` files in the project, deleting the merge driver configuration from the `.git/config` of the
+  project, and removing the installed binary from the node_modules/.bin directory.
+
+EXAMPLES
+  Uninstall the driver for a given project:
+
+    $ sf git merge driver uninstall
+```
+
+_See code: [src/commands/git/merge/driver/uninstall.ts](https://github.com/scolladon/sf-git-merge-driver/blob/v1.2.1-dev-137.18912604948-1/src/commands/git/merge/driver/uninstall.ts)_
+<!-- commandsstop -->
 ## Changelog
 
 [changelog.md](CHANGELOG.md) is available for consultation.

package/npm-shrinkwrap.json

@@ -1,12 +1,12 @@
 {
   "name": "sf-git-merge-driver",
-  "version": "1.2.1-dev-137.18569178375-1",
+  "version": "1.2.1-dev-137.18912604948-1",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "sf-git-merge-driver",
-      "version": "1.2.1-dev-137.18569178375-1",
+      "version": "1.2.1-dev-137.18912604948-1",
       "license": "MIT",
       "dependencies": {
         "@oclif/core": "^4.5.6",

package/oclif.manifest.json

@@ -284,5 +284,5 @@
       ]
     }
   },
-  "version": "1.2.1-dev-137.18569178375-1"
+  "version": "1.2.1-dev-137.18912604948-1"
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "sf-git-merge-driver",
   "description": "git remote add origin git@github.com:scolladon/sf-git-merge-driver.git",
-  "version": "1.2.1-dev-137.18569178375-1",
+  "version": "1.2.1-dev-137.18912604948-1",
   "exports": "./lib/driver/MergeDriver.js",
   "type": "module",
   "author": "Sébastien Colladon (colladonsebastien@gmail.com)",