1.3.0 breaks on install

[ltribolet]

I have prism-react-renderer as dependency of my Docusaurus project and upon upgrading this package it breaks at yarn install:

error /app/node_modules/prism-react-renderer: Command failed.
Exit code: 127
Command: patch-package
Arguments:
Directory: /app/node_modules/prism-react-renderer
Output:
/bin/sh: patch-package: not found

[xenoworf]

My team is seeing a similar error when installing via npm install:

> prism-react-renderer@1.3.0 postinstall /Users/me/my-project/node_modules/prism-react-renderer
> patch-package

sh: patch-package: command not found
npm WARN @cerner/package-json-lint-config-terra@1.2.0 requires a peer of @cerner/package-json-lint@^0.0.0 but none is installed. You must install peer dependencies yourself.
npm WARN @octokit/plugin-request-log@1.0.4 requires a peer of @octokit/core@>=3 but none is installed. You must install peer dependencies yourself.
npm WARN eslint-plugin-formatjs@2.21.0 requires a peer of eslint@8 but none is installed. You must install peer dependencies yourself.

npm ERR! code ELIFECYCLE
npm ERR! syscall spawn
npm ERR! file sh
npm ERR! errno ENOENT
npm ERR! prism-react-renderer@1.3.0 postinstall: `patch-package`
npm ERR! spawn ENOENT

[ryan-roemer]

Yep, patch-package is a devDependency which looks like it will break on the postinstall

[ryan-roemer]

@jpdriver here's my debugging tips:

In prism-react-renderer project:

$ npm pack

In a temp debugging project:

$ yarn add file:/FULL/PATH/TO/prism-react-renderer/prism-react-renderer-1.3.0.tgz

And I think that's a good simulation of what consumers will see from our working project.

Update: I ended up throwing in a -beta.NUM and incrementing tests to defeat the local cache on yarn for convenience on changes...

[ryan-roemer]

Here's a WIP diff:

diff --git a/package.json b/package.json
index ba7df10..84c0270 100755
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "prism-react-renderer",
-  "version": "1.3.0",
+  "version": "1.3.0-beta.3",
   "description": "Renders highlighted Prism output using React",
   "sideEffects": false,
   "main": "dist/index.cjs.js",
@@ -11,6 +11,7 @@
   "files": [
     "index.d.ts",
     "dist",
+    "patches",
     "prism",
     "themes"
   ],
@@ -54,6 +55,11 @@
       "prettier --write"
     ]
   },
+  "dependencies": {
+    "patch-package": "^6.4.7",
+    "prismjs": "^1.26.0",
+    "postinstall-postinstall": "^2.1.0"
+  },
   "peerDependencies": {
     "react": ">=0.14.9"
   },
@@ -81,10 +87,7 @@
     "jest": "^26.6.3",
     "lint-staged": "^10.5.4",
     "npm-run-all": "^4.1.5",
-    "patch-package": "^6.4.7",
-    "postinstall-postinstall": "^2.1.0",
     "prettier": "^2.2.1",
-    "prismjs": "^1.26.0",
     "react": "^17.0.1",
     "react-dom": "^17.0.1",
     "rollup": "^2.39.0"

Note that patches wasn't included in the package itself due to files. This still errors with a yarn install --verbose setting of:

verbose 1.609734082 patch-package 6.4.7
Applying patches...
Error: Patch file found for package prismjs which is not present at node_modules/prismjs
---
patch-package finished with 1 error(s).

I think this is because prismjs gets flattened to root. This can be manually reproduced by:

$ cd node_modules/prism-react-renderer/
$ patch-package
patch-package 6.4.7
Applying patches...
Error: Patch file found for package prismjs which is not present at node_modules/prismjs
---
patch-package finished with 1 error(s).

[jpdriver]

my sincerest apologies to all who ran into this today. way to go for my first release of this lib huh 😅

after further investigation (h/t to @ryan-roemer for the info above) the simplest solution was to move the patch-package invocation to a prebuild script.

when you think about it, this is actually when we want to modify prism so we can vendor it anyway. when a consuming project installs prism-react-renderer there's no need to repeat the modification.

this solution avoids both needing to add dependencies and also avoids shipping the /patches dir as part of our archive.