@cspell/dict-en-ca 1.0.39 → 1.0.41

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/README.md +120 -19
  2. package/en_CA.trie +304 -304
  3. package/package.json +2 -2
package/README.md CHANGED
@@ -4,48 +4,149 @@ Canadian English dictionary for cspell.
4
4
 
5
5
  This is a pre-built dictionary for use with cspell.
6
6
 
7
+ <!--- @@inject: ../../static/requirements.md --->
8
+
7
9
  ## Requirements
8
10
 
9
11
  | Tool | Version |
10
12
  | ------------------------------------------------------------------------------------------------------------------------------------ | ------- |
11
- | [cspell](https://github.com/streetsidesoftware/cspell) | `>= 6` |
12
- | [Code Spell Checker - Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker) | `>= 2` |
13
+ | [cspell](https://github.com/streetsidesoftware/cspell) | `>= 8` |
14
+ | [Code Spell Checker - Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker) | `>= 4` |
15
+
16
+ <!--- @@inject-end: ../../static/requirements.md --->
13
17
 
14
- ## Installation
18
+ <!--- @@inject: ./static/install.md --->
15
19
 
16
- Global Install and add to cspell global settings.
20
+ ## Local Installation
17
21
 
18
22
  ```sh
19
- npm install -g @cspell/dict-en-ca
20
- cspell link add @cspell/dict-en-ca
23
+ npm install -D @cspell/dict-en-ca
21
24
  ```
22
25
 
23
- ## Uninstall from cspell
26
+ ## Configuration
24
27
 
25
- ```sh
26
- cspell link remove @cspell/dict-en-ca
28
+ <details>
29
+ <summary>VSCode Settings</summary>
30
+
31
+ Add the following to your VSCode settings:
32
+
33
+ **`.vscode/settings.json`**
34
+
35
+ ```jsonc
36
+ {
37
+ "cSpell.import": ["@cspell/dict-en-ca/cspell-ext.json"],
38
+ "cSpell.language": "en-CA",
39
+ }
27
40
  ```
28
41
 
29
- ## Manual Installation
42
+ </details>
43
+
44
+ <details>
45
+ <summary>CSpell Settings <code>cspell.json</code></summary>
30
46
 
31
- The `cspell-ext.json` file in this package should be added to the import section in your cspell.json file.
47
+ **`cspell.json`**
32
48
 
33
- ```javascript
49
+ ```jsonc
34
50
  {
35
- // …
36
- "import": ["@cspell/dict-en-ca/cspell-ext.json"],
37
- // …
51
+ "import": ["@cspell/dict-en-ca/cspell-ext.json"],
52
+ "language": "en-CA",
38
53
  }
39
54
  ```
40
55
 
41
- ## Building
56
+ </details>
42
57
 
43
- Building is only necessary if you want to modify the contents of the dictionary. Note: Building will take a few minutes for large files.
58
+ <details>
59
+ <summary>CSpell Settings <code>cspell.config.yaml</code></summary>
44
60
 
45
- ```sh
46
- npm run build
61
+ **`cspell.config.yaml`**
62
+
63
+ ```yaml
64
+ import:
65
+ - '@cspell/dict-en-ca/cspell-ext.json'
66
+ language: en-CA
67
+ ```
68
+
69
+ </details>
70
+
71
+ ## Local Installation using CDN
72
+
73
+ ## CDN Configuration
74
+
75
+ <details>
76
+ <summary>VSCode Settings</summary>
77
+
78
+ Add the following to your VSCode settings:
79
+
80
+ **`.vscode/settings.json`**
81
+
82
+ ```jsonc
83
+ {
84
+ "cSpell.import": ["https://cdn.jsdelivr.net/npm/@cspell/dict-en-ca@latest/cspell-ext.json/cspell-ext.json"],
85
+ "cSpell.language": "en-CA",
86
+ }
47
87
  ```
48
88
 
89
+ </details>
90
+
91
+ <details>
92
+ <summary>CSpell Settings <code>cspell.json</code></summary>
93
+
94
+ **`cspell.json`**
95
+
96
+ ```jsonc
97
+ {
98
+ "import": ["https://cdn.jsdelivr.net/npm/@cspell/dict-en-ca@latest/cspell-ext.json/cspell-ext.json"],
99
+ "language": "en-CA",
100
+ }
101
+ ```
102
+
103
+ </details>
104
+
105
+ <details>
106
+ <summary>CSpell Settings <code>cspell.config.yaml</code></summary>
107
+
108
+ **`cspell.config.yaml`**
109
+
110
+ ```yaml
111
+ import:
112
+ - https://cdn.jsdelivr.net/npm/@cspell/dict-en-ca@latest/cspell-ext.json/cspell-ext.json
113
+ language: en-CA
114
+ ```
115
+
116
+ </details>
117
+
118
+ ## Dictionary Information
119
+
120
+ | Name | Enabled | Description |
121
+ | ------------------------ | ------- | --------------------------- |
122
+ | `en-ca` | | Canadian English Dictionary |
123
+ | `en-common-misspellings` | | _External_ |
124
+
125
+ ## Language Settings
126
+
127
+ | Name | Locale | File Type |
128
+ | ------------------------ | ------- | --------- |
129
+ | `en-ca` | `en-CA` | `*` |
130
+ | `en-common-misspellings` | `en-CA` | `*` |
131
+
132
+ <!--- @@inject-end: ./static/install.md --->
133
+
134
+ <!--- @@inject: ../../static/contributing.md --->
135
+
136
+ ## Contributing
137
+
138
+ Please help correct any mistakes in the dictionaries.
139
+
140
+ See: [Contributing](https://github.com/streetsidesoftware/cspell-dicts#contributing)
141
+
142
+ Special thanks to all of our amazing contributors!
143
+
144
+ ### Dictionary Development
145
+
146
+ See: [How to Create a New Dictionary](https://github.com/streetsidesoftware/cspell-dicts#how-to-create-a-new-dictionary)
147
+
148
+ <!--- @@inject-end: ../../static/contributing.md --->
149
+
49
150
  ## Adding Words
50
151
 
51
152
  Contributions are welcomed and encouraged, please read [src/README.md](https://github.com/streetsidesoftware/cspell-dicts/blob/main/dictionaries/en_CA/src/README.md).