@@ -91,6 +91,28 @@ Usage:
91
91
92
92
./patches/<package-name>+<version>.patch
93
93
94
+ Options:
95
+
96
+ ${ chalk . bold ( "--patch-dir <dirname>" ) }
97
+
98
+ Specify the name for the directory in which the patch files are located.
99
+
100
+ ${ chalk . bold ( "--ignore-errors" ) }
101
+
102
+ Try to apply all of the patches, even if some of them fail.
103
+
104
+ ${ chalk . bold ( "--reverse" ) }
105
+
106
+ Un-applies all patches.
107
+
108
+ Note that this will fail if the patched files have changed since being
109
+ patched. In that case, you'll probably need to re-install 'node_modules'.
110
+
111
+ This option was added to help people using CircleCI avoid an issue around caching
112
+ and patch file updates (https://github.com/ds300/patch-package/issues/37),
113
+ but might be useful in other contexts too.
114
+
115
+
94
116
2. Creating patch files
95
117
=======================
96
118
@@ -103,28 +125,32 @@ Usage:
103
125
104
126
Options:
105
127
106
- ${ chalk . bold ( "--use-yarn" ) }
128
+ ${ chalk . bold ( "--use-yarn" ) }
129
+
130
+ By default, patch-package checks whether you use npm or yarn based on
131
+ which lockfile you have. If you have both, it uses npm by default.
132
+ Set this option to override that default and always use yarn.
107
133
108
- By default, patch-package checks whether you use npm or yarn based on
109
- which lockfile you have. If you have both, it uses npm by default.
110
- Set this option to override that default and always use yarn.
134
+ ${ chalk . bold ( "--exclude <regexp>" ) }
111
135
112
- ${ chalk . bold ( "--exclude <regexp>" ) }
136
+ Ignore paths matching the regexp when creating patch files.
137
+ Paths are relative to the root dir of the package to be patched.
113
138
114
- Ignore paths matching the regexp when creating patch files.
115
- Paths are relative to the root dir of the package to be patched.
139
+ Default: 'package\\.json$'
116
140
117
- Default: 'package\\.json$'
141
+ ${ chalk . bold ( "--include <regexp>" ) }
118
142
119
- ${ chalk . bold ( "--include <regexp>" ) }
143
+ Only consider paths matching the regexp when creating patch files.
144
+ Paths are relative to the root dir of the package to be patched.
120
145
121
- Only consider paths matching the regexp when creating patch files.
122
- Paths are relative to the root dir of the package to be patched.
146
+ Default '.*'
123
147
124
- Default '.*'
148
+ ${ chalk . bold ( "--case-sensitive-path-filtering" ) }
125
149
126
- ${ chalk . bold ( "--case-sensitive-path-filtering" ) }
150
+ Make regexps used in --include or --exclude filters case-sensitive.
151
+
152
+ ${ chalk . bold ( "--patch-dir" ) }
127
153
128
- Make regexps used in --include or --exclude filters case-sensitive .
154
+ Specify the name for the directory in which to put the patch files .
129
155
` )
130
156
}
0 commit comments