make work with pnpm and git, use pnpm-lock.yaml #302

milahu · 2021-03-18T17:15:18Z

error was

**ERROR** No package-lock.json, npm-shrinkwrap.json, or yarn.lock file.

install

to install my patched version of patch-package

pnpm rm patch-package
pnpm install @milahu/patch-package
npx patch-package

why is this PR still open?

the author of patch-package has abandoned the project,
so nobody has write access to the repo. feel free to fork my fork

changes

use pnpm-lock.yaml to get the resolvedVersion
use pnpm to install the origin package (if pnpm-lock.yaml was found)
workaround for pnpm symlinks
add some debug output, also show the output of npm install etc (todo: add a --verbose flag to CLI)
exclude lockfiles from diff. maybe exclude more files with patch-package --exclude '^dist/.*'
fix some lint errors via tslint --fix and prettier --write (sorry for the diff noise)
allow comment header in patch files, see my comment
support pnpm's link:../../../some/relative/path
- detect local git repos
  - patch is based on the origin/HEAD commit
  - use full commit hash as version for npm
  - as fallback, use version from local package.json
- dont copy node_packages folders from local package

todo

are git patches applied correctly? we must install the exact commit

fixme

when we install packages from git (pinned to commit), patch-package will say
Warning: patch-package detected a patch file version mismatch
cos the patch version is the "declared" version from /package.json = commit hash
= for example 8a5162785c58864ef65308c0f0d890cade0b407f
and the "applied to" version ("resolved" version) is from node_modules/pkg/package.json
= for example 1.0.0-canary.10
both versions (declared and resolved) could be stored in the comment header of the patch file

worstpractice · 2021-03-28T22:54:01Z

@milahu Awesome work! I was just about to look into this myself when I found your PR.

PabloSzx · 2021-05-11T17:27:49Z

@ds300 Is it possible to take a look into this PR? thank you

milahu · 2021-05-11T20:54:20Z

thx for the keepalive ; )

thing is, the main patch-package repo is slightly undermaintained ...
i mean, my last patch (#252) was 3 lines, and that took 190 days to merge.
looks like ds300 is the only maintainer and shifts the backlog only like 2 or 3 times per year : /

i never really came to use my patch, let me catch up on that:

install patch-package branch pnpm-support-2

cd /my/fancy/node/project
mkdir patched_packages
cd patched_packages
git clone --depth 1 https://github.com/milahu/patch-package.git --branch pnpm-support-2
cd patch-package
pnpm install
pnpm run build
cd ../../
node patched_modules/patch-package/dist/index.js some-node-package

tests

edit: github CI says tests passed 0__o let me run tests again ...
edit 2: nope, still the same error:

# if you have some minutes to waste ...
pnpm run test
# jest --runInBand                                                 
# ts-jest[config] (WARN) Unable to find the root of the project where ts-jest has been installed.
# ts-jest[versions] (WARN) Version 4.2.4 of typescript installed has not been tested with ts-jest. If you're experiencing issues, consider using a supported version (>=2.7.0 <4.0.0). Please do not report issues in ts-jest if you are using unsupported versions.
# FAIL src/packageIsDevDependency.test.ts
#   ● packageIsDevDependency › returns false if package is a transitive dependency of a dev dependency
# [ may be related to my patch ]
# Test Suites: 1 failed, 35 passed, 36 total
# Tests:       1 failed, 5 skipped, 804 passed, 810 total
# Snapshots:   65 passed, 65 total
# Time:        438.918s

one problem i found:
when /package.json says .dependencies.some-package = link:../../some/where
then /pnpm-lock.yaml says .dependencies.some-package = 1.2.3
so the "resolved" version (from /pnpm-lock.yaml) is wrong
and my "detect git version" logic in patch-package/getPackageResolution.js is not used
-> added a workaround

another problem, also

when /package.json says .dependencies.some-package = link:../../some/where

... then that /package.json will obviously not work on other machines (not portable)
and we would have to replace link:../../some/where
with the git-version (or npm-version), that the patch is based on
or straight-up throw a fatal error in patch-package when /package.json says link:../../some/where?

opinions on this?
what is a "reasonable default" workflow to combine git and pnpm?

when i do pnpm install git+https://github.com/ds300/patch-package.git
then node_modules/patch-package is not a git repo

when i do

(
  cd /tmp; git clone --depth 1 https://github.com/ds300/patch-package.git
  cd patch-package; pnpm install; pnpm run build
)
pnpm install /tmp/patch-package

then the resolvedVersion in /pnpm-lock.yaml is wrong (not the git version)
and /package.json is not portable

so ... imho the only solution is to make pnpm clone the git repo
by running something like pnpm install --git-clone git+https://github.com/ds300/patch-package.git
this would clone with a default depth of 1, allowing to set --git-depth <depth>

ideally, following runs of pnpm install or pnpm remove should not change the git repo

PabloSzx · 2021-05-11T21:00:25Z

when /package.json says .dependencies.some-package = link:../../some/where

... then that /package.json will obviously not work on other machines (not portable)
and we would have to replace link:../../some/where
with the git-version (or npm-version), that the patch is based on
or straight-up throw a fatal error in patch-package when /package.json says link:../../some/where?

opinions on this?
what is a "reasonable default" workflow to combine git and pnpm?

I feel like using patch-package on a locally linked package is way too niche, and if it takes way too much work or maintenance in the future just to keep it working, it should just throw, I'm pretty sure the 99% of the usage of patch-package is just for npm packages.

milahu · 2021-05-12T08:04:09Z

it should just throw

agree, linked packages are not portable

I'm pretty sure the 99% of the usage of patch-package is just for npm packages.

... but some changes are non-trivial
for example when i want to cherry-pick some unmerged PRs (i usually create PRs for my patches)
but i want to publish my "private merge" branch via patch-package, not via git

my workflow can be solved with

1. in the npm project, install some-package from git. pin the version with the full commit hash
we can install the latest version from npm, but then the diff is larger
2. in a separate folder, clone the git repo of some-package, make changes, branches, commits, ...
3. copy the patched files to the npm project's node_packages/some-package/
sample: rsync --archive /tmp/repo/some-package/ /tmp/project/node_packages/some-package/
4. run patch-package some-package

step 3 could be automated with a file watcher, e.g. chokidar.watch

another detail (see next comment)
the version of the patched package should be pinned in /package.json (single source of truth)
so it works with all package managers at all times

milahu · 2021-05-12T12:11:33Z

done: restore the old getPackageVersion for file protocol (to fix tests),
and for other protocols (http://some/file.tgz#sha1sumoftgzfile, etc.)

when the package is installed from git, patch-package will require to pin the version in package.json:

{ 
  "dependencies": {
    "some-package": "git://some/where#fullcommithash"
  }
}

todo: automate the version-pinning with a --pin-version flag for patch-package
-> will edit package.json to pin the latest version

discuss: is this "version-pinning in package.json" too pedantic?
should we "just create a patch" and complain later on version mismatch?
currently applyPatches.ts will say
Warning: patch-package detected a patch file version mismatch

todo: fix installedPackageVersion in applyPatches.ts -> should use the commit hash for git repos
either from declaredVersion, or from git rev-parse HEAD

fixed: the --debug flag consumed the next argv
replaced the unmaintained minimist argv parser with dashdash

tests: to test npm packages, we could run a local npm registry

done: add header comments to the generated patch files. sample:

# generated by patch-package 6.4.7 on 2021-05-12 20:07:53
#
# command:
#   npx patch-package --exclude '^test/stubs.*' @11ty/eleventy
#
# declared package:
#   @11ty/eleventy: github:11ty/eleventy#8a5162785c58864ef65308c0f0d890cade0b407f
#
# header comments also make room for custom "patch messages", like ...
#
# this patch will
#
#  * add feature xyz
#  * fix bug 123
#
diff --git a/node_modules/@11ty/eleventy/src/Engines/Txt.js b/node_modules/@11ty/eleventy/src/Engines/Txt.js
new file mode 100644
index 0000000..aef38ca
--- /dev/null
+++ b/node_modules/@11ty/eleventy/src/Engines/Txt.js
@@ -0,0 +1,34 @@
+// based on Html.js
+
+const TemplateEngine = require("./TemplateEngine");
...

todo: when package is a git repo, add commit messages as diff header comments

todo: when an old patch exists, prepend the old header comments to the new patch

done: add prepare script to auto-build on install from source

pnpm i github:milahu/patch-package#pnpm-support-2 # requires pnpm 6.2.2
npx patch-package

todo: emulate git status to preview what files will be changed or added -> exclude unwanted files before makePatch

Jack-Works · 2021-08-14T07:36:00Z

hi @ds300 can you review this? thanks!

milahu · 2021-08-14T17:14:30Z

src/getPackageResolution.ts

+    // TODO dont use lockfiles at all?
+    // package versions should be pinned in /package.json, so it works with all package managers at all times


discuss ... pinning versions in /package.json is the simplest and most portable solution.
lockfiles are only needed for nested/recursive/deep/secondary dependencies

milahu · 2021-08-29T17:41:08Z

so ... maintainer is gone, nobody wants to maintain a fork,
so we must install patch-package from some hidden fork branch,
cos we cant use patch-package to patch patch-package : D

pnpm i github:milahu/patch-package#pnpm-support-2 # requires pnpm 6.2.2
npx patch-package

its not perfect, but it works : )

OmgImAlexis · 2021-08-29T20:05:32Z

@ds300 can you please review this?

milahu · 2022-01-02T16:22:48Z

thanks for reporting, fixed

# binary release
pnpm install @milahu/patch-package-with-pnpm-support@6.4.8

# source release
pnpm i github:milahu/patch-package-with-pnpm-support
pnpm i github:milahu/patch-package#pnpm-support-2

note: some tests are failing

…electron-updater`. This is to reduce noise on tags being pushed. (Note: Must use custom fork of patch-package until ds300/patch-package#302 is released.) Activating additional Updater tests

* Patching changesets to only publish tags for `electron-builder` and `electron-updater`. This is to reduce noise on tags being pushed. (Note: Must use custom fork of patch-package until ds300/patch-package#302 is released.) Activating additional Updater tests

airtonix · 2022-03-03T04:49:42Z

what's the hold up here ?

milahu · 2022-03-03T18:48:49Z

patch-package != pnpm

what's the hold up here ?

patch-package is unmaintained.
feel free to use my pnpm install @milahu/patch-package-with-pnpm-support
and/or maintain your own fork of patch-package

if you allow upstream packages to block your workflow, youre doing something wrong

The solution is here: remix-run/remix#1193 (comment) And for patching a npm package is this package: https://www.npmjs.com/package/patch-package Which doesn'r work with pnpm LOL. Patched itself here: ds300/patch-package#302 (comment)

we can run this code on Remix example apps. The way it works is you add the package in `/packages` folder. And if you want a new remix app example add it to `/examples`. It's explained in the README. Please follow the instructions Patch @remix-run/dev to allow watching changes on packages The solution is here: remix-run/remix#1193 (comment) And for patching a npm package is this package: https://www.npmjs.com/package/patch-package Which doesn't work with pnpm LOL. Patched itself here: ds300/patch-package#302 (comment)

weyert · 2022-03-17T10:46:20Z

patch-package is unmaintained. feel free to use my pnpm install @milahu/patch-package-with-pnpm-support and/or maintain your own fork of patch-package

if you allow upstream packages to block your workflow, youre doing something wrong

Thank you! Any reason why you didn't merge it into main of your fork of the patch-package? :)

milahu · 2022-03-17T14:51:46Z

this PR is merged in https://github.com/milahu/patch-package-with-pnpm-support

weyert · 2022-03-17T16:07:50Z

Thank you! Switching over to your version :>

wighawag · 2022-03-21T17:22:15Z

Hey @milahu

thanks for your work

this PR is merged in https://github.com/milahu/patch-package-with-pnpm-support

I tried to use it in mono-repo setup but this does not work

if I install at root and execute pnpm patch-package <package-to-patch> it cannot find the package

If I instead install it on the sub folder, it cannot find pnpm-lock.yaml

milahu · 2022-03-21T18:01:06Z

thanks for reporting. pnpm workspaces (monorepos) are not implemented
should be easy to do ... please dont wait for me, i have no time for this
see also #277 and yarn workspaces and npmv7 workspaces

caschbre · 2022-04-07T23:29:46Z

@milahu I found a fork of your repo that adds the pnpm lock file detection for workspaces... in case that is something you could easily roll back into your repo.

https://github.com/Tellus/patch-package-with-pnpm-support

milahu · 2022-04-08T12:22:30Z

thanks @Tellus
thanks @caschbre

published as @milahu/patch-package-with-pnpm-support version 6.4.9

Tellus · 2022-04-12T17:27:36Z

thanks @Tellus

You're perfectly welcome. I mulled issuing a pull request back then but wasn't sure if it was up to code standards.

Glad to have been of help :)

Thanks for the great work on the package in general!

milahu · 2022-04-14T12:18:24Z

bugfix for pnpm workspaces published as @milahu/patch-package-with-pnpm-support@6.4.10
tell me when it breaks ; )

milahu · 2022-04-22T17:08:46Z

renamed to @milahu/patch-package

@milahu/patch-package-with-pnpm-support is deprecated

weyert · 2022-05-19T23:57:52Z

How do people use patch-package with pnpm for a dependency of a workspace package?

Jack-Works · 2022-06-20T13:58:36Z

Good news!! PNPM now has official support for yarn style patch!

pnpm/pnpm#2675

We just need to wait for its next release. The benefit of the official support in PNPM is that you won't corrupt the global store (they're shared!)

Also thanks for @milahu, your PR helped us go through the hard time before the official support!

zkochan · 2022-06-29T09:14:58Z

pnpm has a pnpm patch command since v7.4

orta · 2022-09-28T08:50:16Z

Yeah, I think using the built in pnpm patch command is the right call here. Especially considering the inherent trickiness of editing global package repo which this changes. I think the right call is for us to have a README edit which links to the docs for pnpm patch and we close this PR as being better implemented upstream.

orta · 2022-09-28T08:55:13Z

Shipped the README change 6fc78ff - and I'm closing this PR.

Folks involved, you did great work and this is not me dismissing that work as not useful - if there are people who can't upgrade to a version of pnpm with support for patching can use @milahu's fork referenced here: #302 (comment)

make work with pnpm and git, use pnpm-lock.yaml

0676295

milahu mentioned this pull request Mar 18, 2021

Support pnpm package manager #35

Closed

milahu added 3 commits March 18, 2021 21:25

fix bash scripts: enable alias

cd5f987

fix makePatch copySync filter

6a24fab

fix: remove tempfiles, named tempfiles

bef38c1

This comment has been minimized.

Sign in to view

rollback cd5f987

5eab211

nihalgonsalves mentioned this pull request Apr 24, 2021

Allow users to apply plugins to and customise the pre-bundling process vitejs/vite#3124

Closed

zkochan mentioned this pull request Apr 28, 2021

Patching packages during installation pnpm/pnpm#3077

Closed

add workaround for linked pkgs, add --verbose and --debug cli flags

8b80357

milahu added 2 commits May 12, 2021 13:29

use declared package version. add header comments to patchfiles

f95a442

debug test on github: ignores-scripts-when-making-patch

eaf6538

milahu added 4 commits May 12, 2021 17:16

replace minimist with dashdash argv parser

bf8e1e7

fix packageVersion for file protocol

3ccbfb8

update snapshots: add patch file header comments

3373601

rollback eaf6538

86d8e11

milahu force-pushed the pnpm-support-2 branch from 46b684b to 86d8e11 Compare May 12, 2021 18:50

package.json: add prepare script to build on install from git

7ec0646

Jack-Works mentioned this pull request May 28, 2021

fix: patch-package pr is not easy to install DimensionDev/Maskbook#3255

Merged

Jack-Works mentioned this pull request Aug 14, 2021

[Bug] @dimensiondev/patch-package released in a wrong version DimensionDev/Maskbook#3965

Closed

milahu commented Aug 14, 2021

View reviewed changes

milahu added 3 commits January 2, 2022 16:53

typescript: fix error types

bc54703

error -> warning: found wildcard version

950fa9e

rename + bump: @milahu/patch-package-with-pnpm-support 6.4.8

6b85a8b

milahu force-pushed the pnpm-support-2 branch from 2314000 to 6b85a8b Compare January 2, 2022 15:59

mmaietta mentioned this pull request Jan 30, 2022

chore: Only publish electron-builder & electron-updater tags electron-userland/electron-builder#6595

Merged

TheBit mentioned this pull request Apr 5, 2022

TypeError: Cannot read properties of undefined in Content-Type Builder and Uploads pages strapi/strapi#12837

Closed

caschbre mentioned this pull request Apr 8, 2022

detectPackageManager thinks yarn package is being used due to findWorkspaceRoot() milahu/patch-package#4

Closed

orta closed this Sep 28, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

make work with pnpm and git, use pnpm-lock.yaml #302

make work with pnpm and git, use pnpm-lock.yaml #302

milahu commented Mar 18, 2021 •

edited

Loading

This comment has been minimized.

worstpractice commented Mar 28, 2021

PabloSzx commented May 11, 2021

milahu commented May 11, 2021 •

edited

Loading

PabloSzx commented May 11, 2021

milahu commented May 12, 2021 •

edited

Loading

milahu commented May 12, 2021 •

edited

Loading

Jack-Works commented Aug 14, 2021

milahu Aug 14, 2021 •

edited

Loading

milahu commented Aug 29, 2021

OmgImAlexis commented Aug 29, 2021

milahu commented Jan 2, 2022

airtonix commented Mar 3, 2022

milahu commented Mar 3, 2022

weyert commented Mar 17, 2022

milahu commented Mar 17, 2022

weyert commented Mar 17, 2022

wighawag commented Mar 21, 2022

milahu commented Mar 21, 2022

caschbre commented Apr 7, 2022 •

edited

Loading

milahu commented Apr 8, 2022

Tellus commented Apr 12, 2022

milahu commented Apr 14, 2022

milahu commented Apr 22, 2022

weyert commented May 19, 2022

Jack-Works commented Jun 20, 2022

zkochan commented Jun 29, 2022

orta commented Sep 28, 2022

orta commented Sep 28, 2022

		// TODO dont use lockfiles at all?
		// package versions should be pinned in /package.json, so it works with all package managers at all times

make work with pnpm and git, use pnpm-lock.yaml #302

make work with pnpm and git, use pnpm-lock.yaml #302

Conversation

milahu commented Mar 18, 2021 • edited Loading

This comment has been minimized.

worstpractice commented Mar 28, 2021

PabloSzx commented May 11, 2021

milahu commented May 11, 2021 • edited Loading

PabloSzx commented May 11, 2021

milahu commented May 12, 2021 • edited Loading

milahu commented May 12, 2021 • edited Loading

Jack-Works commented Aug 14, 2021

milahu Aug 14, 2021 • edited Loading

Choose a reason for hiding this comment

milahu commented Aug 29, 2021

OmgImAlexis commented Aug 29, 2021

milahu commented Jan 2, 2022

airtonix commented Mar 3, 2022

milahu commented Mar 3, 2022

weyert commented Mar 17, 2022

milahu commented Mar 17, 2022

weyert commented Mar 17, 2022

wighawag commented Mar 21, 2022

milahu commented Mar 21, 2022

caschbre commented Apr 7, 2022 • edited Loading

milahu commented Apr 8, 2022

Tellus commented Apr 12, 2022

milahu commented Apr 14, 2022

milahu commented Apr 22, 2022

weyert commented May 19, 2022

Jack-Works commented Jun 20, 2022

zkochan commented Jun 29, 2022

orta commented Sep 28, 2022

orta commented Sep 28, 2022

milahu commented Mar 18, 2021 •

edited

Loading

milahu commented May 11, 2021 •

edited

Loading

milahu commented May 12, 2021 •

edited

Loading

milahu commented May 12, 2021 •

edited

Loading

milahu Aug 14, 2021 •

edited

Loading

caschbre commented Apr 7, 2022 •

edited

Loading