Skip to content

Commit 12be333

Browse files
committed
node: document npm lockfile requirements
Possibly related: #439, #492
1 parent db39dc0 commit 12be333

1 file changed

Lines changed: 8 additions & 0 deletions

File tree

node/README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -114,6 +114,14 @@ If you're using npm, you must run this script when the `node_modules` directory
114114
If you generate the `generated-sources.json` in CI, you can do this by passing `--package-lock-only`
115115
to `npm install`.
116116

117+
### Lockfile requirements
118+
119+
If using npm, your lockfile must be **committed** to the project's version control. It's not enough
120+
to generate it locally and feed it to `flatpak-node-generator` because without it, `npm` will make
121+
API requests that won't be cached by the generator.
122+
123+
You also must be using at least `package-lock.json` version 2.
124+
117125
### Caching
118126

119127
flatpak-node-generator will cache many API responses and archives from the server to speed up

0 commit comments

Comments
 (0)