@cspell/dict-rust 4.0.11 → 4.0.12

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 +76 -22
  3. package/package.json +2 -2
package/LICENSE CHANGED
@@ -1,7 +1,7 @@
1
1
  The MIT License (MIT)
2
2
 
3
3
  Copyright (c) 2017-2020 Alexander Andreev <andreevlex.as@gmail.com>
4
- Copyright (c) 2017-2020 Jason Dent <jason@streetsidesoftware.nl>
4
+ Copyright (c) 2017-2025 Street Side Software <support@streetsidesoftware.nl>
5
5
 
6
6
  Permission is hereby granted, free of charge, to any person obtaining a copy
7
7
  of this software and associated documentation files (the "Software"), to deal
package/README.md CHANGED
@@ -4,48 +4,86 @@ Rust dictionary for cspell.
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-rust
20
- cspell link add @cspell/dict-rust
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-rust
29
+ Add the following to your VSCode settings:
30
+
31
+ **`.vscode/settings.json`**
32
+
33
+ ```jsonc
34
+ {
35
+ "cSpell.dictionaries": ["rust"],
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-rust/cspell-ext.json"],
37
- // …
48
+ "dictionaries": ["rust"],
38
49
  }
39
50
  ```
40
51
 
41
- ## Building
52
+ </details>
42
53
 
43
- Building is only necessary if you want to modify the contents of the dictionary. Note: Building will take a few minutes for large files.
54
+ <details>
55
+ <summary>CSpell Settings `cspell.config.yaml`</summary>
44
56
 
45
- ```sh
46
- npm run build
57
+ **`cspell.config.yaml`**
58
+
59
+ ```yaml
60
+ dictionaries:
61
+ - rust
47
62
  ```
48
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
82
+
83
+ See: [How to Create a New Dictionary](https://github.com/streetsidesoftware/cspell-dicts#how-to-create-a-new-dictionary)
84
+
85
+ <!--- @@inject-end: ../../static/contributing.md --->
86
+
49
87
  ## License
50
88
 
51
89
  MIT
@@ -54,4 +92,20 @@ MIT
54
92
 
55
93
  Keywords are taken from the repository
56
94
 
57
- [https://github.com/rust-lang/gedit-config](https://github.com/rust-lang/gedit-config)
95
+ [rust-lang/gedit-config](https://github.com/rust-lang/gedit-config)
96
+
97
+ <!--- cspell:ignore gedit-config --->
98
+
99
+ <!--- @@inject: ../../static/footer.md --->
100
+
101
+ <br/>
102
+
103
+ ---
104
+
105
+ <p align="center">
106
+ Brought to you by <a href="https://streetsidesoftware.com" title="Street Side Software">
107
+ <img width="16" alt="Street Side Software Logo" src="https://i.imgur.com/CyduuVY.png" /> Street Side Software
108
+ </a>
109
+ </p>
110
+
111
+ <!--- @@inject-end: ../../static/footer.md --->
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@cspell/dict-rust",
3
- "version": "4.0.11",
3
+ "version": "4.0.12",
4
4
  "description": "Rust dictionary for cspell.",
5
5
  "publishConfig": {
6
6
  "access": "public",
@@ -42,5 +42,5 @@
42
42
  "dict/rust.txt",
43
43
  "cspell-ext.json"
44
44
  ],
45
- "gitHead": "588365f8c00b710c7d9eb46db5477f6db48a920d"
45
+ "gitHead": "30c5c53b8e28152fc1d8a6cf0c872b068a64221a"
46
46
  }