sf-git-merge-driver 1.0.0-dev-3.13704714225-2 → 1.0.0-dev-3.13716013381-1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (6) hide show
  1. package/README.md +55 -12
  2. package/messages/install.md +1 -1
  3. package/messages/uninstall.md +1 -1
  4. package/npm-shrinkwrap.json +2 -2
  5. package/oclif.manifest.json +3 -3
  6. package/package.json +1 -1
package/README.md CHANGED
@@ -11,29 +11,72 @@ A custom Git merge driver designed specifically for Salesforce metadata files. T
11
11
 
12
12
  ## Installation
13
13
 
14
- ### As SFDX Plugin
15
-
16
14
  ```bash
17
15
  sf plugins install sf-git-merge-driver
18
16
  ```
19
17
 
20
- ### Local Repository Installation
18
+ ## Usage
19
+
20
+ <!-- commands -->
21
+ * [`sf git merge driver install`](#sf-git-merge-driver-install)
22
+ * [`sf git merge driver uninstall`](#sf-git-merge-driver-uninstall)
23
+
24
+ ## `sf git merge driver install`
25
+
26
+ Installs a local git merge driver for the given org and branch.
21
27
 
22
- ```bash
23
- sf git merge driver install
24
28
  ```
29
+ USAGE
30
+ $ sf git merge driver install [--json] [--flags-dir <value>]
25
31
 
26
- This will:
27
- - Configure your Git settings to use the merge driver
28
- - Add appropriate entries to your `.gitattributes` file
29
- - Set up the driver to handle XML files
32
+ GLOBAL FLAGS
33
+ --flags-dir=<value> Import flag values from a directory.
34
+ --json Format output as json.
30
35
 
31
- ## Uninstallation
36
+ DESCRIPTION
37
+ Installs a local git merge driver for the given org and branch.
32
38
 
33
- ```bash
34
- sf git merge driver uninstall
39
+ Installs a local git merge driver for the given org and branch, by updating the `.gitattributes` files in the project,
40
+ creating a new merge driver configuration in the `.git/config` of the project, and installing the binary in the
41
+ node_modules/.bin directory.
42
+
43
+ EXAMPLES
44
+ Install the driver for a given project:
45
+
46
+ $ sf git merge driver install
35
47
  ```
36
48
 
49
+ _See code: [src/commands/git/merge/driver/install.ts](https://github.com/scolladon/sf-git-merge-driver/blob/v1.0.0-dev-3.13716013381-1/src/commands/git/merge/driver/install.ts)_
50
+
51
+ ## `sf git merge driver uninstall`
52
+
53
+ Uninstalls the local git merge driver for the given org and branch.
54
+
55
+ ```
56
+ USAGE
57
+ $ sf git merge driver uninstall [--json] [--flags-dir <value>]
58
+
59
+ GLOBAL FLAGS
60
+ --flags-dir=<value> Import flag values from a directory.
61
+ --json Format output as json.
62
+
63
+ DESCRIPTION
64
+ Uninstalls the local git merge driver for the given org and branch.
65
+
66
+ Uninstalls the local git merge driver for the given org and branch, by removing the merge driver content in the
67
+ `.gitattributes` files in the project, deleting the merge driver configuration from the `.git/config` of the project,
68
+ and removing the installed binary from the node_modules/.bin directory.
69
+
70
+ EXAMPLES
71
+ Uninstall the driver for a given project:
72
+
73
+ $ sf git merge driver uninstall
74
+ ```
75
+
76
+ _See code: [src/commands/git/merge/driver/uninstall.ts](https://github.com/scolladon/sf-git-merge-driver/blob/v1.0.0-dev-3.13716013381-1/src/commands/git/merge/driver/uninstall.ts)_
77
+ <!-- commandsstop -->
78
+
79
+
37
80
  ## How It Works
38
81
 
39
82
  The merge driver works by:
package/messages/install.md CHANGED
@@ -4,7 +4,7 @@ Installs a local git merge driver for the given org and branch.
4
4
 
5
5
  # description
6
6
 
7
- Installs a local git merge driver for the given org and branch, by updating the `.gitattributes` files in the project and creating a new merge driver configuration file in the `.git/config` of the project.
7
+ Installs a local git merge driver for the given org and branch, by updating the `.gitattributes` 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.
8
8
 
9
9
  # examples
10
10
 
package/messages/uninstall.md CHANGED
@@ -4,7 +4,7 @@ Uninstalls the local git merge driver for the given org and branch.
4
4
 
5
5
  # description
6
6
 
7
- Uninstalls the local git merge driver for the given org and branch, by removing the merge driver content in the `.gitattributes` files in the project and deleting the merge driver configuration file in the `.git/config` of the project.
7
+ Uninstalls the local git merge driver for the given org and branch, by removing the merge driver content in the `.gitattributes` 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.
8
8
 
9
9
  # examples
10
10
 
package/npm-shrinkwrap.json CHANGED
@@ -1,12 +1,12 @@
1
1
  {
2
2
  "name": "sf-git-merge-driver",
3
- "version": "1.0.0-dev-3.13704714225-2",
3
+ "version": "1.0.0-dev-3.13716013381-1",
4
4
  "lockfileVersion": 3,
5
5
  "requires": true,
6
6
  "packages": {
7
7
  "": {
8
8
  "name": "sf-git-merge-driver",
9
- "version": "1.0.0-dev-3.13704714225-2",
9
+ "version": "1.0.0-dev-3.13716013381-1",
10
10
  "license": "MIT",
11
11
  "dependencies": {
12
12
  "@oclif/core": "^4.2.8",
package/oclif.manifest.json CHANGED
@@ -3,7 +3,7 @@
3
3
  "git:merge:driver:install": {
4
4
  "aliases": [],
5
5
  "args": {},
6
- "description": "Installs a local git merge driver for the given org and branch, by updating the `.gitattributes` files in the project and creating a new merge driver configuration file in the `.git/config` of the project.",
6
+ "description": "Installs a local git merge driver for the given org and branch, by updating the `.gitattributes` 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.",
7
7
  "examples": [
8
8
  "Install the driver for a given project:\n<%= config.bin %> <%= command.id %>"
9
9
  ],
@@ -73,7 +73,7 @@
73
73
  "git:merge:driver:uninstall": {
74
74
  "aliases": [],
75
75
  "args": {},
76
- "description": "Uninstalls the local git merge driver for the given org and branch, by removing the merge driver content in the `.gitattributes` files in the project and deleting the merge driver configuration file in the `.git/config` of the project.",
76
+ "description": "Uninstalls the local git merge driver for the given org and branch, by removing the merge driver content in the `.gitattributes` 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.",
77
77
  "examples": [
78
78
  "Uninstall the driver for a given project:\n<%= config.bin %> <%= command.id %>"
79
79
  ],
@@ -141,5 +141,5 @@
141
141
  ]
142
142
  }
143
143
  },
144
- "version": "1.0.0-dev-3.13704714225-2"
144
+ "version": "1.0.0-dev-3.13716013381-1"
145
145
  }
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "sf-git-merge-driver",
3
3
  "description": "git remote add origin git@github.com:scolladon/sf-git-merge-driver.git",
4
- "version": "1.0.0-dev-3.13704714225-2",
4
+ "version": "1.0.0-dev-3.13716013381-1",
5
5
  "exports": "./lib/driver/MergeDriver.js",
6
6
  "bin": {
7
7
  "sf-git-merge-driver": "./lib/index.js"