@cspell/cspell-types
Advanced tools
Comparing version 5.5.2 to 5.6.0
@@ -455,2 +455,18 @@ { | ||
}, | ||
"pnpFiles": { | ||
"default": [ | ||
".pnp.js", | ||
".pnp.cjs" | ||
], | ||
"description": "The PnP files to search for. Note: `.mjs` files are not currently supported.", | ||
"items": { | ||
"type": "string" | ||
}, | ||
"type": "array" | ||
}, | ||
"usePnP": { | ||
"default": false, | ||
"description": "Packages managers like Yarn 2 use a `.pnp.cjs` file to assist in loading packages stored in the repository.\n\nWhen true, the spell checker will search up the directory structure for the existence of a PnP file and load it.", | ||
"type": "boolean" | ||
}, | ||
"words": { | ||
@@ -748,2 +764,13 @@ "description": "list of words to be always considered correct", | ||
}, | ||
"pnpFiles": { | ||
"default": [ | ||
".pnp.js", | ||
".pnp.cjs" | ||
], | ||
"description": "The PnP files to search for. Note: `.mjs` files are not currently supported.", | ||
"items": { | ||
"type": "string" | ||
}, | ||
"type": "array" | ||
}, | ||
"showStatus": { | ||
@@ -757,2 +784,7 @@ "description": "Show status", | ||
}, | ||
"usePnP": { | ||
"default": false, | ||
"description": "Packages managers like Yarn 2 use a `.pnp.cjs` file to assist in loading packages stored in the repository.\n\nWhen true, the spell checker will search up the directory structure for the existence of a PnP file and load it.", | ||
"type": "boolean" | ||
}, | ||
"userWords": { | ||
@@ -759,0 +791,0 @@ "description": "Words to add to global dictionary -- should only be in the user config file.", |
@@ -67,3 +67,3 @@ export declare type ReplaceEntry = [string, string]; | ||
} | ||
export interface Settings extends BaseSetting { | ||
export interface Settings extends BaseSetting, PnPSettings { | ||
/** | ||
@@ -125,2 +125,47 @@ * Current active spelling language. | ||
/** | ||
* Plug N Play settings to support package systems like Yarn 2. | ||
*/ | ||
export interface PnPSettings { | ||
/** | ||
* 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 | ||
*/ | ||
usePnP?: boolean; | ||
/** | ||
* The PnP files to search for. Note: `.mjs` files are not currently supported. | ||
* | ||
* @default [".pnp.js", ".pnp.cjs"] | ||
*/ | ||
pnpFiles?: string[]; | ||
} | ||
/** | ||
* To prevent the unwanted execution of untrusted code, WorkspaceTrustSettings | ||
* are use to set the trust levels. | ||
* | ||
* Trust setting have an impact on both `cspell.config.js` files and on `.pnp.js` files. | ||
* In an untrusted location, these files will NOT be used. | ||
* | ||
* This will also prevent any associated plugins from being loaded. | ||
*/ | ||
export interface WorkspaceTrustSettings { | ||
/** | ||
* Glob patterns of locations that contain ALWAYS trusted files | ||
*/ | ||
trustedFiles?: Glob[]; | ||
/** | ||
* Glob patterns of locations that contain NEVER trusted files | ||
*/ | ||
untrustedFiles?: Glob[]; | ||
/** | ||
* Sets the default trust level | ||
* @default "trusted" | ||
*/ | ||
trustLevel?: TrustLevel; | ||
} | ||
/** | ||
* VS Code Spell Checker Settings | ||
@@ -336,3 +381,6 @@ * To be Removed | ||
root?: string; | ||
/** Optional source of the glob, used when merging settings to determine the origin. */ | ||
/** | ||
* Optional source of the glob, used when merging settings to determine the origin. | ||
* @hidden | ||
*/ | ||
source?: string; | ||
@@ -358,2 +406,4 @@ } | ||
export declare type FsPath = string; | ||
/** Trust Security Level */ | ||
export declare type TrustLevel = 'trusted' | 'untrusted'; | ||
/** | ||
@@ -360,0 +410,0 @@ * A File System Path to a dictionary file. |
@@ -6,3 +6,3 @@ { | ||
}, | ||
"version": "5.5.2", | ||
"version": "5.6.0", | ||
"description": "Types for cspell and cspell-lib", | ||
@@ -52,3 +52,3 @@ "main": "dist/index.js", | ||
}, | ||
"gitHead": "292e2a23528cbf5360c1b3e82f312bf6d32c14bc" | ||
"gitHead": "cae6c1b9659c6cb87f50369ed123d26d773b2637" | ||
} |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
47387
1292