@cspell/dict-en-ca 1.0.39 → 1.0.40

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 (2) hide show
  1. package/README.md +104 -19
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -4,48 +4,133 @@ 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 `cspell.json`</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 `cspell.config.yaml`</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
+ ## CDN Configuration
72
+
73
+ <details>
74
+ <summary>VSCode Settings</summary>
75
+
76
+ Add the following to your VSCode settings:
77
+
78
+ **`.vscode/settings.json`**
79
+
80
+ ```jsonc
81
+ {
82
+ "cSpell.import": ["https://cdn.jsdelivr.net/npm/@cspell/dict-en-ca@latest/cspell-ext.json/cspell-ext.json"],
83
+ "cSpell.language": "en-CA",
84
+ }
85
+ ```
86
+
87
+ </details>
88
+
89
+ <details>
90
+ <summary>CSpell Settings `cspell.json`</summary>
91
+
92
+ **`cspell.json`**
93
+
94
+ ```jsonc
95
+ {
96
+ "import": ["https://cdn.jsdelivr.net/npm/@cspell/dict-en-ca@latest/cspell-ext.json/cspell-ext.json"],
97
+ "language": "en-CA",
98
+ }
99
+ ```
100
+
101
+ </details>
102
+
103
+ <details>
104
+ <summary>CSpell Settings `cspell.config.yaml`</summary>
105
+
106
+ **`cspell.config.yaml`**
107
+
108
+ ```yaml
109
+ import:
110
+ - https://cdn.jsdelivr.net/npm/@cspell/dict-en-ca@latest/cspell-ext.json/cspell-ext.json
111
+ language: en-CA
47
112
  ```
48
113
 
114
+ </details>
115
+
116
+ <!--- @@inject-end: ./static/install.md --->
117
+
118
+ <!--- @@inject: ../../static/contributing.md --->
119
+
120
+ ## Contributing
121
+
122
+ Please help correct any mistakes in the dictionaries.
123
+
124
+ See: [Contributing](https://github.com/streetsidesoftware/cspell-dicts#contributing)
125
+
126
+ Special thanks to all of our amazing contributors!
127
+
128
+ ### Dictionary Development
129
+
130
+ See: [How to Create a New Dictionary](https://github.com/streetsidesoftware/cspell-dicts#how-to-create-a-new-dictionary)
131
+
132
+ <!--- @@inject-end: ../../static/contributing.md --->
133
+
49
134
  ## Adding Words
50
135
 
51
136
  Contributions are welcomed and encouraged, please read [src/README.md](https://github.com/streetsidesoftware/cspell-dicts/blob/main/dictionaries/en_CA/src/README.md).
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@cspell/dict-en-ca",
3
- "version": "1.0.39",
3
+ "version": "1.0.40",
4
4
  "description": "Canadian English dictionary for cspell.",
5
5
  "publishConfig": {
6
6
  "access": "public",
@@ -52,5 +52,5 @@
52
52
  "@cspell/aoo-mozilla-en-dict": "workspace:^",
53
53
  "@cspell/dict-en-shared": "workspace:^"
54
54
  },
55
- "gitHead": "df1af07eae74df2d7cbf3eba25a433a1553aa497"
55
+ "gitHead": "30c5c53b8e28152fc1d8a6cf0c872b068a64221a"
56
56
  }