Expand `corepack use` documentation description
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 1/5
- Tempo stimato
- 1-3 ore
- Idoneità per principianti
- 45/100
- Tipo di issue
- Documentazione
- Chiarezza
- Specificata chiaramente
- Stato di attività
- Ferma
- Ambito
- documentation
Direzione di ricerca
Aggiorna la sezione corepack use del README, usando come riferimento comportamentale l’esempio di test dell’issue 607 collegata e i relativi comandi shell. Documenta come il comando trova package.json nella gerarchia delle directory e cosa crea quando non esistono né il file né il campo packageManager; il lavoro è completo quando entrambi i comportamenti sono descritti chiaramente.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
Issue
Under README > corepack use the complete description currently says:
corepack use <name[@]>
When run, this command will retrieve the latest release matching the provided descriptor, assign it to the project's package.json file, and automatically perform an install.
package.json location
There is no description of how the command navigates the directory hierarchy to locate a possible existing package.json to modify.
Using the test example of @arcanis in https://github.com/nodejs/corepack/issues/607#issuecomment-2609834263 shows that it operates on the root of a hierarchy:
corepack enable yarn
cd $(mktemp -d)
yarn init -2 -w
mkdir -p packages/foo
echo '{}' > packages/foo/package.json
jq .packageManager package.json
(cd packages/foo && corepack use yarn@4.5.0)
jq .packageManager package.json
In this example case, the result is that:
-
packages/foo/package.jsoncontains{} -
package.jsoncontains{ "name": "tmp.IcgYOXK7aS", "packageManager": "yarn@4.5.0+sha512.837566d24eec14ec0f5f1411adb544e892b3454255e61fdef8fd05f3429480102806bac7446bc9daff3896b01ae4b62d00096c7e989f1596f2af10b927532f39", "workspaces": [ "packages/*" ] }
package.json creation
If no package.json file is found, then one is created. This effect of the command is not described.
Suggestion
For the README > corepack use section:
- Add text to explain how the location for the
package.jsonfile is determined. - Add text which describes how a
package.jsonfile and / or apackageManagerfield is created if they don't exist.
Related
- Lingua principale
- TypeScript
- Stelle
- 3.8k
- Fork
- 279
- Merge medio
- 1h 47m
- PR unite (30g)
- 2
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di nodejs/corepack
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 64/100
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100
-
Difficoltà 4/5 3-5 giorni Idoneità per principianti 68/100
-
Difficoltà 3/5 1-2 giorni Idoneità per principianti 52/100
-
Difficoltà 3/5 1-2 giorni Idoneità per principianti 68/100
Tutte le issue di nodejs/corepack
Issue simili
-
VerificationGate: ATTRIBUTION quote guard never matches a normal quotation (\b around the quote) Aperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100
danielmiessler/LifeOS#2234 ·
-
T: Bug
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 65/100
-
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 85/100
-
Mend: dependency security vulnerability untriaged
Difficoltà 2/5 1-3 ore Idoneità per principianti 70/100