Passa al contenuto principale
Versione: 6.x

package.json

Il file manifesto di un pacchetto. Contiene tutti i metadati del pacchetto, comprese le dipendenze, il titolo, l'autore, eccetera. Questo è uno standard mantenuto in tutti i principali gestori di pacchetti Node.JS, incluso pnpm.

Campi

engines

Puoi specificare la versione di Node e pnpm su cui funziona il tuo software:

{
"engines": {
"node": ">=10",
"pnpm": ">=3"
}
}

Durante lo sviluppo locale, pnpm fallirà sempre con un messaggio di errore se la sua versione non corrisponde a quella specificata nel campo engine.

A meno che l'utente non abbia impostato il flag di configurazione engine-strict (vedi .npmrc), questo campo è solo consultivo e produrrà avvisi solo quando il tuo pacchetto è installato come dipendenza.

dependenciesMeta

dependenciesMeta.*.injected

Aggiunto nella versione: v6.20.0

Se questo è impostato su true per una dipendenza locale, il pacchetto sarà collegato alla cartella dei moduli, non collegato simbolicamente.

Ad esempio, il seguente package.json in uno spazio di lavoro creerà un collegamento simbolico a button nella cartella node_modules di card:

{
"name": "card",
"dependencies": {
"button": "workspace:1.0.0"
}
}

Ma cosa succede se button ha react nelle sue dipendenze peer? Se tutti i progetti nel monorepo utilizzano la stessa versione di react, nessun problema. Ma se button è richiesto da card che utilizza react@16 e form con react@17? Senza usare inject, dovresti scegliere una singola versione di react e installarla come dipendenza dev di button. Ma usando il campo injected puoi iniettare button in un pacchetto e button verrà installato con la versione di react di quel pacchetto.

Quindi questo sarà il package.json di card:

{
"name": "card",
"dependencies": {
"button": "workspace:1.0.0",
"react": "16"
},
"dependenciesMeta": {
"button": {
"injected": true
}
}
}

button sarà collegato fisicamente alle dipendenze di card e react@16 sarà collegato simbolicamente alle dipendenze di card/node_modules/button.

E questo sarà il package.json di form:

{
"name": "form",
"dependencies": {
"button": "workspace:1.0.0",
"react": "17"
},
"dependenciesMeta": {
"button": {
"injected": true
}
}
}

button sarà collegato fisicamente alle dipendenze di form e react@17 sarà collegato simbolicamente alle dipendenze di form/node_modules/button.

peerDependenciesMeta

Questo campo elenca alcune informazioni aggiuntive relative alle dipendenze elencate nel campo peerDependencies.

peerDependenciesMeta.*.optional

Se questo è impostato su true, la dipendenza peer selezionata verrà contrassegnata come opzionale dal gestore pacchetti. Pertanto, il consumatore che lo omette non sarà più segnalato come errore.

Ad esempio:

{
"peerDependencies": {
"foo": "1"
},
"peerDependenciesMeta": {
"foo": {
"optional": true
},
"bar": {
"optional": true
}
}
}

Si noti che anche se bar non è stato specificato in peerDependencies, è contrassegnato come facoltativo. pnpm quindi presumerà che qualsiasi versione di bar vada bene. Tuttavia, pippo è facoltativo, ma solo per la specifica della versione richiesta.

publishConfig

Aggiunto nella versione: v3.4.0

È possibile sovrascrivere alcuni campi nel manifesto prima che il pacchetto sia impacchettato. I seguenti campi possono essere sovrascritti:

Per sovrascrivere un campo, aggiungi la versione pubblica del campo in publishConfig.

Ad esempio, il seguente package.json:

{
"name": "foo",
"version": "1.0.0",
"main": "src/index.ts",
"publishConfig": {
"main": "lib/index.js",
"typings": "lib/index.d.ts"
}
}

Verrà pubblicato come:

{
"name": "foo",
"version": "1.0.0",
"main": "lib/index.js",
"typings": "lib/index.d.ts"
}

publishConfig.executableFiles

Aggiunto nella versione: v6.11.5

Per impostazione predefinita, per motivi di portabilità, nessun file tranne quelli elencati nel campo bin verrà contrassegnato come eseguibile nell'archivio del pacchetto risultante. Il campo executableFiles consente di dichiarare campi aggiuntivi che devono avere il flag dell'eseguibile (+x) impostato anche se non sono direttamente accessibili tramite il campo bin.

{
"publishConfig": {
"executableFiles": [
"./dist/shim.js"
]
}
}

publishConfig.directory

Aggiunto nella versione: v6.7.0

Puoi anche utilizzare il campo publishConfig.directory per personalizzare la sottocartella pubblicata relativa all'attuale package.json.

Dovrebbe avere una versione modificata del pacchetto corrente nella cartella specificata (di solito utilizzando strumenti di compilazione di terze parti).

In questo esempio la cartella "dist" deve contenere un package.json

{
"name": "foo",
"version": "1.0.0",
"publishConfig": {
"directory": "dist"
}
}

pnpm.overrides

Aggiunto nella versione: v5.10.1

Questo campo consente di indicare a pnpm di sovrascrivere qualsiasi dipendenza nel grafico delle dipendenze. Questo è utile per imporre a tutti i tuoi pacchetti di utilizzare una singola versione di una dipendenza, eseguire il backport di una correzione o sostituire una dipendenza con un fork.

Nota che il campo delle sostituzioni può essere impostato solo alla radice del progetto.

Un esempio del campo "pnpm"."overrides":

{
"pnpm": {
"overrides": {
"foo": "^1.0.0",
"quux": "npm:@myorg/quux@^1.0.0",
"bar@^2.1.0": "3.0.0",
"qar@1>zoo": "2"
}
}
}

Puoi specificare il pacchetto a cui appartiene la dipendenza sovrascritta separando il selettore del pacchetto dal selettore delle dipendenze con un ">", per esempio qar@1>zoo sovrascriverà solo la dipendenza zoo di qar@1, non per altre dipendenze.

pnpm.packageExtensions

Aggiunto nella versione: v6.9.0

I campi packageExtensions offrono un modo per estendere le definizioni dei pacchetti esistenti con informazioni aggiuntive. Ad esempio, se react-redux dovrebbe avere react-dom nelle sue peerDependencies ma non ce l'ha, è possibile patchare react-redux usando packageExtensions:

{
"pnpm": {
"packageExtensions": {
"react-redux": {
"peerDependencies": {
"react-dom": "*"
}
}
}
}
}

Le chiavi in packageExtensions sono nomi di pacchetti o nomi di pacchetti e intervalli di semver, quindi è possibile correggere solo alcune versioni di un pacchetto:

{
"pnpm": {
"packageExtensions": {
"react-redux@1": {
"peerDependencies": {
"react-dom": "*"
}
}
}
}
}

I seguenti campi possono essere estesi utilizzando packageExtensions: dependencies, optionalDependencies, peerDependencies, e peerDependenciesMeta.

Un esempio più grande:

{
"pnpm": {
"packageExtensions": {
"express@1": {
"optionalDependencies": {
"typescript": "2"
}
},
"fork-ts-checker-webpack-plugin": {
"dependencies": {
"@babel/core": "1"
},
"peerDependencies": {
"eslint": ">= 6"
},
"peerDependenciesMeta": {
"eslint": {
"optional": true
}
}
}
}
}
}

pnpm.peerDependencyRules.ignoreMissing

Aggiunto nella versione: v6.26.0

pnpm non stamperà avvisi sulle dipendenze peer mancanti da questo elenco.

Ad esempio, con la configurazione seguente, pnpm non stamperà avvisi se una dipendenza ha bisogno di react ma react non è installato:

{
"pnpm": {
"peerDependencyRules": {
"ignoreMissing": ["react"]
}
}
}

pnpm.peerDependencyRules.allowedVersions

Aggiunto nella versione: v6.26.0

Gli avvisi di dipendenza peer non soddisfatte non verranno stampati per le dipendenze peer dell'intervallo specificato.

Ad esempio, se hai alcune dipendenze che richiedono react@16 ma sai che funzionano bene con react@17, puoi utilizzare la seguente configurazione:

{
"pnpm": {
"peerDependencyRules": {
"allowedVersions": {
"react": "17"
}
}
}
}

Questo dirà a pnpm che qualsiasi dipendenza che ha react nelle sue dipendenze peer dovrebbe consentire l'installazione di react v17.

pnpm.neverBuiltDependencies

Aggiunto nella versione: v5.16.0

Questo campo consente di ignorare le build di dipendenze specifiche. Gli script "preinstall", "install" e "postinstall" dei pacchetti elencati non verranno eseguiti durante l'installazione.

Un esempio del campo "pnpm"."neverBuiltDependencies":

{
"pnpm": {
"neverBuiltDependencies": ["fsevents", "level"]
}
}

pnpm.onlyBuiltDependencies

Aggiunto nella versione: v6.32.0

Un elenco di nomi di pacchetti che possono essere eseguiti durante l'installazione. Se questo campo esiste, solo i pacchetti elencati potranno eseguire gli script di installazione.

Esempio:

{
"pnpm": {
"onlyBuiltDependencies": ["fsevents"]
}
}