@cspell/dict-data-science 2.0.8 → 2.0.9

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 +65 -20
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -4,43 +4,88 @@ Data Science dictionary for cspell.
4
4
 
5
5
  This is a pre-built dictionary for use with CSpell.
6
6
 
7
- ## Installation
7
+ <!--- @@inject: ../../static/requirements.md --->
8
8
 
9
- Global Install and add to CSpell global settings.
9
+ ## Requirements
10
10
 
11
- ```sh
12
- npm install -g @cspell/dict-data-science
13
- cspell link add @cspell/dict-data-science
14
- ```
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
15
 
16
- ## Uninstall from CSpell
16
+ <!--- @@inject-end: ../../static/requirements.md --->
17
17
 
18
- ```sh
19
- cspell link remove @cspell/dict-data-science
20
- ```
18
+ <!--- @@inject: ./static/install.md --->
21
19
 
22
- ## Manual Installation
20
+ ## Local Installation
23
21
 
24
- Manual installation is useful if you want to include this dictionary as part of your CI/CD lint process.
22
+ **This package is bundled with CSpell.**
25
23
 
24
+ ## Configuration
25
+
26
+ <details>
27
+ <summary>VSCode Settings</summary>
28
+
29
+ Add the following to your VSCode settings:
30
+
31
+ **`.vscode/settings.json`**
32
+
33
+ ```jsonc
34
+ {
35
+ "cSpell.dictionaries": ["data-science", "data-science-models", "data-science-tools"],
36
+ }
26
37
  ```
27
- npm i @cspell/dict-data-science
28
- ```
29
38
 
30
- The `cspell-ext.json` file in this package should be added to the import section in your `cspell.json` file.
39
+ </details>
40
+
41
+ <details>
42
+ <summary>CSpell Settings `cspell.json`</summary>
31
43
 
32
- ```javascript
44
+ **`cspell.json`**
45
+
46
+ ```jsonc
33
47
  {
34
- // …
35
- "import": ["@cspell/dict-data-science/cspell-ext.json"],
36
- // …
48
+ "dictionaries": ["data-science", "data-science-models", "data-science-tools"],
37
49
  }
38
50
  ```
39
51
 
40
- # Dictionary Development
52
+ </details>
53
+
54
+ <details>
55
+ <summary>CSpell Settings `cspell.config.yaml`</summary>
56
+
57
+ **`cspell.config.yaml`**
58
+
59
+ ```yaml
60
+ dictionaries:
61
+ - data-science
62
+ - data-science-models
63
+ - data-science-tools
64
+ ```
65
+
66
+ </details>
67
+
68
+ > [!NOTE]
69
+ > **This package is bundled with CSpell.**
70
+
71
+ <!--- @@inject-end: ./static/install.md --->
72
+
73
+ <!--- @@inject: ../../static/contributing.md --->
74
+
75
+ ## Contributing
76
+
77
+ Please help correct any mistakes in the dictionaries.
78
+
79
+ See: [Contributing](https://github.com/streetsidesoftware/cspell-dicts#contributing)
80
+
81
+ Special thanks to all of our amazing contributors!
82
+
83
+ ### Dictionary Development
41
84
 
42
85
  See: [How to Create a New Dictionary](https://github.com/streetsidesoftware/cspell-dicts#how-to-create-a-new-dictionary)
43
86
 
87
+ <!--- @@inject-end: ../../static/contributing.md --->
88
+
44
89
  ## License
45
90
 
46
91
  MIT
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@cspell/dict-data-science",
3
- "version": "2.0.8",
3
+ "version": "2.0.9",
4
4
  "description": "Data Science dictionary for cspell. -- Private until verified",
5
5
  "publishConfig": {
6
6
  "access": "public",
@@ -42,5 +42,5 @@
42
42
  "*.js",
43
43
  "*.d.ts"
44
44
  ],
45
- "gitHead": "d6e70b1626074b23b1b44de523a0d05c9024d50b"
45
+ "gitHead": "30c5c53b8e28152fc1d8a6cf0c872b068a64221a"
46
46
  }