nodejs / nodejs/corepack

`npm install -g` corepack enables Corepack

Open
#686 4 comments 3 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
3.8k
Forks
279
Avg merge
1h 47m
Merged PRs (30d)
2

Description

Situation

If Corepack is installed globally using npm, as documented in the README > Manual Installs section using

npm install -g corepack

then Corepack behaves as if corepack enable had been executed.

This differs from how Corepack behaves when it is installed together with Node.js as a bundled component. In this case Corepack is not enabled by default.

The difference between defaults of Corepack being enabled or not, depending on how Corepack is installed, is not documented in the README, neither under the Manual Installs section, nor under the corepack enable section.

Suggestion

Add the information to the README document that using npm install -g corepack effectively executes corepack enable.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Update the README sections on Manual Installs and corepack enable to document the different defaults for globally installed and Node.js-bundled Corepack. Check that the completed documentation clearly states that npm install -g corepack effectively enables Corepack.

Written by the indexing model from the issue text.

Assessment

Tech stack
nodejs
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.