@cspell/dict-en-common-misspellings 2.1.2 → 2.1.3

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 +62 -23
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -4,46 +4,85 @@ Common English Misspellings 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
- | Tool | Version |
10
- | ------------------------------------------------------------------------------------------------------------------------------------ | ------------ |
11
- | [cspell](https://github.com/streetsidesoftware/cspell) | `>= 6.25.0 ` |
12
- | [Code Spell Checker - Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker) | `>= 2.17.0` |
11
+ | Tool | Version |
12
+ | ------------------------------------------------------------------------------------------------------------------------------------ | ------- |
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` |
13
15
 
14
- ## Installation
16
+ <!--- @@inject-end: ../../static/requirements.md --->
15
17
 
16
- Global Install and add to CSpell global settings.
18
+ <!--- @@inject: ./static/install.md --->
17
19
 
18
- ```sh
19
- npm install -g @cspell/dict-en-common-misspellings
20
- cspell link add @cspell/dict-en-common-misspellings
21
- ```
20
+ ## Local Installation
22
21
 
23
- ## Uninstall from CSpell
22
+ **This package is bundled with CSpell.**
24
23
 
25
- ```sh
26
- cspell link remove @cspell/dict-en-common-misspellings
27
- ```
24
+ ## Configuration
28
25
 
29
- ## Manual Installation
26
+ <details>
27
+ <summary>VSCode Settings</summary>
30
28
 
31
- Manual installation is useful if you want to include this dictionary as part of your CI/CD lint process.
29
+ Add the following to your VSCode settings:
32
30
 
33
- ```
34
- npm i @cspell/dict-en-common-misspellings
31
+ **`.vscode/settings.json`**
32
+
33
+ ```jsonc
34
+ {
35
+ "cSpell.language": "en, en-gb, en-us",
36
+ }
35
37
  ```
36
38
 
37
- The `cspell-ext.json` file in this package should be added to the import section in your `cspell.json` file.
39
+ </details>
38
40
 
39
- ```javascript
41
+ <details>
42
+ <summary>CSpell Settings `cspell.json`</summary>
43
+
44
+ **`cspell.json`**
45
+
46
+ ```jsonc
40
47
  {
41
- // …
42
- "import": ["@cspell/dict-en-common-misspellings/cspell-ext.json"],
43
- // …
48
+ "language": "en, en-gb, en-us",
44
49
  }
45
50
  ```
46
51
 
52
+ </details>
53
+
54
+ <details>
55
+ <summary>CSpell Settings `cspell.config.yaml`</summary>
56
+
57
+ **`cspell.config.yaml`**
58
+
59
+ ```yaml
60
+ language: en, en-gb, en-us
61
+ ```
62
+
63
+ </details>
64
+
65
+ > [!NOTE]
66
+ > **This package is bundled with CSpell.**
67
+
68
+ <!--- @@inject-end: ./static/install.md --->
69
+
70
+ <!--- @@inject: ../../static/contributing.md --->
71
+
72
+ ## Contributing
73
+
74
+ Please help correct any mistakes in the dictionaries.
75
+
76
+ See: [Contributing](https://github.com/streetsidesoftware/cspell-dicts#contributing)
77
+
78
+ Special thanks to all of our amazing contributors!
79
+
80
+ ### Dictionary Development
81
+
82
+ See: [How to Create a New Dictionary](https://github.com/streetsidesoftware/cspell-dicts#how-to-create-a-new-dictionary)
83
+
84
+ <!--- @@inject-end: ../../static/contributing.md --->
85
+
47
86
  ## Reference
48
87
 
49
88
  The source of this dictionary comes from:
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@cspell/dict-en-common-misspellings",
3
- "version": "2.1.2",
3
+ "version": "2.1.3",
4
4
  "description": "Common English misspellings dictionary for cspell.",
5
5
  "publishConfig": {
6
6
  "access": "public",
@@ -42,5 +42,5 @@
42
42
  "cspell-ext.json",
43
43
  "dict/dict-*.json"
44
44
  ],
45
- "gitHead": "df1af07eae74df2d7cbf3eba25a433a1553aa497"
45
+ "gitHead": "30c5c53b8e28152fc1d8a6cf0c872b068a64221a"
46
46
  }