@cspell/cspell-types 7.0.0-alpha.2 → 7.0.1-alpha.1

package/cspell.schema.json

@@ -899,7 +899,7 @@
         },
         "ignoreRegExpList": {
           "$ref": "#/definitions/RegExpPatternList",
-          "description": "List of regular expression patterns or pattern names to exclude from spell checking.\n\nExample: [\"href\"] - to exclude html href.\n\nBy default, several patterns are excluded. See [Configuration](https://cspell.org/configuration/#cspelljson-sections) for more details.\n\nWhile you can create your own patterns, you can also leverage several patterns that are [built-in to CSpell](https://github.com/streetsidesoftware/cspell/blob/main/packages/cspell-lib/src/Settings/DefaultSettings.ts#L22)."
+          "description": "List of regular expression patterns or pattern names to exclude from spell checking.\n\nExample: `[\"href\"]` - to exclude html href pattern.\n\nRegular expressions use JavaScript regular expression syntax.\n\nExample: to ignore ALL-CAPS words\n\nJSON ```json \"ignoreRegExpList\": [\"/\\\\b[A-Z]+\\\\b/g\"] ```\n\nYAML ```yaml ignoreRegExpList:   - >-    /\\b[A-Z]+\\b/g ```\n\nBy default, several patterns are excluded. See [Configuration](https://cspell.org/configuration/patterns) for more details.\n\nWhile you can create your own patterns, you can also leverage several patterns that are [built-in to CSpell](https://cspell.org/types/cspell-types/types/PredefinedPatterns.html)."
         },
         "ignoreWords": {
           "description": "List of words to be ignored. An ignored word will not show up as an error, even if it is also in the `flagWords`.",
@@ -910,7 +910,7 @@
         },
         "includeRegExpList": {
           "$ref": "#/definitions/RegExpPatternList",
-          "description": "List of regular expression patterns or defined pattern names to match for spell checking.\n\nIf this property is defined, only text matching the included patterns will be checked.\n\nWhile you can create your own patterns, you can also leverage several patterns that are [built-in to CSpell](https://github.com/streetsidesoftware/cspell/blob/main/packages/cspell-lib/src/Settings/DefaultSettings.ts#L22)."
+          "description": "List of regular expression patterns or defined pattern names to match for spell checking.\n\nIf this property is defined, only text matching the included patterns will be checked.\n\nWhile you can create your own patterns, you can also leverage several patterns that are [built-in to CSpell](https://cspell.org/types/cspell-types/types/PredefinedPatterns.html)."
         },
         "languageId": {
           "$ref": "#/definitions/MatchingFileType",
@@ -1081,7 +1081,7 @@
         },
         "ignoreRegExpList": {
           "$ref": "#/definitions/RegExpPatternList",
-          "description": "List of regular expression patterns or pattern names to exclude from spell checking.\n\nExample: [\"href\"] - to exclude html href.\n\nBy default, several patterns are excluded. See [Configuration](https://cspell.org/configuration/#cspelljson-sections) for more details.\n\nWhile you can create your own patterns, you can also leverage several patterns that are [built-in to CSpell](https://github.com/streetsidesoftware/cspell/blob/main/packages/cspell-lib/src/Settings/DefaultSettings.ts#L22)."
+          "description": "List of regular expression patterns or pattern names to exclude from spell checking.\n\nExample: `[\"href\"]` - to exclude html href pattern.\n\nRegular expressions use JavaScript regular expression syntax.\n\nExample: to ignore ALL-CAPS words\n\nJSON ```json \"ignoreRegExpList\": [\"/\\\\b[A-Z]+\\\\b/g\"] ```\n\nYAML ```yaml ignoreRegExpList:   - >-    /\\b[A-Z]+\\b/g ```\n\nBy default, several patterns are excluded. See [Configuration](https://cspell.org/configuration/patterns) for more details.\n\nWhile you can create your own patterns, you can also leverage several patterns that are [built-in to CSpell](https://cspell.org/types/cspell-types/types/PredefinedPatterns.html)."
         },
         "ignoreWords": {
           "description": "List of words to be ignored. An ignored word will not show up as an error, even if it is also in the `flagWords`.",
@@ -1092,7 +1092,7 @@
         },
         "includeRegExpList": {
           "$ref": "#/definitions/RegExpPatternList",
-          "description": "List of regular expression patterns or defined pattern names to match for spell checking.\n\nIf this property is defined, only text matching the included patterns will be checked.\n\nWhile you can create your own patterns, you can also leverage several patterns that are [built-in to CSpell](https://github.com/streetsidesoftware/cspell/blob/main/packages/cspell-lib/src/Settings/DefaultSettings.ts#L22)."
+          "description": "List of regular expression patterns or defined pattern names to match for spell checking.\n\nIf this property is defined, only text matching the included patterns will be checked.\n\nWhile you can create your own patterns, you can also leverage several patterns that are [built-in to CSpell](https://cspell.org/types/cspell-types/types/PredefinedPatterns.html)."
         },
         "language": {
           "$ref": "#/definitions/LocaleId",
@@ -1553,7 +1553,7 @@
     },
     "ignoreRegExpList": {
       "$ref": "#/definitions/RegExpPatternList",
-      "description": "List of regular expression patterns or pattern names to exclude from spell checking.\n\nExample: [\"href\"] - to exclude html href.\n\nBy default, several patterns are excluded. See [Configuration](https://cspell.org/configuration/#cspelljson-sections) for more details.\n\nWhile you can create your own patterns, you can also leverage several patterns that are [built-in to CSpell](https://github.com/streetsidesoftware/cspell/blob/main/packages/cspell-lib/src/Settings/DefaultSettings.ts#L22)."
+      "description": "List of regular expression patterns or pattern names to exclude from spell checking.\n\nExample: `[\"href\"]` - to exclude html href pattern.\n\nRegular expressions use JavaScript regular expression syntax.\n\nExample: to ignore ALL-CAPS words\n\nJSON ```json \"ignoreRegExpList\": [\"/\\\\b[A-Z]+\\\\b/g\"] ```\n\nYAML ```yaml ignoreRegExpList:   - >-    /\\b[A-Z]+\\b/g ```\n\nBy default, several patterns are excluded. See [Configuration](https://cspell.org/configuration/patterns) for more details.\n\nWhile you can create your own patterns, you can also leverage several patterns that are [built-in to CSpell](https://cspell.org/types/cspell-types/types/PredefinedPatterns.html)."
     },
     "ignoreWords": {
       "description": "List of words to be ignored. An ignored word will not show up as an error, even if it is also in the `flagWords`.",
@@ -1578,7 +1578,7 @@
     },
     "includeRegExpList": {
       "$ref": "#/definitions/RegExpPatternList",
-      "description": "List of regular expression patterns or defined pattern names to match for spell checking.\n\nIf this property is defined, only text matching the included patterns will be checked.\n\nWhile you can create your own patterns, you can also leverage several patterns that are [built-in to CSpell](https://github.com/streetsidesoftware/cspell/blob/main/packages/cspell-lib/src/Settings/DefaultSettings.ts#L22)."
+      "description": "List of regular expression patterns or defined pattern names to match for spell checking.\n\nIf this property is defined, only text matching the included patterns will be checked.\n\nWhile you can create your own patterns, you can also leverage several patterns that are [built-in to CSpell](https://cspell.org/types/cspell-types/types/PredefinedPatterns.html)."
     },
     "language": {
       "$ref": "#/definitions/LocaleId",

package/dist/cjs/CSpellSettingsDef.d.ts

@@ -419,13 +419,29 @@ export interface BaseSetting extends InlineDictionary, ExperimentalBaseSettings
     /**
      * List of regular expression patterns or pattern names to exclude from spell checking.
      *
-     * Example: ["href"] - to exclude html href.
+     * Example: `["href"]` - to exclude html href pattern.
+     *
+     * Regular expressions use JavaScript regular expression syntax.
+     *
+     * Example: to ignore ALL-CAPS words
+     *
+     * JSON
+     * ```json
+     * "ignoreRegExpList": ["/\\b[A-Z]+\\b/g"]
+     * ```
+     *
+     * YAML
+     * ```yaml
+     * ignoreRegExpList:
+     *   - >-
+     *    /\b[A-Z]+\b/g
+     * ```
      *
      * By default, several patterns are excluded. See
-     * [Configuration](https://cspell.org/configuration/#cspelljson-sections) for more details.
+     * [Configuration](https://cspell.org/configuration/patterns) for more details.
      *
      * While you can create your own patterns, you can also leverage several patterns that are
-     * [built-in to CSpell](https://github.com/streetsidesoftware/cspell/blob/main/packages/cspell-lib/src/Settings/DefaultSettings.ts#L22).
+     * [built-in to CSpell](https://cspell.org/types/cspell-types/types/PredefinedPatterns.html).
      */
     ignoreRegExpList?: RegExpPatternList;
     /**
@@ -434,7 +450,7 @@ export interface BaseSetting extends InlineDictionary, ExperimentalBaseSettings
      * If this property is defined, only text matching the included patterns will be checked.
      *
      * While you can create your own patterns, you can also leverage several patterns that are
-     * [built-in to CSpell](https://github.com/streetsidesoftware/cspell/blob/main/packages/cspell-lib/src/Settings/DefaultSettings.ts#L22).
+     * [built-in to CSpell](https://cspell.org/types/cspell-types/types/PredefinedPatterns.html).
      */
     includeRegExpList?: RegExpPatternList;
     /**

package/dist/esm/CSpellSettingsDef.d.mts

@@ -419,13 +419,29 @@ export interface BaseSetting extends InlineDictionary, ExperimentalBaseSettings
     /**
      * List of regular expression patterns or pattern names to exclude from spell checking.
      *
-     * Example: ["href"] - to exclude html href.
+     * Example: `["href"]` - to exclude html href pattern.
+     *
+     * Regular expressions use JavaScript regular expression syntax.
+     *
+     * Example: to ignore ALL-CAPS words
+     *
+     * JSON
+     * ```json
+     * "ignoreRegExpList": ["/\\b[A-Z]+\\b/g"]
+     * ```
+     *
+     * YAML
+     * ```yaml
+     * ignoreRegExpList:
+     *   - >-
+     *    /\b[A-Z]+\b/g
+     * ```
      *
      * By default, several patterns are excluded. See
-     * [Configuration](https://cspell.org/configuration/#cspelljson-sections) for more details.
+     * [Configuration](https://cspell.org/configuration/patterns) for more details.
      *
      * While you can create your own patterns, you can also leverage several patterns that are
-     * [built-in to CSpell](https://github.com/streetsidesoftware/cspell/blob/main/packages/cspell-lib/src/Settings/DefaultSettings.ts#L22).
+     * [built-in to CSpell](https://cspell.org/types/cspell-types/types/PredefinedPatterns.html).
      */
     ignoreRegExpList?: RegExpPatternList;
     /**
@@ -434,7 +450,7 @@ export interface BaseSetting extends InlineDictionary, ExperimentalBaseSettings
      * If this property is defined, only text matching the included patterns will be checked.
      *
      * While you can create your own patterns, you can also leverage several patterns that are
-     * [built-in to CSpell](https://github.com/streetsidesoftware/cspell/blob/main/packages/cspell-lib/src/Settings/DefaultSettings.ts#L22).
+     * [built-in to CSpell](https://cspell.org/types/cspell-types/types/PredefinedPatterns.html).
      */
     includeRegExpList?: RegExpPatternList;
     /**

package/dist/esm/CSpellSettingsDef.d.ts

@@ -419,13 +419,29 @@ export interface BaseSetting extends InlineDictionary, ExperimentalBaseSettings
     /**
      * List of regular expression patterns or pattern names to exclude from spell checking.
      *
-     * Example: ["href"] - to exclude html href.
+     * Example: `["href"]` - to exclude html href pattern.
+     *
+     * Regular expressions use JavaScript regular expression syntax.
+     *
+     * Example: to ignore ALL-CAPS words
+     *
+     * JSON
+     * ```json
+     * "ignoreRegExpList": ["/\\b[A-Z]+\\b/g"]
+     * ```
+     *
+     * YAML
+     * ```yaml
+     * ignoreRegExpList:
+     *   - >-
+     *    /\b[A-Z]+\b/g
+     * ```
      *
      * By default, several patterns are excluded. See
-     * [Configuration](https://cspell.org/configuration/#cspelljson-sections) for more details.
+     * [Configuration](https://cspell.org/configuration/patterns) for more details.
      *
      * While you can create your own patterns, you can also leverage several patterns that are
-     * [built-in to CSpell](https://github.com/streetsidesoftware/cspell/blob/main/packages/cspell-lib/src/Settings/DefaultSettings.ts#L22).
+     * [built-in to CSpell](https://cspell.org/types/cspell-types/types/PredefinedPatterns.html).
      */
     ignoreRegExpList?: RegExpPatternList;
     /**
@@ -434,7 +450,7 @@ export interface BaseSetting extends InlineDictionary, ExperimentalBaseSettings
      * If this property is defined, only text matching the included patterns will be checked.
      *
      * While you can create your own patterns, you can also leverage several patterns that are
-     * [built-in to CSpell](https://github.com/streetsidesoftware/cspell/blob/main/packages/cspell-lib/src/Settings/DefaultSettings.ts#L22).
+     * [built-in to CSpell](https://cspell.org/types/cspell-types/types/PredefinedPatterns.html).
      */
     includeRegExpList?: RegExpPatternList;
     /**

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "7.0.0-alpha.2",
+  "version": "7.0.1-alpha.1",
   "description": "Types for cspell and cspell-lib",
   "type": "commonjs",
   "main": "./dist/cjs/index.js",
@@ -90,5 +90,5 @@
     "ts-json-schema-generator": "^1.2.0",
     "typescript": "^4.9.5"
   },
-  "gitHead": "a1b7c5daeef5afdb14d6444318f450b9fd9c035a"
+  "gitHead": "053cd11992a03203786ed64fdf9fa719eeded824"
 }