docs: Fix broken links (#4565)

streetsidesoftware · Jun 20, 2023 · 70d3695 · 70d3695
1 parent 8efdf69
commit 70d3695
Show file tree

Hide file tree

Showing 4 changed files with 44 additions and 17 deletions.
diff --git a/cspell.schema.json b/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 pattern.\n\nRegular expressions use JavaScript regular expression syntax.\n\nExample: to ignore ALL-CAPS words\n\nJSON ```json \"ignoreRegExpList\": [\"/\\\\w[A-Z]+\\\\w/g\"] ```\n\nYAML ```yaml ignoreRegExpList:   - >-    /\\w[A-Z]+\\w/g ```\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://cspell.org/types/cspell-types/modules/#predefinedpatterns)."
+          "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\": [\"/\\\\w[A-Z]+\\\\w/g\"] ```\n\nYAML ```yaml ignoreRegExpList:   - >-    /\\w[A-Z]+\\w/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://cspell.org/types/cspell-types/modules/#predefinedpatterns)."
+          "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 pattern.\n\nRegular expressions use JavaScript regular expression syntax.\n\nExample: to ignore ALL-CAPS words\n\nJSON ```json \"ignoreRegExpList\": [\"/\\\\w[A-Z]+\\\\w/g\"] ```\n\nYAML ```yaml ignoreRegExpList:   - >-    /\\w[A-Z]+\\w/g ```\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://cspell.org/types/cspell-types/modules/#predefinedpatterns)."
+          "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\": [\"/\\\\w[A-Z]+\\\\w/g\"] ```\n\nYAML ```yaml ignoreRegExpList:   - >-    /\\w[A-Z]+\\w/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://cspell.org/types/cspell-types/modules/#predefinedpatterns)."
+          "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 pattern.\n\nRegular expressions use JavaScript regular expression syntax.\n\nExample: to ignore ALL-CAPS words\n\nJSON ```json \"ignoreRegExpList\": [\"/\\\\w[A-Z]+\\\\w/g\"] ```\n\nYAML ```yaml ignoreRegExpList:   - >-    /\\w[A-Z]+\\w/g ```\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://cspell.org/types/cspell-types/modules/#predefinedpatterns)."
+      "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\": [\"/\\\\w[A-Z]+\\\\w/g\"] ```\n\nYAML ```yaml ignoreRegExpList:   - >-    /\\w[A-Z]+\\w/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://cspell.org/types/cspell-types/modules/#predefinedpatterns)."
+      "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",

diff --git a/docs/configuration/patterns.md b/docs/configuration/patterns.md
@@ -40,9 +40,36 @@ ignoreRegExpList:
 - `Email` is a predefined pattern.
 - `/ftp:[^\s]*/g` - will match anything that starts with `ftp:` until the first space.
 
-## Patterns
+# Patterns
 
-Patterns allow you to define reusable patterns for excluding or
+Patterns allow you to define reusable patterns for excluding or including text to be spell checked. To exclude text matching a pattern from being spell checked, include it the `ignoreRegExpList`.
+
+## Predefined Patterns
+
+- See: [Predefined Patterns](https://cspell.org/types/cspell-types/types/PredefinedPatterns.html)
+
+## Default `ignoreRegExpList` Patterns
+
+<!--- https://github.com/streetsidesoftware/cspell/blob/main/packages/cspell-lib/src/lib/Settings/DefaultSettings.ts#L68 --->
+
+The following patterns are used by default to ignore non-text content.
+
+```
+    Urls
+    Email
+    RsaCert
+    SshRsa
+    Base64MultiLine
+    Base64SingleLine
+    CommitHash
+    CommitHashLink
+    CStyleHexValue
+    CSSHexValue
+    SHA
+    HashStrings
+    UnicodeRef
+    UUID
+```
 
 # Verbose Regular Expressions
 

diff --git a/packages/cspell-types/cspell.schema.json b/packages/cspell-types/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 pattern.\n\nRegular expressions use JavaScript regular expression syntax.\n\nExample: to ignore ALL-CAPS words\n\nJSON ```json \"ignoreRegExpList\": [\"/\\\\w[A-Z]+\\\\w/g\"] ```\n\nYAML ```yaml ignoreRegExpList:   - >-    /\\w[A-Z]+\\w/g ```\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://cspell.org/types/cspell-types/modules/#predefinedpatterns)."
+          "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\": [\"/\\\\w[A-Z]+\\\\w/g\"] ```\n\nYAML ```yaml ignoreRegExpList:   - >-    /\\w[A-Z]+\\w/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://cspell.org/types/cspell-types/modules/#predefinedpatterns)."
+          "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 pattern.\n\nRegular expressions use JavaScript regular expression syntax.\n\nExample: to ignore ALL-CAPS words\n\nJSON ```json \"ignoreRegExpList\": [\"/\\\\w[A-Z]+\\\\w/g\"] ```\n\nYAML ```yaml ignoreRegExpList:   - >-    /\\w[A-Z]+\\w/g ```\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://cspell.org/types/cspell-types/modules/#predefinedpatterns)."
+          "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\": [\"/\\\\w[A-Z]+\\\\w/g\"] ```\n\nYAML ```yaml ignoreRegExpList:   - >-    /\\w[A-Z]+\\w/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://cspell.org/types/cspell-types/modules/#predefinedpatterns)."
+          "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 pattern.\n\nRegular expressions use JavaScript regular expression syntax.\n\nExample: to ignore ALL-CAPS words\n\nJSON ```json \"ignoreRegExpList\": [\"/\\\\w[A-Z]+\\\\w/g\"] ```\n\nYAML ```yaml ignoreRegExpList:   - >-    /\\w[A-Z]+\\w/g ```\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://cspell.org/types/cspell-types/modules/#predefinedpatterns)."
+      "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\": [\"/\\\\w[A-Z]+\\\\w/g\"] ```\n\nYAML ```yaml ignoreRegExpList:   - >-    /\\w[A-Z]+\\w/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://cspell.org/types/cspell-types/modules/#predefinedpatterns)."
+      "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",

diff --git a/packages/cspell-types/src/CSpellSettingsDef.ts b/packages/cspell-types/src/CSpellSettingsDef.ts
@@ -499,10 +499,10 @@ export interface BaseSetting extends InlineDictionary, ExperimentalBaseSettings
      * ```
      *
      * 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://cspell.org/types/cspell-types/modules/#predefinedpatterns).
+     * [built-in to CSpell](https://cspell.org/types/cspell-types/types/PredefinedPatterns.html).
      */
     ignoreRegExpList?: RegExpPatternList;
 
@@ -512,7 +512,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://cspell.org/types/cspell-types/modules/#predefinedpatterns).
+     * [built-in to CSpell](https://cspell.org/types/cspell-types/types/PredefinedPatterns.html).
      */
     includeRegExpList?: RegExpPatternList;