nodejs / nodejs/corepack

Handling of deprecated / hidden commands `hydrate` & `prepare`

Open
#624 8 comments 5 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

Issue

These commands:

  1. are not documented in the README
  2. have no migration guide to their replacement commands
  3. do not appear in the output of corepack --help
  4. are described in the output of corepack hydrate --help and corepack prepare --help
  5. neither their usage, nor their help text indicates that the commands are deprecated

Several issues lately have shown users reporting problems when executing corepack prepare.

corepack prepare is listed as a valid command in Node.js documentation Corepack latest v18 Edit: Node.js 18 is now in end-of-life status, so documentation should no longer be referred to. (Node.js v20, v22 & v23 describes instead corepack use / corepack install. Edit: v22 and v24 documentation now have no detailed content.)

Suggestion

  1. Describe the above commands as deprecated and either add the a migration table from https://github.com/nodejs/corepack/issues/274 to the README or create a separate Migration Guide document. Edit: the migration table in the PR contains inaccuracies and cannot be used as it stands.
  2. Extend the help text for the commands to indicate that they are deprecated.
  3. Output a deprecation warning if deprecated commands are used.

Also review Node.js documentation Corepack latest v18 and initiate an update if possible. Edit: Node.js 18 has passed into end-of-life status, so all related assets are now frozen.

Related Node.js documentation

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

Start with the README and the existing corepack hydrate --help and corepack prepare --help output. Review the command-related documentation and help text for the deprecated commands, then define completion as documenting their status and migration path, marking the help output accordingly, and adding the requested deprecation warning if the relevant entry points are identified.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
cli, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.