Skip to main content

Interface: PnPSettings

Defined in: cspell-types/dist/index.d.mts:1085

Plug N Play settings to support package systems like Yarn 2.

Extended by

Properties

pnpFiles?

optional pnpFiles: string[]

Defined in: cspell-types/dist/index.d.mts:1101

The PnP files to search for. Note: .mjs files are not currently supported.

Default

[".pnp.js", ".pnp.cjs"]

usePnP?

optional usePnP: boolean

Defined in: cspell-types/dist/index.d.mts:1095

Packages managers like Yarn 2 use a .pnp.cjs file to assist in loading packages stored in the repository.

When true, the spell checker will search up the directory structure for the existence of a PnP file and load it.

Default

false