@cspell/dict-en-gb-ise 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 +122 -15
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -4,40 +4,147 @@ British English dictionary for cspell.
4
4
 
5
5
  Use this dictionary if you do not want the (-ize) spelling variants commonly used in US English.
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-gb-ise
20
- cspell link add @cspell/dict-en-gb-ise
23
+ npm install -D @cspell/dict-en-gb-ise
21
24
  ```
22
25
 
23
- ## Uninstall from cspell
26
+ ## Configuration
24
27
 
25
- ```sh
26
- cspell link remove @cspell/dict-en-gb-ise
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-gb-ise/cspell-ext.json"],
38
+ "cSpell.language": "en-GB",
39
+ }
40
+ ```
41
+
42
+ </details>
43
+
44
+ <details>
45
+ <summary>CSpell Settings <code>cspell.json</code></summary>
46
+
47
+ **`cspell.json`**
48
+
49
+ ```jsonc
50
+ {
51
+ "import": ["@cspell/dict-en-gb-ise/cspell-ext.json"],
52
+ "language": "en-GB",
53
+ }
54
+ ```
55
+
56
+ </details>
57
+
58
+ <details>
59
+ <summary>CSpell Settings <code>cspell.config.yaml</code></summary>
60
+
61
+ **`cspell.config.yaml`**
62
+
63
+ ```yaml
64
+ import:
65
+ - '@cspell/dict-en-gb-ise/cspell-ext.json'
66
+ language: en-GB
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-gb-ise@latest/cspell-ext.json/cspell-ext.json"],
85
+ "cSpell.language": "en-GB",
86
+ }
27
87
  ```
28
88
 
29
- ## Manual Installation
89
+ </details>
90
+
91
+ <details>
92
+ <summary>CSpell Settings <code>cspell.json</code></summary>
30
93
 
31
- The `cspell-ext.json` file in this package should be added to the import section in your cspell.json file.
94
+ **`cspell.json`**
32
95
 
33
- ```javascript
96
+ ```jsonc
34
97
  {
35
- // …
36
- "import": ["@cspell/dict-en-gb-ise/cspell-ext.json"],
37
- // …
98
+ "import": ["https://cdn.jsdelivr.net/npm/@cspell/dict-en-gb-ise@latest/cspell-ext.json/cspell-ext.json"],
99
+ "language": "en-GB",
38
100
  }
39
101
  ```
40
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-gb-ise@latest/cspell-ext.json/cspell-ext.json
113
+ language: en-GB
114
+ ```
115
+
116
+ </details>
117
+
118
+ ## Dictionary Information
119
+
120
+ | Name | Enabled | Description |
121
+ | ------- | ------- | -------------------------- |
122
+ | `en-gb` | | British English Dictionary |
123
+
124
+ ## Language Settings
125
+
126
+ | Name | Locale | File Type |
127
+ | ------- | ------- | --------- |
128
+ | `en-gb` | `en-GB` | `*` |
129
+
130
+ <!--- @@inject-end: ./static/install.md --->
131
+
132
+ <!--- @@inject: ../../static/contributing.md --->
133
+
134
+ ## Contributing
135
+
136
+ Please help correct any mistakes in the dictionaries.
137
+
138
+ See: [Contributing](https://github.com/streetsidesoftware/cspell-dicts#contributing)
139
+
140
+ Special thanks to all of our amazing contributors!
141
+
142
+ ### Dictionary Development
143
+
144
+ See: [How to Create a New Dictionary](https://github.com/streetsidesoftware/cspell-dicts#how-to-create-a-new-dictionary)
145
+
146
+ <!--- @@inject-end: ../../static/contributing.md --->
147
+
41
148
  ## Adding Words
42
149
 
43
150
  Contributions are welcomed and encouraged, please read [src/README.md](https://github.com/streetsidesoftware/cspell-dicts/blob/main/dictionaries/en_GB-ise/src/README.md).
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@cspell/dict-en-gb-ise",
3
- "version": "1.0.8",
3
+ "version": "1.0.10",
4
4
  "description": "British English (-ise) dictionary for cspell.",
5
5
  "publishConfig": {
6
6
  "access": "public",
@@ -49,5 +49,5 @@
49
49
  "@cspell/aoo-mozilla-en-dict": "workspace:^",
50
50
  "@cspell/dict-en-shared": "workspace:^"
51
51
  },
52
- "gitHead": "df1af07eae74df2d7cbf3eba25a433a1553aa497"
52
+ "gitHead": "0f12a733b776d13a9dc46c431b587cfadad460b3"
53
53
  }