braze-docs/cspell.json at develop · brazethatwallace/braze-docs · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
{
  "$schema": "https://raw.githubusercontent.com/streetsidesoftware/cspell/main/cspell.schema.json",
  "version": "0.2",
  "language": "en",
  "dictionaries": ["en_us", "braze-words"],
  "dictionaryDefinitions": [
    {
      "name": "braze-words",
      "path": "./config/cspell/braze-dictionary.txt",
      "description": "Braze docs: product terms, glossary, Liquid/Kramdown tokens, and intentional style-guide wording."
    }
  ],
  "ignorePaths": [
    "_lang/**",
    "_docs/_hidden/**",
    "node_modules/**",
    "vendor/**",
    ".git/**",
    "config/cspell/unique-unknown-from-full-sweep.txt"
  ],
  "ignoreRegExpList": [
    "Urls",
    "Email",
    "href",
    "/^---\\s*\\r?\\n[\\s\\S]*?\\r?\\n---\\s*\\r?\\n/",
    "/@[a-z0-9][-a-z0-9.]*\\.[a-z]{2,}\\b/gi",
    "/\\b(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\\.)+(?:com|io|net|org|dev|co|app|ai|us|uk|edu|gov|me|xyz|cloud|tech|bz|ca|de|fr|jp)\\b/gi",
    "/\\{::[^}]+\\}/g",
    "/\\{:[^}]*\\}/g",
    "/\\{%[\\s\\S]*?%\\}/g",
    "/\\{\\{[\\s\\S]*?\\}\\}/g",
    "/`[^`]*`/g",
    "/<[^>\\s][^>]*>/g",
    "/url\\s*\\(\\s*\"data:[^\"]*\"\\)/gi",
    "/url\\s*\\(\\s*'data:[^']*'\\)/gi",
    "/^[^\\n]*Lorem ipsum[^\\n]*$/gim",
    "/\\b[a-z]{2,}in['\\u2019]/gi"
  ],
  "overrides": [
    {
      "filename": "**/*.md",
      "dictionaries": ["en_us", "braze-words"],
      "ignoreRegExpList": [
        "Urls",
        "Email",
        "href",
        "/^---\\s*\\r?\\n[\\s\\S]*?\\r?\\n---\\s*\\r?\\n/",
        "/@[a-z0-9][-a-z0-9.]*\\.[a-z]{2,}\\b/gi",
        "/\\b(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\\.)+(?:com|io|net|org|dev|co|app|ai|us|uk|edu|gov|me|xyz|cloud|tech|bz|ca|de|fr|jp)\\b/gi",
        "/\\{::[^}]+\\}/g",
        "/\\{:[^}]*\\}/g",
        "/\\{%[\\s\\S]*?%\\}/g",
        "/\\{\\{[\\s\\S]*?\\}\\}/g",
        "/`[^`]*`/g",
        "/<[^>\\s][^>]*>/g",
        "/url\\s*\\(\\s*\"data:[^\"]*\"\\)/gi",
        "/url\\s*\\(\\s*'data:[^']*'\\)/gi",
        "/^[^\\n]*Lorem ipsum[^\\n]*$/gim",
        "/\\b[a-z]{2,}in['\\u2019]/gi"
      ]
    },
    {
      "filename": "_docs/_contributing/styling_examples.md",
      "words": [
        "UNBROKENHIGHLIGHTTHATISVERYLONGUNBROKENHIGHLIGHTTHATISVERYLONG",
        "UNBROKENWORDTHATISVERYLONGUNBROKENWORDTHATISVERYLONG"
      ]
    }
  ]
}