@cspell/dict-cspell-bundle 2.0.14 → 2.0.16

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 +115 -6
  2. package/package.json +57 -57
package/README.md CHANGED
@@ -4,24 +4,133 @@ Dictionaries included with the CSpell Command Line tool.
4
4
 
5
5
  This is a pre-built dictionary for use with CSpell.
6
6
 
7
- ## Manual Installation
7
+ <!--- @@inject: ../../static/requirements.md --->
8
8
 
9
- Manual installation is useful if you want to include this dictionary as part of your CI/CD lint process.
9
+ ## Requirements
10
+
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` |
15
+
16
+ <!--- @@inject-end: ../../static/requirements.md --->
17
+
18
+ <!--- @@inject: ./static/install.md --->
19
+
20
+ ## Local Installation
10
21
 
11
22
  ```sh
12
- npm i -D @cspell/dict-cspell-bundle
23
+ npm install -D @cspell/dict-cspell-bundle
13
24
  ```
14
25
 
15
- The `cspell-ext.json` file in this package should be added to the import section in your `cspell.json` file.
26
+ ## Configuration
27
+
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-cspell-bundle/cspell-ext.json"],
38
+ "cSpell.dictionaries": [],
39
+ }
40
+ ```
41
+
42
+ </details>
43
+
44
+ <details>
45
+ <summary>CSpell Settings `cspell.json`</summary>
46
+
47
+ **`cspell.json`**
16
48
 
17
49
  ```jsonc
18
50
  {
19
- // …
20
51
  "import": ["@cspell/dict-cspell-bundle/cspell-ext.json"],
21
- // …
52
+ "dictionaries": [],
22
53
  }
23
54
  ```
24
55
 
56
+ </details>
57
+
58
+ <details>
59
+ <summary>CSpell Settings `cspell.config.yaml`</summary>
60
+
61
+ **`cspell.config.yaml`**
62
+
63
+ ```yaml
64
+ import:
65
+ - '@cspell/dict-cspell-bundle/cspell-ext.json'
66
+ dictionaries: []
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-cspell-bundle@latest/cspell-ext.json/cspell-ext.json"],
83
+ "cSpell.dictionaries": [],
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-cspell-bundle@latest/cspell-ext.json/cspell-ext.json"],
97
+ "dictionaries": [],
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-cspell-bundle@latest/cspell-ext.json/cspell-ext.json
111
+ dictionaries: []
112
+ ```
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
+
25
134
  ## License
26
135
 
27
136
  MIT
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@cspell/dict-cspell-bundle",
3
- "version": "2.0.14",
3
+ "version": "2.0.16",
4
4
  "description": "Dictionaries included with the CSpell Command Line tool.",
5
5
  "private": false,
6
6
  "publishConfig": {
@@ -38,66 +38,66 @@
38
38
  },
39
39
  "homepage": "https://github.com/streetsidesoftware/cspell-dicts/blob/main/dictionaries/cspell#readme",
40
40
  "dependencies": {
41
- "@cspell/dict-ada": "^4.1.0",
42
- "@cspell/dict-al": "^1.1.0",
43
- "@cspell/dict-aws": "^4.0.11",
44
- "@cspell/dict-bash": "^4.2.0",
45
- "@cspell/dict-companies": "^3.2.1",
46
- "@cspell/dict-cpp": "^6.0.8",
47
- "@cspell/dict-cryptocurrencies": "^5.0.4",
48
- "@cspell/dict-csharp": "^4.0.6",
49
- "@cspell/dict-css": "^4.0.17",
50
- "@cspell/dict-dart": "^2.3.0",
51
- "@cspell/dict-django": "^4.1.4",
52
- "@cspell/dict-docker": "^1.1.14",
53
- "@cspell/dict-dotnet": "^5.0.9",
54
- "@cspell/dict-elixir": "^4.0.7",
55
- "@cspell/dict-en-common-misspellings": "^2.1.2",
56
- "@cspell/dict-en-gb-mit": "^3.1.3",
57
- "@cspell/dict-en_us": "^4.4.13",
58
- "@cspell/dict-filetypes": "^3.0.12",
59
- "@cspell/dict-flutter": "^1.1.0",
60
- "@cspell/dict-fonts": "^4.0.4",
61
- "@cspell/dict-fsharp": "^1.1.0",
62
- "@cspell/dict-fullstack": "^3.2.6",
63
- "@cspell/dict-gaming-terms": "^1.1.1",
64
- "@cspell/dict-git": "^3.0.6",
65
- "@cspell/dict-golang": "^6.0.22",
66
- "@cspell/dict-google": "^1.0.8",
67
- "@cspell/dict-haskell": "^4.0.5",
68
- "@cspell/dict-html": "^4.0.11",
69
- "@cspell/dict-html-symbol-entities": "^4.0.3",
70
- "@cspell/dict-java": "^5.0.11",
71
- "@cspell/dict-julia": "^1.1.0",
72
- "@cspell/dict-k8s": "^1.0.11",
73
- "@cspell/dict-latex": "^4.0.3",
74
- "@cspell/dict-lorem-ipsum": "^4.0.4",
75
- "@cspell/dict-lua": "^4.0.7",
76
- "@cspell/dict-makefile": "^1.0.4",
77
- "@cspell/dict-markdown": "^2.0.11",
78
- "@cspell/dict-monkeyc": "^1.0.10",
79
- "@cspell/dict-node": "^5.0.7",
80
- "@cspell/dict-npm": "^5.2.10",
81
- "@cspell/dict-php": "^4.0.14",
82
- "@cspell/dict-powershell": "^5.0.14",
83
- "@cspell/dict-public-licenses": "^2.0.13",
84
- "@cspell/dict-python": "^4.2.18",
85
- "@cspell/dict-r": "^2.1.0",
86
- "@cspell/dict-ruby": "^5.0.8",
87
- "@cspell/dict-rust": "^4.0.11",
88
- "@cspell/dict-scala": "^5.0.7",
89
- "@cspell/dict-software-terms": "^5.1.2",
90
- "@cspell/dict-sql": "^2.2.0",
91
- "@cspell/dict-svelte": "^1.0.6",
92
- "@cspell/dict-swift": "^2.0.5",
93
- "@cspell/dict-terraform": "^1.1.2",
94
- "@cspell/dict-typescript": "^3.2.2",
95
- "@cspell/dict-vue": "^3.0.4"
41
+ "@cspell/dict-ada": "^4.1.1",
42
+ "@cspell/dict-al": "^1.1.1",
43
+ "@cspell/dict-aws": "^4.0.12",
44
+ "@cspell/dict-bash": "^4.2.1",
45
+ "@cspell/dict-companies": "^3.2.2",
46
+ "@cspell/dict-cpp": "^6.0.9",
47
+ "@cspell/dict-cryptocurrencies": "^5.0.5",
48
+ "@cspell/dict-csharp": "^4.0.7",
49
+ "@cspell/dict-css": "^4.0.18",
50
+ "@cspell/dict-dart": "^2.3.1",
51
+ "@cspell/dict-django": "^4.1.5",
52
+ "@cspell/dict-docker": "^1.1.15",
53
+ "@cspell/dict-dotnet": "^5.0.10",
54
+ "@cspell/dict-elixir": "^4.0.8",
55
+ "@cspell/dict-en-common-misspellings": "^2.1.3",
56
+ "@cspell/dict-en-gb-mit": "^3.1.4",
57
+ "@cspell/dict-en_us": "^4.4.14",
58
+ "@cspell/dict-filetypes": "^3.0.13",
59
+ "@cspell/dict-flutter": "^1.1.1",
60
+ "@cspell/dict-fonts": "^4.0.5",
61
+ "@cspell/dict-fsharp": "^1.1.1",
62
+ "@cspell/dict-fullstack": "^3.2.7",
63
+ "@cspell/dict-gaming-terms": "^1.1.2",
64
+ "@cspell/dict-git": "^3.0.7",
65
+ "@cspell/dict-golang": "^6.0.23",
66
+ "@cspell/dict-google": "^1.0.9",
67
+ "@cspell/dict-haskell": "^4.0.6",
68
+ "@cspell/dict-html": "^4.0.12",
69
+ "@cspell/dict-html-symbol-entities": "^4.0.4",
70
+ "@cspell/dict-java": "^5.0.12",
71
+ "@cspell/dict-julia": "^1.1.1",
72
+ "@cspell/dict-k8s": "^1.0.12",
73
+ "@cspell/dict-latex": "^4.0.4",
74
+ "@cspell/dict-lorem-ipsum": "^4.0.5",
75
+ "@cspell/dict-lua": "^4.0.8",
76
+ "@cspell/dict-makefile": "^1.0.5",
77
+ "@cspell/dict-markdown": "^2.0.12",
78
+ "@cspell/dict-monkeyc": "^1.0.11",
79
+ "@cspell/dict-node": "^5.0.8",
80
+ "@cspell/dict-npm": "^5.2.11",
81
+ "@cspell/dict-php": "^4.0.15",
82
+ "@cspell/dict-powershell": "^5.0.15",
83
+ "@cspell/dict-public-licenses": "^2.0.14",
84
+ "@cspell/dict-python": "^4.2.19",
85
+ "@cspell/dict-r": "^2.1.1",
86
+ "@cspell/dict-ruby": "^5.0.9",
87
+ "@cspell/dict-rust": "^4.0.12",
88
+ "@cspell/dict-scala": "^5.0.8",
89
+ "@cspell/dict-software-terms": "^5.1.4",
90
+ "@cspell/dict-sql": "^2.2.1",
91
+ "@cspell/dict-svelte": "^1.0.7",
92
+ "@cspell/dict-swift": "^2.0.6",
93
+ "@cspell/dict-terraform": "^1.1.3",
94
+ "@cspell/dict-typescript": "^3.2.3",
95
+ "@cspell/dict-vue": "^3.0.5"
96
96
  },
97
97
  "files": [
98
98
  "cspell-ext.json",
99
99
  "*.js",
100
100
  "*.d.ts"
101
101
  ],
102
- "gitHead": "d3226096849971f100407a42580f072be22709b9"
102
+ "gitHead": "30c5c53b8e28152fc1d8a6cf0c872b068a64221a"
103
103
  }