@cspell/cspell-types 5.12.2 → 5.13.0

package/cspell.schema.json

@@ -31,6 +31,7 @@
     },
     "DictionaryDefinitionAlternate": {
       "additionalProperties": false,
+      "deprecated": true,
       "deprecationMessage": "Use `DictionaryDefinitionPreferred`",
       "description": "Only for legacy dictionary definitions",
       "properties": {
@@ -40,6 +41,7 @@
         },
         "file": {
           "$ref": "#/definitions/DictionaryPath",
+          "deprecated": true,
           "deprecationMessage": "Use `path` instead.",
           "description": "Path to the file, only for legacy dictionary definitions"
         },
@@ -254,7 +256,7 @@
         },
         "caseSensitive": {
           "default": false,
-          "description": "Words must match case rules.",
+          "description": "Determines if words must match case and accent rules.\n\n- `false` - Case is ignored and accents can be missing on the entire word.   Incorrect accents or partially missing accents will be marked as incorrect.\n- `true` - Case and accents are enforced.",
           "type": "boolean"
         },
         "description": {
@@ -332,6 +334,7 @@
               "type": "array"
             }
           ],
+          "deprecated": true,
           "deprecationMessage": "Use `locale` instead",
           "description": "Deprecated - The locale filter, matches against the language. This can be a comma separated list. \"*\" will match all locales."
         },
@@ -394,7 +397,7 @@
         },
         "caseSensitive": {
           "default": false,
-          "description": "Words must match case rules.",
+          "description": "Determines if words must match case and accent rules.\n\n- `false` - Case is ignored and accents can be missing on the entire word.   Incorrect accents or partially missing accents will be marked as incorrect.\n- `true` - Case and accents are enforced.",
           "type": "boolean"
         },
         "description": {
@@ -690,8 +693,7 @@
             {
               "type": "string"
             },
-            {
-            }
+            {}
           ],
           "maxItems": 2,
           "minItems": 2,
@@ -721,6 +723,7 @@
     },
     "VersionLegacy": {
       "const": "0.1",
+      "deprecated": true,
       "deprecationMessage": "Use `0.2`",
       "description": "Legacy Configuration File Versions",
       "type": "string"
@@ -737,7 +740,7 @@
     },
     "caseSensitive": {
       "default": false,
-      "description": "Words must match case rules.",
+      "description": "Determines if words must match case and accent rules.\n\n- `false` - Case is ignored and accents can be missing on the entire word.   Incorrect accents or partially missing accents will be marked as incorrect.\n- `true` - Case and accents are enforced.",
       "type": "boolean"
     },
     "description": {
@@ -768,6 +771,11 @@
       "type": "array",
       "uniqueItems": true
     },
+    "enableGlobDot": {
+      "default": false,
+      "description": "Enable scanning files and directories beginning with `.` (period). By default, CSpell does not scan `hidden` files.",
+      "type": "boolean"
+    },
     "enabled": {
       "default": true,
       "description": "Is the spell checker enabled",
@@ -942,10 +950,12 @@
       "type": "array"
     },
     "showStatus": {
+      "deprecated": true,
       "description": "Show status",
       "type": "boolean"
     },
     "spellCheckDelayMs": {
+      "deprecated": true,
       "description": "Delay in ms after a document has changed before checking it for spelling errors.",
       "type": "number"
     },

package/dist/CSpellSettingsDef.d.ts

@@ -49,6 +49,13 @@ export interface FileSettings extends ExtendableSettings {
      * Glob patterns are relative to the `globRoot` of the configuration file that defines them.
      */
     files?: Glob[];
+    /**
+     * Enable scanning files and directories beginning with `.` (period).
+     * By default, CSpell does not scan `hidden` files.
+     *
+     * @default false
+     */
+    enableGlobDot?: boolean;
     /**
      * Glob patterns of files to be ignored
      * Glob patterns are relative to the `globRoot` of the configuration file that defines them.
@@ -204,17 +211,17 @@ export interface WorkspaceTrustSettings {
 /**
  * VS Code Spell Checker Settings
  * To be Removed
- * @deprecated
+ * @deprecated true
  */
 export interface LegacySettings {
     /**
      * Show status
-     * @deprecated
+     * @deprecated true
      */
     showStatus?: boolean;
     /**
      * Delay in ms after a document has changed before checking it for spelling errors.
-     * @deprecated
+     * @deprecated true
      */
     spellCheckDelayMs?: number;
 }
@@ -252,7 +259,12 @@ export interface BaseSetting {
      */
     allowCompoundWords?: boolean;
     /**
-     * Words must match case rules.
+     * Determines if words must match case and accent rules.
+     *
+     * - `false` - Case is ignored and accents can be missing on the entire word.
+     *   Incorrect accents or partially missing accents will be marked as incorrect.
+     * - `true` - Case and accents are enforced.
+     *
      * @default false
      */
     caseSensitive?: boolean;
@@ -335,7 +347,7 @@ export interface DictionaryDefinitionPreferred extends DictionaryDefinitionBase
     path: DictionaryPath;
     /**
      * Only for legacy dictionary definitions
-     * @deprecated
+     * @deprecated true
      * @deprecationMessage Use `path` instead.
      * @hidden
      */
@@ -343,7 +355,7 @@ export interface DictionaryDefinitionPreferred extends DictionaryDefinitionBase
 }
 /**
  * Only for legacy dictionary definitions
- * @deprecated
+ * @deprecated true
  * @deprecationMessage Use `DictionaryDefinitionPreferred`
  */
 export interface DictionaryDefinitionAlternate extends DictionaryDefinitionBase {
@@ -351,13 +363,13 @@ export interface DictionaryDefinitionAlternate extends DictionaryDefinitionBase
     path?: undefined;
     /**
      * Path to the file, only for legacy dictionary definitions
-     * @deprecated
+     * @deprecated true
      * @deprecationMessage Use `path` instead.
      */
     file: DictionaryPath;
 }
 /**
- * @deprecated
+ * @deprecated true
  * @hidden
  */
 export interface DictionaryDefinitionLegacy extends DictionaryDefinitionBase {
@@ -365,7 +377,7 @@ export interface DictionaryDefinitionLegacy extends DictionaryDefinitionBase {
     path?: FsPath;
     /**
      * File name
-     * @deprecated
+     * @deprecated true
      * @deprecationMessage Use path instead.
      */
     file: FsPath;
@@ -419,7 +431,7 @@ export interface LanguageSettingFilterFieldsDeprecated {
     languageId: LanguageId | LanguageIdSingle[];
     /**
      * Deprecated - The locale filter, matches against the language. This can be a comma separated list. "*" will match all locales.
-     * @deprecated
+     * @deprecated true
      * @deprecationMessage Use `locale` instead
      */
     local?: LocaleId | LocaleId[];
@@ -482,13 +494,13 @@ export declare type LocaleId = string;
 export declare type VersionLatest = '0.2';
 /**
  * Legacy Configuration File Versions
- * @deprecated
+ * @deprecated true
  * @deprecationMessage Use `0.2`
  */
 export declare type VersionLegacy = '0.1';
 export declare type Version = VersionLatest | VersionLegacy;
 /**
- * @deprecated
+ * @deprecated true
  * @deprecationMessage Use LocaleId instead
  */
 export declare type LocalId = LocaleId;

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "5.12.2",
+  "version": "5.13.0",
   "description": "Types for cspell and cspell-lib",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -49,12 +49,12 @@
   },
   "devDependencies": {
     "ajv-cli": "^5.0.0",
-    "jest": "^27.2.4",
+    "jest": "^27.3.1",
     "rimraf": "^3.0.2",
-    "ts-json-schema-generator": "^0.95.0",
-    "typedoc": "^0.22.5",
-    "typedoc-plugin-markdown": "^3.11.3",
-    "typescript": "^4.4.3"
+    "ts-json-schema-generator": "^0.97.0",
+    "typedoc": "^0.22.9",
+    "typedoc-plugin-markdown": "^3.11.6",
+    "typescript": "^4.4.4"
   },
-  "gitHead": "1418785bb9c3a29b794a6e9d447b5638f8eb9fbf"
+  "gitHead": "4cd5431b084824e172798ae97f2f520dbad4a8ac"
 }

package/dist/settings/CSpellSettingsDef.d.ts

@@ -1,589 +0,0 @@
-export declare type ReplaceEntry = [string, string];
-export declare type ReplaceMap = ReplaceEntry[];
-/**
- * These settings come from user and workspace settings.
- */
-export declare type CSpellPackageSettings = CSpellUserSettings;
-export declare type CSpellUserSettings = CSpellSettings;
-export interface CSpellSettings extends FileSettings, LegacySettings {
-    $schema?: string;
-}
-export interface ImportFileRef {
-    filename: string;
-    error?: Error;
-    referencedBy?: Source[];
-}
-export interface CSpellSettingsWithSourceTrace extends CSpellSettings {
-    source?: Source;
-    __importRef?: ImportFileRef;
-    __imports?: Map<string, ImportFileRef>;
-}
-export interface FileSettings extends ExtendableSettings {
-    /**
-     * Configuration format version of the settings file.
-     * @default "0.2"
-     */
-    version?: Version;
-    /** Words to add to global dictionary -- should only be in the user config file. */
-    userWords?: string[];
-    /** Other settings files to be included */
-    import?: FsPath | FsPath[];
-    /**
-     * The root to use for glop patterns found in this configuration.
-     * Default: location of the configuration file.
-     *   For compatibility reasons, config files with version 0.1, the glob root will
-     *   default to be `${cwd}`.
-     *
-     * Use `globRoot` to define a different location.
-     * `globRoot` can be relative to the location of this configuration file.
-     * Defining globRoot, does not impact imported configurations.
-     *
-     * Special Values:
-     * - `${cwd}` - will be replaced with the current working directory.
-     * - `.` - will be the location of the containing configuration file.
-     *
-     */
-    globRoot?: FsPath;
-    /**
-     * Glob patterns of files to be checked.
-     * Glob patterns are relative to the `globRoot` of the configuration file that defines them.
-     */
-    files?: Glob[];
-    /**
-     * Glob patterns of files to be ignored
-     * Glob patterns are relative to the `globRoot` of the configuration file that defines them.
-     */
-    ignorePaths?: Glob[];
-    /**
-     * Prevents searching for local configuration when checking individual documents.
-     * @default false
-     */
-    noConfigSearch?: boolean;
-    /**
-     * Indicate that the configuration file should not be modified.
-     * This is used to prevent tools like the VS Code Spell Checker from
-     * modifying the file to add words and other configuration.
-     * @default false
-     */
-    readonly?: boolean;
-    /**
-     * Custom reporters configuration
-     */
-    reporters?: ReporterSettings[];
-}
-export interface ExtendableSettings extends Settings {
-    /** Overrides to apply based upon the file path. */
-    overrides?: OverrideSettings[];
-}
-export interface Settings extends ReportingConfiguration, BaseSetting, PnPSettings {
-    /**
-     * Current active spelling language.
-     *
-     * Example: "en-GB" for British English
-     *
-     * Example: "en,nl" to enable both English and Dutch
-     * @default "en"
-     */
-    language?: LocaleId;
-    /** languageIds for the files to spell check. */
-    enabledLanguageIds?: LanguageIdSingle[];
-    /**
-     * @title File Types to Check
-     * @scope resource
-     * @uniqueItems true
-     * @markdownDescription
-     * Enable / Disable checking file types (languageIds).
-     * These are in additional to the file types specified by `cSpell.enabledLanguageIds`.
-     * To disable a language, prefix with `!` as in `!json`,
-     *
-     * Example:
-     * ```
-     * jsonc       // enable checking for jsonc
-     * !json       // disable checking for json
-     * kotlin      // enable checking for kotlin
-     * ```
-     */
-    enableFiletypes?: LanguageIdSingle[];
-    /** Additional settings for individual languages. */
-    languageSettings?: LanguageSetting[];
-    /** Forces the spell checker to assume a give language id. Used mainly as an Override. */
-    languageId?: LanguageId;
-}
-export interface ReportingConfiguration extends SuggestionsConfiguration {
-    /**
-     * The maximum number of problems to report in a file.
-     * @default 100
-     */
-    maxNumberOfProblems?: number;
-    /**
-     * The maximum number of times the same word can be flagged as an error in a file.
-     * @default 5
-     */
-    maxDuplicateProblems?: number;
-    /**
-     * The minimum length of a word before checking it against a dictionary.
-     * @default 4
-     */
-    minWordLength?: number;
-}
-export interface SuggestionsConfiguration {
-    /**
-     * Number of suggestions to make
-     * @default 10
-     */
-    numSuggestions?: number;
-    /**
-     * The maximum amount of time in milliseconds to generate suggestions for a word.
-     * @default 500
-     */
-    suggestionsTimeout?: number;
-    /**
-     * The maximum number of changes allowed on a word to be considered a suggestions.
-     *
-     * For example, appending an `s` onto `example` -> `examples` is considered 1 change.
-     *
-     * Range: between 1 and 5.
-     * @default 3
-     */
-    suggestionNumChanges?: number;
-}
-/**
- * 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
- * To be Removed
- * @deprecated
- */
-export interface LegacySettings {
-    /**
-     * Show status
-     * @deprecated
-     */
-    showStatus?: boolean;
-    /**
-     * Delay in ms after a document has changed before checking it for spelling errors.
-     * @deprecated
-     */
-    spellCheckDelayMs?: number;
-}
-export interface OverrideSettings extends Settings, OverrideFilterFields {
-    /** Sets the programming language id */
-    languageId?: LanguageId;
-    /** Sets the locale */
-    language?: LocaleId;
-}
-export interface OverrideFilterFields {
-    /** Glob pattern or patterns to match against */
-    filename: Glob | Glob[];
-}
-export interface BaseSetting {
-    /** Optional identifier */
-    id?: string;
-    /** Optional name of configuration */
-    name?: string;
-    /** Optional description of configuration */
-    description?: string;
-    /**
-     * Is the spell checker enabled
-     * @default true
-     */
-    enabled?: boolean;
-    /** list of words to be always considered correct */
-    words?: string[];
-    /** list of words to always be considered incorrect. */
-    flagWords?: string[];
-    /** List of words to be ignored. An Ignored word will not show up as an error even if it is also in the `flagWords`. */
-    ignoreWords?: string[];
-    /**
-     * True to enable compound word checking.
-     * @default false
-     */
-    allowCompoundWords?: boolean;
-    /**
-     * Words must match case rules.
-     * @default false
-     */
-    caseSensitive?: boolean;
-    /** Define additional available dictionaries */
-    dictionaryDefinitions?: DictionaryDefinition[];
-    /**
-     * Optional list of dictionaries to use.
-     * Each entry should match the name of the dictionary.
-     * To remove a dictionary from the list add `!` before the name.
-     * i.e. `!typescript` will turn off the dictionary with the name `typescript`.
-     */
-    dictionaries?: DictionaryReference[];
-    /**
-     * Optional list of dictionaries that will not be used for suggestions.
-     * Words in these dictionaries are considered correct, but will not be
-     * used when making spell correction suggestions.
-     *
-     * Note: if a word is suggested by another dictionary, but found in
-     * one of these dictionaries, it will be removed from the set of
-     * possible suggestions.
-     */
-    noSuggestDictionaries?: DictionaryReference[];
-    /**
-     * List of RegExp patterns or Pattern names to exclude from spell checking.
-     *
-     * Example: ["href"] - to exclude html href
-     */
-    ignoreRegExpList?: RegExpPatternList;
-    /**
-     * List of RegExp patterns or defined Pattern names to define the text to be included for spell checking.
-     * If includeRegExpList is defined, ONLY, text matching the included patterns will be checked.
-     */
-    includeRegExpList?: RegExpPatternList;
-    /** Defines a list of patterns that can be used in ignoreRegExpList and includeRegExpList */
-    patterns?: RegExpPatternDefinition[];
-}
-export declare type DictionaryFileTypes = 'S' | 'W' | 'C' | 'T';
-export declare type DictionaryDefinition = DictionaryDefinitionPreferred | DictionaryDefinitionCustom | DictionaryDefinitionAlternate | DictionaryDefinitionLegacy;
-export interface DictionaryDefinitionBase {
-    /**
-     * This is the name of a dictionary.
-     *
-     * Name Format:
-     * - Must contain at least 1 number or letter.
-     * - spaces are allowed.
-     * - Leading and trailing space will be removed.
-     * - Names ARE case-sensitive
-     * - Must not contain `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`
-     */
-    name: DictionaryId;
-    /** Optional description */
-    description?: string;
-    /** Replacement pairs */
-    repMap?: ReplaceMap;
-    /** Use Compounds */
-    useCompounds?: boolean;
-    /**
-     * Indicate that suggestions should not come from this dictionary.
-     * Words in this dictionary are considered correct, but will not be
-     * used when making spell correction suggestions.
-     *
-     * Note: if a word is suggested by another dictionary, but found in
-     * this dictionary, it will be removed from the set of
-     * possible suggestions.
-     */
-    noSuggest?: boolean;
-}
-export interface DictionaryDefinitionPreferred extends DictionaryDefinitionBase {
-    /** Path to the file */
-    path: DictionaryPath;
-    /**
-     * Only for legacy dictionary definitions
-     * @deprecated
-     * @deprecationMessage Use `path` instead.
-     * @hidden
-     */
-    file?: undefined;
-}
-/**
- * Only for legacy dictionary definitions
- * @deprecated
- * @deprecationMessage Use `DictionaryDefinitionPreferred`
- */
-export interface DictionaryDefinitionAlternate extends DictionaryDefinitionBase {
-    /** @hidden */
-    path?: undefined;
-    /**
-     * Path to the file, only for legacy dictionary definitions
-     * @deprecated
-     * @deprecationMessage Use `path` instead.
-     */
-    file: DictionaryPath;
-}
-/**
- * @deprecated
- * @hidden
- */
-export interface DictionaryDefinitionLegacy extends DictionaryDefinitionBase {
-    /** Path to the file, if undefined the path to the extension dictionaries is assumed */
-    path?: FsPath;
-    /**
-     * File name
-     * @deprecated
-     * @deprecationMessage Use path instead.
-     */
-    file: FsPath;
-    /**
-     * Type of file:
-     * S - single word per line,
-     * W - each line can contain one or more words separated by space,
-     * C - each line is treated like code (Camel Case is allowed)
-     * Default is S
-     * C is the slowest to load due to the need to split each line based upon code splitting rules.
-     * @default "S"
-     */
-    type?: DictionaryFileTypes;
-}
-/**
- * Specifies the scope of a dictionary.
- */
-export declare type CustomDictionaryScope = 'user' | 'workspace' | 'folder';
-/**
- * For Defining Custom dictionaries. They are generally scoped to a
- * `user`, `workspace`, or `folder`.
- * When `addWords` is true, indicates that the spell checker can add words
- * to the file.
- * Note: only plain text files with one word per line are supported at this moment.
- */
-export interface DictionaryDefinitionCustom extends DictionaryDefinitionPreferred {
-    /** Path to custom dictionary text file. */
-    path: CustomDictionaryPath;
-    /**
-     * Defines the scope for when words will be added to the dictionary.
-     * Scope values: `user`, `workspace`, `folder`
-     */
-    scope?: CustomDictionaryScope | CustomDictionaryScope[];
-    /**
-     * When `true`, let's the spell checker know that words can be added to this dictionary.
-     */
-    addWords: boolean;
-}
-export interface LanguageSetting extends LanguageSettingFilterFields, BaseSetting {
-}
-export interface LanguageSettingFilterFields extends LanguageSettingFilterFieldsPreferred, LanguageSettingFilterFieldsDeprecated {
-}
-export interface LanguageSettingFilterFieldsPreferred {
-    /** The language id.  Ex: "typescript", "html", or "php".  "*" -- will match all languages */
-    languageId: LanguageId | LanguageIdSingle[];
-    /** The locale filter, matches against the language. This can be a comma separated list. "*" will match all locales. */
-    locale?: LocaleId | LocaleId[];
-}
-export interface LanguageSettingFilterFieldsDeprecated {
-    /** The language id.  Ex: "typescript", "html", or "php".  "*" -- will match all languages */
-    languageId: LanguageId | LanguageIdSingle[];
-    /**
-     * Deprecated - The locale filter, matches against the language. This can be a comma separated list. "*" will match all locales.
-     * @deprecated
-     * @deprecationMessage Use `locale` instead
-     */
-    local?: LocaleId | LocaleId[];
-}
-/** @hidden */
-declare type InternalRegExp = RegExp;
-export declare type Pattern = string | InternalRegExp;
-export declare type PredefinedPatterns = 'Base64' | 'CStyleComment' | 'CStyleHexValue' | 'CSSHexValue' | 'CommitHash' | 'CommitHashLink' | 'Email' | 'EscapeCharacters' | 'HexValues' | 'href' | 'PhpHereDoc' | 'PublicKey' | 'RsaCert' | 'SHA' | 'SpellCheckerDisable' | 'SpellCheckerDisableBlock' | 'SpellCheckerDisableLine' | 'SpellCheckerDisableNext' | 'SpellCheckerIgnoreInDocSetting' | 'string' | 'UnicodeRef' | 'Urls' | 'UUID' | 'Everything';
-/** This matches the name in a pattern definition */
-export declare type PatternId = string;
-/** A PatternRef is a Pattern or PatternId. */
-export declare type PatternRef = Pattern | PatternId | PredefinedPatterns;
-/** A list of pattern names or regular expressions */
-export declare type RegExpPatternList = PatternRef[];
-/**
- * This is the name of a dictionary.
- *
- * Name Format:
- * - Must contain at least 1 number or letter.
- * - spaces are allowed.
- * - Leading and trailing space will be removed.
- * - Names ARE case-sensitive
- * - Must not contain `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`
- *
- * @pattern ^(?=[^!*,;{}[\]~\n]+$)(?=(.*\w)).+$
- */
-export declare type DictionaryId = string;
-/**
- * This a reference to a named dictionary.
- * It is expected to match the name of a dictionary.
- */
-export declare type DictionaryRef = DictionaryId;
-/**
- * This a negative reference to a named dictionary.
- *
- * It is used to exclude or include a dictionary by name.
- *
- * The reference starts with 1 or more `!`.
- * - `!<dictionary_name>` - Used to exclude the dictionary matching `<dictionary_name>`
- * - `!!<dictionary_name>` - Used to re-include a dictionary matching `<dictionary_name>`
- *    Overrides `!<dictionary_name>`.
- * - `!!!<dictionary_name>` - Used to exclude a dictionary matching `<dictionary_name>`
- *    Overrides `!!<dictionary_name>`.
- *
- * @pattern ^(?=!+[^!*,;{}[\]~\n]+$)(?=(.*\w)).+$
- */
-export declare type DictionaryNegRef = string;
-/**
- * Reference to a dictionary by name.
- * One of:
- * - {@link DictionaryRef}
- * - {@link DictionaryNegRef}
- */
-export declare type DictionaryReference = DictionaryRef | DictionaryNegRef;
-/** This is a written language locale like: 'en', 'en-GB', 'fr', 'es', 'de', etc. */
-export declare type LocaleId = string;
-/**
- * Configuration File Version
- */
-export declare type VersionLatest = '0.2';
-/**
- * Legacy Configuration File Versions
- * @deprecated
- * @deprecationMessage Use `0.2`
- */
-export declare type VersionLegacy = '0.1';
-export declare type Version = VersionLatest | VersionLegacy;
-/**
- * @deprecated
- * @deprecationMessage Use LocaleId instead
- */
-export declare type LocalId = LocaleId;
-/** These are glob expressions */
-export declare type Glob = SimpleGlob | GlobDef;
-/** Simple Glob string, the root will be globRoot */
-export declare type SimpleGlob = string;
-/**
- * Used to define fully qualified glob patterns.
- * It is currently hidden to make the json-schema a bit easier to use
- * when crafting cspell.json files by hand.
- * @hidden
- */
-export interface GlobDef {
-    /** Glob pattern to match */
-    glob: string;
-    /** Optional root to use when matching the glob. Defaults to current working dir. */
-    root?: string;
-    /**
-     * Optional source of the glob, used when merging settings to determine the origin.
-     * @hidden
-     */
-    source?: string;
-}
-/**
- * This can be '*', 'typescript', 'cpp', 'json', etc.
- * @pattern ^(!?[-\w_\s]+)|(\*)$
- */
-export declare type LanguageIdSingle = string;
-/**
- * This can be 'typescript,cpp,json,literal haskell', etc.
- * @pattern ^([-\w_\s]+)(,[-\w_\s]+)*$
- */
-export declare type LanguageIdMultiple = string;
-/**
- * This can be 'typescript,cpp,json,literal haskell', etc.
- * @pattern ^(![-\w_\s]+)(,![-\w_\s]+)*$
- */
-export declare type LanguageIdMultipleNeg = string;
-export declare type LanguageId = LanguageIdSingle | LanguageIdMultiple | LanguageIdMultipleNeg;
-/** A File System Path */
-export declare type FsPath = string;
-/** Trust Security Level */
-export declare type TrustLevel = 'trusted' | 'untrusted';
-/**
- * A File System Path to a dictionary file.
- * @pattern ^.*\.(?:txt|trie)(?:\.gz)?$
- */
-export declare type DictionaryPath = string;
-/**
- * A File System Path to a dictionary file.
- * @pattern ^.*\.txt$
- */
-export declare type CustomDictionaryPath = string;
-export interface RegExpPatternDefinition {
-    /**
-     * Pattern name, used as an identifier in ignoreRegExpList and includeRegExpList.
-     * It is possible to redefine one of the predefined patterns to override its value.
-     */
-    name: PatternId;
-    /**
-     * RegExp pattern or array of RegExp patterns
-     */
-    pattern: Pattern | Pattern[];
-    /**
-     * Description of the pattern.
-     */
-    description?: string;
-}
-export declare type CSpellUserSettingsWithComments = CSpellUserSettings;
-export declare type Source = FileSource | MergeSource | InMemorySource | BaseSource;
-export interface FileSource extends BaseSource {
-    /** name of source */
-    name: string;
-    /** filename if this came from a file. */
-    filename: string;
-    /** The two settings that were merged to */
-    sources?: undefined;
-    /** The configuration read. */
-    fileSource: CSpellSettings;
-}
-export interface MergeSource extends BaseSource {
-    /** name of source */
-    name: string;
-    /** filename if this came from a file. */
-    filename?: undefined;
-    /** The two settings that were merged to */
-    sources: [CSpellSettings] | [CSpellSettings, CSpellSettings];
-    /** The configuration read. */
-    fileSource?: undefined;
-}
-export interface InMemorySource extends BaseSource {
-    /** name of source */
-    name: string;
-    /** filename if this came from a file. */
-    filename?: undefined;
-    /** The two settings that were merged to */
-    sources?: undefined;
-    /** The configuration read. */
-    fileSource?: undefined;
-}
-interface BaseSource {
-    /** name of source */
-    name: string;
-    /** filename if this came from a file. */
-    filename?: string;
-    /** The two settings that were merged to */
-    sources?: [CSpellSettings] | [CSpellSettings, CSpellSettings];
-    /** The configuration read. */
-    fileSource?: CSpellSettings;
-}
-/**
- * reporter name or reporter name + reporter config
- */
-export declare type ReporterSettings = string | [string] | [string, unknown];
-export {};
-//# sourceMappingURL=CSpellSettingsDef.d.ts.map

package/dist/settings/CSpellSettingsDef.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=CSpellSettingsDef.js.map

package/dist/settings/index.d.ts

@@ -1,2 +0,0 @@
-export * from './CSpellSettingsDef';
-//# sourceMappingURL=index.d.ts.map

package/dist/settings/index.js

@@ -1,14 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./CSpellSettingsDef"), exports);
-//# sourceMappingURL=index.js.map