Handling of deprecated / hidden commands `hydrate` & `prepare`
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 3.8k
- Forks
- 279
- Avg merge
- 1h 47m
- Merged PRs (30d)
- 2
Description
Issue
-
The following commands are hidden since PR https://github.com/nodejs/corepack/pull/291 implemented https://github.com/nodejs/corepack/issues/274 in release corepack@0.20.0:
corepack hydratecorepack prepare
These commands:
- are not documented in the README
- have no migration guide to their replacement commands
- do not appear in the output of
corepack --help - are described in the output of
corepack hydrate --helpandcorepack prepare --help - 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.
Edit: Node.js 18 is now in end-of-life status, so documentation should no longer be referred to. (Node.js v20, corepack prepare is listed as a valid command in Node.js documentation Corepack latest v18v22 & v23 describes instead corepack use / corepack install. Edit: v22 and v24 documentation now have no detailed content.)
Suggestion
- Describe the above commands as deprecated and either add
thea migration tablefrom https://github.com/nodejs/corepack/issues/274to 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. - Extend the help text for the commands to indicate that they are deprecated.
- 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
- Node.js 18 Corepack (Node.js 18 is end-of-life)
- Node.js 20 Corepack
- Node.js 22 Corepack
- Node.js 24 Corepack
- Node.js latest Corepack
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- 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