@cspell/dict-scientific-terms-us 3.0.6 → 3.0.7

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 (3) hide show
  1. package/LICENSE +1 -1
  2. package/README.md +127 -17
  3. package/package.json +2 -2
package/LICENSE CHANGED
@@ -1,6 +1,6 @@
1
1
  The MIT License (MIT)
2
2
 
3
- Copyright (c) 2017-2020 Jason Dent <jason@streetsidesoftware.nl>
3
+ Copyright (c) 2017-2025 Street Side Software <support@streetsidesoftware.nl>
4
4
 
5
5
  Permission is hereby granted, free of charge, to any person obtaining a copy
6
6
  of this software and associated documentation files (the "Software"), to deal
package/README.md CHANGED
@@ -6,41 +6,137 @@ The words for this dictionary came from [John Petrie’s LifeBlag](http://www.jp
6
6
 
7
7
  This is a pre-built dictionary for use with cspell.
8
8
 
9
- ## Installation
9
+ <!--- @@inject: ../../static/requirements.md --->
10
10
 
11
- Global Install and add to cspell global settings.
11
+ ## Requirements
12
+
13
+ | Tool | Version |
14
+ | ------------------------------------------------------------------------------------------------------------------------------------ | ------- |
15
+ | [cspell](https://github.com/streetsidesoftware/cspell) | `>= 8` |
16
+ | [Code Spell Checker - Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker) | `>= 4` |
17
+
18
+ <!--- @@inject-end: ../../static/requirements.md --->
19
+
20
+ <!--- @@inject: ./static/install.md --->
21
+
22
+ ## Local Installation
12
23
 
13
24
  ```sh
14
- npm install -g @cspell/dict-scientific-terms-us
15
- cspell link add @cspell/dict-scientific-terms-us
25
+ npm install -D @cspell/dict-scientific-terms-us
16
26
  ```
17
27
 
18
- ## Uninstall from cspell
28
+ ## Configuration
19
29
 
20
- ```sh
21
- cspell link remove @cspell/dict-scientific-terms-us
30
+ <details>
31
+ <summary>VSCode Settings</summary>
32
+
33
+ Add the following to your VSCode settings:
34
+
35
+ **`.vscode/settings.json`**
36
+
37
+ ```jsonc
38
+ {
39
+ "cSpell.import": ["@cspell/dict-scientific-terms-us/cspell-ext.json"],
40
+ "cSpell.dictionaries": ["scientific-terms-us"],
41
+ }
22
42
  ```
23
43
 
24
- ## Manual Installation
44
+ </details>
25
45
 
26
- The `cspell-ext.json` file in this package should be added to the import section in your cspell.json file.
46
+ <details>
47
+ <summary>CSpell Settings `cspell.json`</summary>
27
48
 
28
- ```javascript
49
+ **`cspell.json`**
50
+
51
+ ```jsonc
29
52
  {
30
- // …
31
- "import": ["@cspell/dict-scientific-terms-us/cspell-ext.json"],
32
- // …
53
+ "import": ["@cspell/dict-scientific-terms-us/cspell-ext.json"],
54
+ "dictionaries": ["scientific-terms-us"],
33
55
  }
34
56
  ```
35
57
 
36
- ## Building
58
+ </details>
37
59
 
38
- Building is only necessary if you want to modify the contents of the dictionary. Note: Building will take a few minutes for large files.
60
+ <details>
61
+ <summary>CSpell Settings `cspell.config.yaml`</summary>
39
62
 
40
- ```sh
41
- npm run build
63
+ **`cspell.config.yaml`**
64
+
65
+ ```yaml
66
+ import:
67
+ - '@cspell/dict-scientific-terms-us/cspell-ext.json'
68
+ dictionaries:
69
+ - scientific-terms-us
42
70
  ```
43
71
 
72
+ </details>
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": [
86
+ "https://cdn.jsdelivr.net/npm/@cspell/dict-scientific-terms-us@latest/cspell-ext.json/cspell-ext.json",
87
+ ],
88
+ "cSpell.dictionaries": ["scientific-terms-us"],
89
+ }
90
+ ```
91
+
92
+ </details>
93
+
94
+ <details>
95
+ <summary>CSpell Settings `cspell.json`</summary>
96
+
97
+ **`cspell.json`**
98
+
99
+ ```jsonc
100
+ {
101
+ "import": ["https://cdn.jsdelivr.net/npm/@cspell/dict-scientific-terms-us@latest/cspell-ext.json/cspell-ext.json"],
102
+ "dictionaries": ["scientific-terms-us"],
103
+ }
104
+ ```
105
+
106
+ </details>
107
+
108
+ <details>
109
+ <summary>CSpell Settings `cspell.config.yaml`</summary>
110
+
111
+ **`cspell.config.yaml`**
112
+
113
+ ```yaml
114
+ import:
115
+ - https://cdn.jsdelivr.net/npm/@cspell/dict-scientific-terms-us@latest/cspell-ext.json/cspell-ext.json
116
+ dictionaries:
117
+ - scientific-terms-us
118
+ ```
119
+
120
+ </details>
121
+
122
+ <!--- @@inject-end: ./static/install.md --->
123
+
124
+ <!--- @@inject: ../../static/contributing.md --->
125
+
126
+ ## Contributing
127
+
128
+ Please help correct any mistakes in the dictionaries.
129
+
130
+ See: [Contributing](https://github.com/streetsidesoftware/cspell-dicts#contributing)
131
+
132
+ Special thanks to all of our amazing contributors!
133
+
134
+ ### Dictionary Development
135
+
136
+ See: [How to Create a New Dictionary](https://github.com/streetsidesoftware/cspell-dicts#how-to-create-a-new-dictionary)
137
+
138
+ <!--- @@inject-end: ../../static/contributing.md --->
139
+
44
140
  ## License
45
141
 
46
142
  MIT
@@ -48,3 +144,17 @@ MIT
48
144
  > Some packages may have other licenses included.
49
145
 
50
146
  <!--- cspell:ignore Petrie’s --->
147
+
148
+ <!--- @@inject: ../../static/footer.md --->
149
+
150
+ <br/>
151
+
152
+ ---
153
+
154
+ <p align="center">
155
+ Brought to you by <a href="https://streetsidesoftware.com" title="Street Side Software">
156
+ <img width="16" alt="Street Side Software Logo" src="https://i.imgur.com/CyduuVY.png" /> Street Side Software
157
+ </a>
158
+ </p>
159
+
160
+ <!--- @@inject-end: ../../static/footer.md --->
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@cspell/dict-scientific-terms-us",
3
- "version": "3.0.6",
3
+ "version": "3.0.7",
4
4
  "description": "Scientific Terms US dictionary for cspell.",
5
5
  "publishConfig": {
6
6
  "access": "public",
@@ -41,5 +41,5 @@
41
41
  "custom_scientific_US.trie.gz",
42
42
  "cspell-ext.json"
43
43
  ],
44
- "gitHead": "588365f8c00b710c7d9eb46db5477f6db48a920d"
44
+ "gitHead": "30c5c53b8e28152fc1d8a6cf0c872b068a64221a"
45
45
  }