Merge branch 'master' into patch-1

Author: ds300

.github/FUNDING.yml

@@ -0,0 +1,12 @@
+# These are supported funding model platforms
+
+github: [ds300]
+patreon: # Replace with a single Patreon username
+open_collective: # Replace with a single Open Collective username
+ko_fi: # Replace with a single Ko-fi username
+tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
+community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
+liberapay: # Replace with a single Liberapay username
+issuehunt: # Replace with a single IssueHunt username
+otechie: # Replace with a single Otechie username
+custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

.travis.yml

@@ -1,5 +1,53 @@
 # Changelog
 
+## 6.4.7
+
+- Use npm i --force when creating patches
+
+## 6.4.6
+
+- Update find-yarn-workspace-root (contribution from @sarimarton in #282)
+- Fix rare npm crash when creating patches (contribution from @kf6kjg in #271)
+
+## 6.4.5
+
+- Increase max pipe buffer size when creating patch. (contribution from @nomi9995 in #287)
+
+## 6.4.4
+
+- Refine --create-issue template
+
+## 6.4.3
+
+- Ensure real path is used when copying package contents. Potentially adds pnpm support (contribution from @milahu in #252)
+
+## 6.4.2
+
+- Add package version to --create-issue template
+
+## 6.4.1
+
+- Add backlink to patch-package repo to collect public usage of --create-issue
+
+## 6.4.0
+
+- Add --create-issue option
+
+## 6.3.1
+
+- Fix another createPatch bug involving .git folder hygiene (contribution from @gomain in #258)
+
+## 6.3.0
+
+- Add --error-on-fail cli option 
+- Collate errors and warnings to avoid exiting early (with help from @akwodkiewicz in #217)
+- Fix .dev.patch suffix bug (with help from @pdcastro in #224)
+- Support build metadata in package.json version strings (with help from @snowystinger in #213)
+- Change 'no patch files found' message from red to blue (contribution from @dmhalejr in #211)
+- Fix environment variable propogation for spawned tasks (contribution from @chpio in #223)
+- Add --patch-dir option to readme (contribution from @mikehardy in #225)
+- Fix createPatch bug involving .git folder hygiene (contribution from @haroenv in #231)
+
 ## 6.2.2
 
 - Take config from .yarnrc when making patches (contribution from @NMinhNguyen in #222)

CHANGELOG.md

@@ -61,41 +61,46 @@ files.
 
 ### Heroku
 
-For `patch-package` to work on Heroku applications, you must specify [`NPM_CONFIG_PRODUCTION=false` or `YARN_PRODUCTION=false`](https://devcenter.heroku.com/articles/nodejs-support#package-installation). See [this issue](https://github.com/ds300/patch-package/issues/130) for more details.
+For `patch-package` to work on Heroku applications, you must specify
+[`NPM_CONFIG_PRODUCTION=false` or `YARN_PRODUCTION=false`](https://devcenter.heroku.com/articles/nodejs-support#package-installation).
+See [this issue](https://github.com/ds300/patch-package/issues/130) for more
+details.
 
 ### Docker and CI
 
 - If having errors about working directory ("cannot run in wd [...]") when
   building in Docker, you might need to adjust configuration in `.npmrc`. See
   [#185](https://github.com/ds300/patch-package/issues/185).
-- In your `Dockerfile`, remember to copy over the patch files *before* running
+- In your `Dockerfile`, remember to copy over the patch files _before_ running
   `[npm|yarn] install`
 - If you cache `node_modules` rather than running `yarn install` every time,
   make sure that the `patches` dir is included in your cache key somehow.
   Otherwise if you update a patch then the change may not be reflected on
   subsequent CI runs.
+
 
-  #### CircleCI example
-  Create a hash of your patches before loading/saving your cache. If using a Linux machine, run `md5sum patches/* > patches.hash`. If running on a macOS machine,  use `md5 patches/* > patches.hash`
-  ```yaml
-  - run:
-      name: patch-package hash
-      command: md5sum patches/* > patches.hash
-  ```
-  
-  Then, update your hash key to include a checksum of that file:
-  ```yaml
-  - restore_cache:
-      key: app-node_modules-v1-{{ checksum "yarn.lock" }}-{{ checksum "patches.hash" }}
-  ```  
-  
-  As well as the save_cache
-  ```yaml
-  - save_cache:
-      key: app-node_modules-v1-{{ checksum "yarn.lock" }}-{{ checksum "patches.hash" }}
-      paths:
-        - ./node_modules
-  ```
+### CircleCI
+Create a hash of your patches before loading/saving your cache. If using a Linux machine, run `md5sum patches/* > patches.hash`. If running on a macOS machine,  use `md5 patches/* > patches.hash`
+```yaml
+- run:
+    name: patch-package hash
+    command: md5sum patches/* > patches.hash
+```
+
+Then, update your hash key to include a checksum of that file:
+```yaml
+- restore_cache:
+    key: app-node_modules-v1-{{ checksum "yarn.lock" }}-{{ checksum "patches.hash" }}
+```  
+
+As well as the save_cache
+```yaml
+- save_cache:
+    key: app-node_modules-v1-{{ checksum "yarn.lock" }}-{{ checksum "patches.hash" }}
+    paths:
+      - ./node_modules
+```
+
 
 ## Usage
 
@@ -120,6 +125,11 @@ team.
 
 #### Options
 
+- `--create-issue`
+
+  For packages whose source is hosted on GitHub this option opens a web browser
+  with a draft issue based on your diff.
+
 - `--use-yarn`
 
   By default, patch-package checks whether you use npm or yarn based on which
@@ -171,6 +181,19 @@ Run `patch-package` without arguments to apply all patches in your project.
 
 #### Options
 
+- `--error-on-fail`
+
+  Forces patch-package to exit with code 1 after failing.
+
+  When running locally patch-package always exits with 0 by default. This
+  happens even after failing to apply patches because otherwise yarn.lock and
+  package.json might get out of sync with node_modules, which can be very
+  confusing.
+
+  `--error-on-fail` is **switched on** by default on CI.
+
+  See https://github.com/ds300/patch-package/issues/86 for background.
+
 - `--reverse`
 
   Un-applies all patches.

README.md

@@ -3,6 +3,7 @@ set -e
 
 echo "add patch-package"
 yarn add $1
+alias patch-package=./node_modules/.bin/patch-package
 
 echo "add a file"
 echo "this is a new file" > node_modules/lodash/newFile.md
@@ -11,14 +12,14 @@ echo "remove a file"
 rm node_modules/lodash/fp/__.js
 
 echo "generate patch file"
-npx patch-package lodash
+patch-package lodash
 
 echo "remove node_modules"
 rm -rf node_modules
 
 echo "resintall and patch node_modules"
 yarn
-npx patch-package
+patch-package
 
 echo "check that the file was added"
 ls node_modules/lodash/newFile.md

integration-tests/adding-and-deleting-files/adding-and-deleting-files.sh

@@ -23,5 +23,7 @@ exports[`Test broken-patch-file: patch-package fails when patch file is invalid
     https://github.com/ds300/patch-package/issues
     
 
+---
+patch-package finished with 1 error(s).
 END SNAPSHOT"
 `;

integration-tests/broken-patch-file/__snapshots__/broken-patch-file.test.ts.snap

@@ -3,9 +3,10 @@ set -e
 
 echo "add patch-package"
 yarn add $1
+alias patch-package=./node_modules/.bin/patch-package
 
 (>&2 echo "SNAPSHOT: patch-package fails when patch file is invalid")
-if npx patch-package
+if patch-package
 then
   exit 1
 fi

integration-tests/broken-patch-file/broken-patch-file.sh

@@ -0,0 +1,71 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`Test collate-errors: left-pad, lodash, and zfs apply 1`] = `
+"SNAPSHOT: left-pad, lodash, and zfs apply
+patch-package 0.0.0
+Applying patches...
+[email protected] ✔
+[email protected] ✔
+[email protected] ✔
+END SNAPSHOT"
+`;
+
+exports[`Test collate-errors: underscore does not apply, left-pad warns 1`] = `
+"SNAPSHOT: underscore does not apply, left-pad warns
+
+Warning: patch-package detected a patch file version mismatch
+
+  Don't worry! This is probably fine. The patch was still applied
+  successfully. Here's the deets:
+
+  Patch file created for
+
+    [email protected]
+
+  applied to
+
+    [email protected]
+  
+  At path
+  
+    node_modules/left-pad
+
+  This warning is just to give you a heads-up. There is a small chance of
+  breakage even though the patch was applied successfully. Make sure the package
+  still behaves like you expect (you wrote tests, right?) and then run
+
+    patch-package left-pad
+
+  to update the version in the patch file name and make this warning go away.
+
+
+**ERROR** Failed to apply patch for package underscore at path
+  
+    node_modules/underscore
+
+  This error was caused because underscore has changed since you
+  made the patch file for it. This introduced conflicts with your patch,
+  just like a merge conflict in Git when separate incompatible changes are
+  made to the same piece of code.
+
+  Maybe this means your patch file is no longer necessary, in which case
+  hooray! Just delete it!
+
+  Otherwise, you need to generate a new patch file.
+
+  To generate a new one, just repeat the steps you made to generate the first
+  one.
+
+  i.e. manually make the appropriate file changes, then run 
+
+    patch-package underscore
+
+  Info:
+    Patch file: patches/underscore+1.0.3.patch
+    Patch was made for version: 1.0.3
+    Installed version: 1.12.0
+
+---
+patch-package finished with 1 warning(s), 1 error(s).
+END SNAPSHOT"
+`;

integration-tests/collate-errors/__snapshots__/collate-errors.test.ts.snap

@@ -0,0 +1,15 @@
+# make sure errors stop the script
+set -e
+
+echo "add patch-package"
+yarn add $1
+alias patch-package=./node_modules/.bin/patch-package
+
+echo "SNAPSHOT: left-pad, lodash, and zfs apply"
+(>&2 echo "SNAPSHOT: underscore does not apply, left-pad warns")
+if patch-package;
+then
+  exit 1
+fi
+(>&2 echo "END SNAPSHOT")
+echo "END SNAPSHOT"

integration-tests/collate-errors/collate-errors.sh

@@ -0,0 +1,5 @@
+import { runIntegrationTest } from "../runIntegrationTest"
+runIntegrationTest({
+  projectName: "collate-errors",
+  shouldProduceSnapshots: true,
+})

integration-tests/collate-errors/collate-errors.test.ts

@@ -0,0 +1,14 @@
+{
+  "name": "collate-errors",
+  "version": "1.0.0",
+  "description": "integration test for patch-package",
+  "main": "index.js",
+  "author": "",
+  "license": "ISC",
+  "dependencies": {
+    "left-pad": "1.1.2",
+    "lodash": "^4.17.21",
+    "underscore": "^1.12.0",
+    "zfs": "^1.3.0"
+  }
+}

integration-tests/collate-errors/package.json

@@ -0,0 +1,14 @@
+diff --git a/node_modules/left-pad/index.js b/node_modules/left-pad/index.js
+index 6b56df3..3433636 100644
+--- a/node_modules/left-pad/index.js
++++ b/node_modules/left-pad/index.js
+@@ -1,6 +1,9 @@
+ 'use strict';
+ module.exports = leftPad;
+ 
++
++// patch-package
++
+ var cache = [
+   '',
+   ' ',

integration-tests/collate-errors/patches/left-pad+1.1.1.patch

@@ -0,0 +1,24 @@
+diff --git a/node_modules/lodash/_arrayFilter.js b/node_modules/lodash/_arrayFilter.js
+index 75ea254..444241d 100644
+--- a/node_modules/lodash/_arrayFilter.js
++++ b/node_modules/lodash/_arrayFilter.js
+@@ -2,7 +2,7 @@
+  * A specialized version of `_.filter` for arrays without support for
+  * iteratee shorthands.
+  *
+- * @private
++ * @patchPackage
+  * @param {Array} [array] The array to iterate over.
+  * @param {Function} predicate The function invoked per iteration.
+  * @returns {Array} Returns the new filtered array.
+diff --git a/node_modules/lodash/ceil.js b/node_modules/lodash/ceil.js
+index 56c8722..b4a5e1f 100644
+--- a/node_modules/lodash/ceil.js
++++ b/node_modules/lodash/ceil.js
+@@ -23,4 +23,6 @@ var createRound = require('./_createRound');
+  */
+ var ceil = createRound('ceil');
+ 
++// patch-package
++
+ module.exports = ceil;

integration-tests/collate-errors/patches/lodash+4.17.21.patch

@@ -0,0 +1,13 @@
+diff --git a/node_modules/underscore/README b/node_modules/underscore/README
+index 333b13f..dc192cf 100644
+--- a/node_modules/underscore/README
++++ b/node_modules/underscore/README
+@@ -16,7 +16,7 @@ in JavaScript objects. It's the tie to go along with jQuery's tux.
+ For Docs, License, Tests, and pre-packed downloads, see:
+ http://documentcloud.github.com/underscore/
+ 
+-Many thanks to our contributors:
++Many thanks to our wonderful contributors:
+ 
+   Dmitry Baranovskiy
+   Tim Caswell