Passer au contenu principal
Version : 6.x

.pnpmfile.cjs

pnpm lets you hook directly into the installation process via special functions (hooks). Hooks can be declared in a file called .pnpmfile.cjs.

Par défaut, .pnpmfile.cjs doit être situé dans le même répertoire que le fichier de verrouillage. Par exemple, dans un workspace avec un fichier de verrouillage partagé, .pnpmfile.cjs doit être à la racine du monorepo.

Hooks‚Äč

TL;DR‚Äč

Hook FunctionProcessusUses
hooks.readPackage(pkg, context): pkgAppelé après que pnpm ait analysé le manifeste du paquet de la dépendancePermet de modifier le package.json d’une dépendance
hooks.afterAllResolved(lockfile, context): lockfileAppelé après que les dépendances aient été résolues.Permet de modifier le fichier lockfile

hooks.readPackage(pkg, context): pkg | Promise<pkg>‚Äč

Permet de modifier le package.json d’une dépendance après l’analyse et avant la résolution. Ces mutations ne sont pas enregistrées dans le système de fichiers, cependant, elles affecteront ce qui est résolu dans le fichier lockfile et donc ce qui est installé.

Notez que vous devrez supprimer le pnpm-lock.yaml si vous avez déjà résolu la dépendance que vous souhaitez modifier.

Arguments‚Äč

  • pkg - Le manifeste du package. Soit la r√©ponse du registre, soit le contenu de package.json.
  • context - Objet de contexte pour l'√©tape. La m√©thode #log(msg) permet d'utiliser un journal de d√©bogage pour l'√©tape.

Utilisation‚Äč

Example .pnpmfile.cjs (changes the dependencies of a dependency):

function readPackage(pkg, context) {
// Override the manifest of foo@1.x after downloading it from the registry
if (pkg.name === 'foo' && pkg.version.startsWith('1.')) {
// Replace bar@x.x.x with bar@2.0.0
pkg.dependencies = {
...pkg.dependencies,
bar: '^2.0.0'
}
context.log('bar@1 => bar@2 in dependencies of foo')
}

// This will change any packages using baz@x.x.x to use baz@1.2.3
if (pkg.dependencies.baz) {
pkg.dependencies.baz = '1.2.3';
}

return pkg
}

module.exports = {
hooks: {
readPackage
}
}

Limitations connues‚Äč

Removing the scripts field from a dependency's manifest via readPackage will not prevent pnpm from building the dependency. When building a dependency, pnpm reads the package.json of the package from the package's archive, which is not affected by the hook. In order to ignore a package's build, use the pnpm.neverBuiltDependencies field.

hooks.afterAllResolved(lockfile, context): lockfile | Promesse<lockfile>‚Äč

Added in: v1.41.0

Allows you to mutate the lockfile output before it is serialized.

Arguments‚Äč

  • lockfile - Le fichier de r√©solution lockfile s√©rialis√© dans pnpm-lock.yaml.
  • context - Objet de contexte pour l'√©tape. La m√©thode #log(msg) permet d'utiliser un journal de d√©bogage pour l'√©tape.

Exemple d'utilisation‚Äč

.pnpmfile.cjs
function afterAllResolved(lockfile, context) {
// ...
return lockfile
}

module.exports = {
hooks: {
afterAllResolved
}
}

Limitations connues‚Äč

There are none - anything that can be done with the lockfile can be modified via this function, and you can even extend the lockfile's functionality.

Configuration associ√©e‚Äč

ignore-pnpmfile‚Äč

Added in: v1.25.0

  • Default: false
  • Type: Boolean

.pnpmfile.cjs will be ignored. Useful together with --ignore-scripts when you want to make sure that no script gets executed during install.

pnpmfile‚Äč

Added in: v1.39.0

  • Par d√©faut : .pnpmfile.cjs
  • Type: path
  • Exemple¬†: .pnpm/.pnpmfile.cjs

The location of the local pnpmfile.

global-pnpmfile‚Äč

Added in: v1.39.0

  • Default: null
  • Type: path
  • Exemple¬†: ~/.pnpm/global_pnpmfile.cjs

The location of a global pnpmfile. A global pnpmfile is used by all projects during installation.

note

It is recommended to use local pnpmfiles. Only use a global pnpmfile if you use pnpm on projects that don't use pnpm as the primary package manager.