Fix issues creating prototypes when using npm v10.4.0 or newer by removing dependency on zlib #2404
Conversation
|
just adding a comment here for people if they need a work around, assuming you're using a version of npm (and that's npm, not, nodejs - the versioning is different) greater than 8.3.0 (which introduced overrides) then you can exclude zlib by adding this into your package.json and trying running npm install again: |
|
@oscarduignan thanks! I've updated my template repo, as the npx command will fail: https://github.com/joelanman/govuk-prototype-kit-prototype |
There was a problem hiding this comment.
The code changes look fine but I think that it'd be useful to:
- capture why we're making the change in the commit message
- explain the impact of the change in the changelog entry
Would you be happy to pick that up? If you prefer I can update the commit, PR title and changelog entry as long as you're happy for me to edit your wording!
|
@36degrees cheers, happy for you to edit any of it! |
36degrees
changed the title
Creating new prototypes is (silently) failing when using npm v10.4.0 or newer because of an error that occurs when installing the `zlib` package: ``` $ npm install zlib npm ERR! code 127 npm ERR! path /Users/oliver.byford/Code/zlib-test/node_modules/zlib npm ERR! command failed npm ERR! command sh -c node-waf clean || true; node-waf configure build npm ERR! sh: node-waf: command not found npm ERR! sh: node-waf: command not found ``` The `zlib` package is 13 years old, and has been replaced by a zlib ‘core module’ built into node itself since Node v0.6. `require(‘zlib’)` will always return the core module [1] over a dependency from `node_modules`, and so despite being listed as a dependency the `zlib` package will never be used [2] and can safely be removed. [1]: https://nodejs.org/api/modules.html#modules_all_together [2]: kkaefer/DEPRECATED-node-zlib#7 Co-authored-by: Oliver Byford <oliver.byford@digital.cabinet-office.gov.uk>
the kit had a dependency of
zlib1.0.5 - this is 13 years old, and is replaced by the built inzlibin node itselfthis should fix this issue that users have reported:
kkaefer/DEPRECATED-node-zlib#14
fixes #2405