@cspell/dict-en-gb-legacy 1.0.8 → 1.0.10

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 +125 -11
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -5,33 +5,147 @@ British English Legacy dictionary for cspell.
5
5
  This dictionary includes words that had been included in older versions of the en_GB dictionary.
6
6
  They have been moved here to make the en_GB dictionary easier to maintain.
7
7
 
8
+ <!--- @@inject: ../../static/requirements.md --->
9
+
8
10
  ## Requirements
9
11
 
10
12
  | Tool | Version |
11
13
  | ------------------------------------------------------------------------------------------------------------------------------------ | ------- |
12
- | [cspell](https://github.com/streetsidesoftware/cspell) | `>= 6` |
13
- | [Code Spell Checker - Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker) | `>= 2` |
14
+ | [cspell](https://github.com/streetsidesoftware/cspell) | `>= 8` |
15
+ | [Code Spell Checker - Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker) | `>= 4` |
16
+
17
+ <!--- @@inject-end: ../../static/requirements.md --->
14
18
 
15
- ## Installation
19
+ <!--- @@inject: ./static/install.md --->
16
20
 
17
- Global Install and add to cspell global settings.
21
+ ## Local Installation
18
22
 
19
23
  ```sh
20
- npm install @cspell/dict-en-gb-legacy
24
+ npm install -D @cspell/dict-en-gb-legacy
25
+ ```
26
+
27
+ ## Configuration
28
+
29
+ <details>
30
+ <summary>VSCode Settings</summary>
31
+
32
+ Add the following to your VSCode settings:
33
+
34
+ **`.vscode/settings.json`**
35
+
36
+ ```jsonc
37
+ {
38
+ "cSpell.import": ["@cspell/dict-en-gb-legacy/cspell-ext.json"],
39
+ "cSpell.language": "en-GB",
40
+ }
41
+ ```
42
+
43
+ </details>
44
+
45
+ <details>
46
+ <summary>CSpell Settings <code>cspell.json</code></summary>
47
+
48
+ **`cspell.json`**
49
+
50
+ ```jsonc
51
+ {
52
+ "import": ["@cspell/dict-en-gb-legacy/cspell-ext.json"],
53
+ "language": "en-GB",
54
+ }
55
+ ```
56
+
57
+ </details>
58
+
59
+ <details>
60
+ <summary>CSpell Settings <code>cspell.config.yaml</code></summary>
61
+
62
+ **`cspell.config.yaml`**
63
+
64
+ ```yaml
65
+ import:
66
+ - '@cspell/dict-en-gb-legacy/cspell-ext.json'
67
+ language: en-GB
68
+ ```
69
+
70
+ </details>
71
+
72
+ ## Local Installation using CDN
73
+
74
+ ## CDN Configuration
75
+
76
+ <details>
77
+ <summary>VSCode Settings</summary>
78
+
79
+ Add the following to your VSCode settings:
80
+
81
+ **`.vscode/settings.json`**
82
+
83
+ ```jsonc
84
+ {
85
+ "cSpell.import": ["https://cdn.jsdelivr.net/npm/@cspell/dict-en-gb-legacy@latest/cspell-ext.json/cspell-ext.json"],
86
+ "cSpell.language": "en-GB",
87
+ }
21
88
  ```
22
89
 
23
- ## Manual Installation
90
+ </details>
91
+
92
+ <details>
93
+ <summary>CSpell Settings <code>cspell.json</code></summary>
24
94
 
25
- The `cspell-ext.json` file in this package should be added to the import section in your cspell.json file.
95
+ **`cspell.json`**
26
96
 
27
- ```javascript
97
+ ```jsonc
28
98
  {
29
- // …
30
- "import": ["@cspell/dict-en-gb/cspell-ext.json"],
31
- // …
99
+ "import": ["https://cdn.jsdelivr.net/npm/@cspell/dict-en-gb-legacy@latest/cspell-ext.json/cspell-ext.json"],
100
+ "language": "en-GB",
32
101
  }
33
102
  ```
34
103
 
104
+ </details>
105
+
106
+ <details>
107
+ <summary>CSpell Settings <code>cspell.config.yaml</code></summary>
108
+
109
+ **`cspell.config.yaml`**
110
+
111
+ ```yaml
112
+ import:
113
+ - https://cdn.jsdelivr.net/npm/@cspell/dict-en-gb-legacy@latest/cspell-ext.json/cspell-ext.json
114
+ language: en-GB
115
+ ```
116
+
117
+ </details>
118
+
119
+ ## Dictionary Information
120
+
121
+ | Name | Enabled | Description |
122
+ | -------------- | ------- | --------------------------------- |
123
+ | `en-gb-legacy` | | Legacy British English Dictionary |
124
+
125
+ ## Language Settings
126
+
127
+ | Name | Locale | File Type |
128
+ | -------------- | ------- | --------- |
129
+ | `en-gb-legacy` | `en-GB` | `*` |
130
+
131
+ <!--- @@inject-end: ./static/install.md --->
132
+
133
+ <!--- @@inject: ../../static/contributing.md --->
134
+
135
+ ## Contributing
136
+
137
+ Please help correct any mistakes in the dictionaries.
138
+
139
+ See: [Contributing](https://github.com/streetsidesoftware/cspell-dicts#contributing)
140
+
141
+ Special thanks to all of our amazing contributors!
142
+
143
+ ### Dictionary Development
144
+
145
+ See: [How to Create a New Dictionary](https://github.com/streetsidesoftware/cspell-dicts#how-to-create-a-new-dictionary)
146
+
147
+ <!--- @@inject-end: ../../static/contributing.md --->
148
+
35
149
  ## License
36
150
 
37
151
  MIT
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@cspell/dict-en-gb-legacy",
3
- "version": "1.0.8",
3
+ "version": "1.0.10",
4
4
  "description": "British English Legacy dictionary for cspell.",
5
5
  "publishConfig": {
6
6
  "access": "public",
@@ -48,5 +48,5 @@
48
48
  "@cspell/aoo-mozilla-en-dict": "workspace:^",
49
49
  "@cspell/dict-en-shared": "workspace:^"
50
50
  },
51
- "gitHead": "df1af07eae74df2d7cbf3eba25a433a1553aa497"
51
+ "gitHead": "0f12a733b776d13a9dc46c431b587cfadad460b3"
52
52
  }