RoadmapShopEvents
Skip to main content

Home > @microsoft/rush-lib > PnpmOptionsConfiguration

PnpmOptionsConfiguration class

Options that are only used when the PNPM package manager is selected.

Signature:
export declare class PnpmOptionsConfiguration extends PackageManagerOptionsConfigurationBase
Extends: [PackageManagerOptionsConfigurationBase](/pages/rush-lib.packagemanageroptionsconfigurationbase)

Remarks

It is valid to define these options in rush.json even if the PNPM package manager is not being used.

The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the PnpmOptionsConfiguration class.

Properties

PropertyModifiersTypeDescription
pnpmStorePnpmStoreOptionsThe method used to resolve the store used by PNPM.
pnpmStorePathstringThe path for PNPM to use as the store directory. Will be overridden by environment variable RUSH_PNPM_STORE_PATH
preventManualShrinkwrapChangesbooleanIf true, then rush install will report an error if manual modifications were made to the PNPM shrinkwrap file without running rush update afterwards.
strictPeerDependenciesbooleanIf true, then Rush will add the "--strict-peer-dependencies" option when invoking PNPM.
useWorkspacesbooleanIf true, then Rush will use the workspaces feature to install and link packages when invoking PNPM.