@cspell/dict-npm 5.2.10 → 5.2.11

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/README.md +74 -18
  2. package/dict/npm.txt +3 -0
  3. package/package.json +2 -2
package/README.md CHANGED
@@ -4,44 +4,86 @@ This dictionary contains a list of popular JavaScript packages found on [npmjs.c
4
4
 
5
5
  This is a pre-built dictionary for use with CSpell.
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` |
13
15
 
14
- ## Installation
16
+ <!--- @@inject-end: ../../static/requirements.md --->
15
17
 
16
- Global Install and add to CSpell global settings.
18
+ <!--- @@inject: ./static/install.md --->
17
19
 
18
- ```sh
19
- npm install -g @cspell/dict-npm
20
- cspell link add @cspell/dict-npm
21
- ```
20
+ ## Local Installation
21
+
22
+ **This package is bundled with CSpell.**
23
+
24
+ ## Configuration
22
25
 
23
- ## Uninstall from CSpell
26
+ <details>
27
+ <summary>VSCode Settings</summary>
24
28
 
25
- ```sh
26
- cspell link remove @cspell/dict-npm
29
+ Add the following to your VSCode settings:
30
+
31
+ **`.vscode/settings.json`**
32
+
33
+ ```jsonc
34
+ {
35
+ "cSpell.dictionaries": ["npm"],
36
+ }
27
37
  ```
28
38
 
29
- ## Manual Installation
39
+ </details>
40
+
41
+ <details>
42
+ <summary>CSpell Settings `cspell.json`</summary>
30
43
 
31
- The `cspell-ext.json` file in this package should be added to the import section in your cspell.json file.
44
+ **`cspell.json`**
32
45
 
33
- ```javascript
46
+ ```jsonc
34
47
  {
35
- //
36
- "import": ["@cspell/dict-npm/cspell-ext.json"],
37
- // …
48
+ "dictionaries": ["npm"],
38
49
  }
39
50
  ```
40
51
 
41
- # 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
+ - npm
62
+ ```
63
+
64
+ </details>
65
+
66
+ > [!NOTE]
67
+ > **This package is bundled with CSpell.**
68
+
69
+ <!--- @@inject-end: ./static/install.md --->
70
+
71
+ <!--- @@inject: ../../static/contributing.md --->
72
+
73
+ ## Contributing
74
+
75
+ Please help correct any mistakes in the dictionaries.
76
+
77
+ See: [Contributing](https://github.com/streetsidesoftware/cspell-dicts#contributing)
78
+
79
+ Special thanks to all of our amazing contributors!
80
+
81
+ ### Dictionary Development
42
82
 
43
83
  See: [How to Create a New Dictionary](https://github.com/streetsidesoftware/cspell-dicts#how-to-create-a-new-dictionary)
44
84
 
85
+ <!--- @@inject-end: ../../static/contributing.md --->
86
+
45
87
  ## License
46
88
 
47
89
  MIT
@@ -51,3 +93,17 @@ MIT
51
93
  <!---
52
94
  cspell:ignore npmjs
53
95
  --->
96
+
97
+ <!--- @@inject: ../../static/footer.md --->
98
+
99
+ <br/>
100
+
101
+ ---
102
+
103
+ <p align="center">
104
+ Brought to you by <a href="https://streetsidesoftware.com" title="Street Side Software">
105
+ <img width="16" alt="Street Side Software Logo" src="https://i.imgur.com/CyduuVY.png" /> Street Side Software
106
+ </a>
107
+ </p>
108
+
109
+ <!--- @@inject-end: ../../static/footer.md --->
package/dict/npm.txt CHANGED
@@ -1127,6 +1127,7 @@ hastscript
1127
1127
  hay-against-any-hurry
1128
1128
  hbs
1129
1129
  he
1130
+ headlessui
1130
1131
  heapdump
1131
1132
  helmet
1132
1133
  helper-plugin-utils
@@ -2168,6 +2169,7 @@ remark-preset-github
2168
2169
  remark-preset-wooorm
2169
2170
  remark-rehype
2170
2171
  remarkable
2172
+ remeda
2171
2173
  renyii
2172
2174
  replace-ext
2173
2175
  replace-in-file
@@ -2639,6 +2641,7 @@ utils
2639
2641
  utils-merge
2640
2642
  uuid
2641
2643
  uvu
2644
+ valibot
2642
2645
  valid-url
2643
2646
  validate-commit-msg
2644
2647
  validate-npm-package-name
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@cspell/dict-npm",
3
- "version": "5.2.10",
3
+ "version": "5.2.11",
4
4
  "description": "Dictionary of common NPM packages for cspell.",
5
5
  "publishConfig": {
6
6
  "access": "public",
@@ -42,5 +42,5 @@
42
42
  "dict/npm.txt",
43
43
  "cspell-ext.json"
44
44
  ],
45
- "gitHead": "d3226096849971f100407a42580f072be22709b9"
45
+ "gitHead": "30c5c53b8e28152fc1d8a6cf0c872b068a64221a"
46
46
  }