docs(patch): document plugin options (#4481)

yarnpkg · Oct 5, 2022 · 902d00f · 902d00f
1 parent 7475755
commit 902d00f
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 1 deletion.
diff --git a/.yarn/versions/db7650d7.yml b/.yarn/versions/db7650d7.yml
@@ -0,0 +1,6 @@
+releases:
+  "@yarnpkg/plugin-patch": patch
+
+declined:
+  - "@yarnpkg/plugin-compat"
+  - "@yarnpkg/cli"
diff --git a/packages/gatsby/static/configuration/yarnrc.json b/packages/gatsby/static/configuration/yarnrc.json
@@ -139,6 +139,12 @@
       "type": "boolean",
       "examples": [false]
     },
+    "enableInlineHunks": {
+      "_package": "@yarnpkg/plugin-patch",
+      "description": "If true, Yarn will print any patch sections (hunks) that could not be applied successfully to the terminal. Defaults to false.",
+      "type": "boolean",
+      "examples": [true]
+    },
     "enableMessageNames": {
       "_package": "@yarnpkg/core",
       "description": "If true, Yarn will prefix most messages with codes suitable for search engines.",
@@ -585,6 +591,13 @@
       "additionalProperties": false,
       "_exampleKeys": ["webpack@*"]
     },
+    "patchFolder": {
+      "_package": "@yarnpkg/plugin-patch",
+      "description": "Folder where patch files will be written to.",
+      "type": "string",
+      "format": "uri-reference",
+      "default": "./.yarn/patches"
+    },
     "pnpDataPath": {
       "_package": "@yarnpkg/plugin-pnp",
       "description": "The location where Yarn will read and write the `.pnp.meta.json` file.",

diff --git a/packages/plugin-patch/sources/tools/apply.ts b/packages/plugin-patch/sources/tools/apply.ts
@@ -129,7 +129,7 @@ function linesAreEqual(a: string, b: string) {
  *
  * if you edit a file that had a new line and leave it in:
  *
- *    neither insetion nor deletion have the annoation
+ *    neither insertion nor deletion have the annotation
  *
  */