@cspell/dict-rust 4.0.11 → 4.1.0

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 (7) hide show
  1. package/LICENSE +1 -1
  2. package/README.md +92 -22
  3. package/cspell-ext.json +7 -25
  4. package/dict/crates.txt.gz +0 -0
  5. package/dict/rust.txt.gz +0 -0
  6. package/package.json +6 -5
  7. package/dict/rust.txt +0 -128
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,102 @@ 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", "rust-crates"],
36
+ }
27
37
  ```
28
38
 
29
- ## Manual Installation
39
+ </details>
30
40
 
31
- The `cspell-ext.json` file in this package should be added to the import section in your cspell.json file.
41
+ <details>
42
+ <summary>CSpell Settings <code>cspell.json</code></summary>
32
43
 
33
- ```javascript
44
+ **`cspell.json`**
45
+
46
+ ```jsonc
34
47
  {
35
- // …
36
- "import": ["@cspell/dict-rust/cspell-ext.json"],
37
- // …
48
+ "dictionaries": ["rust", "rust-crates"],
38
49
  }
39
50
  ```
40
51
 
41
- ## Building
52
+ </details>
53
+
54
+ <details>
55
+ <summary>CSpell Settings <code>cspell.config.yaml</code></summary>
42
56
 
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.
57
+ **`cspell.config.yaml`**
44
58
 
45
- ```sh
46
- npm run build
59
+ ```yaml
60
+ dictionaries:
61
+ - rust
62
+ - rust-crates
47
63
  ```
48
64
 
65
+ </details>
66
+
67
+ ## Local Installation using CDN
68
+
69
+ > **NOTE:** This package is bundled with CSpell.
70
+
71
+ ## Dictionary Information
72
+
73
+ | Name | Enabled | Description |
74
+ | ------------- | ------- | ----------------------------- |
75
+ | `rust` | | Rust Keyword Dictionary |
76
+ | `rust-crates` | | Common Rust Crates Dictionary |
77
+
78
+ ## Language Settings
79
+
80
+ | Name | Locale | File Type |
81
+ | ------------- | ------ | --------- |
82
+ | `rust` | `*` | `rust` |
83
+ | `rust-crates` | `*` | `rust` |
84
+
85
+ <!--- @@inject-end: ./static/install.md --->
86
+
87
+ <!--- @@inject: ../../static/contributing.md --->
88
+
89
+ ## Contributing
90
+
91
+ Please help correct any mistakes in the dictionaries.
92
+
93
+ See: [Contributing](https://github.com/streetsidesoftware/cspell-dicts#contributing)
94
+
95
+ Special thanks to all of our amazing contributors!
96
+
97
+ ### Dictionary Development
98
+
99
+ See: [How to Create a New Dictionary](https://github.com/streetsidesoftware/cspell-dicts#how-to-create-a-new-dictionary)
100
+
101
+ <!--- @@inject-end: ../../static/contributing.md --->
102
+
49
103
  ## License
50
104
 
51
105
  MIT
@@ -54,4 +108,20 @@ MIT
54
108
 
55
109
  Keywords are taken from the repository
56
110
 
57
- [https://github.com/rust-lang/gedit-config](https://github.com/rust-lang/gedit-config)
111
+ [rust-lang/gedit-config](https://github.com/rust-lang/gedit-config)
112
+
113
+ <!--- cspell:ignore gedit-config --->
114
+
115
+ <!--- @@inject: ../../static/footer.md --->
116
+
117
+ <br/>
118
+
119
+ ---
120
+
121
+ <p align="center">
122
+ Brought to you by <a href="https://streetsidesoftware.com" title="Street Side Software">
123
+ <img width="16" alt="Street Side Software Logo" src="https://i.imgur.com/CyduuVY.png" /> Street Side Software
124
+ </a>
125
+ </p>
126
+
127
+ <!--- @@inject-end: ../../static/footer.md --->
package/cspell-ext.json CHANGED
@@ -1,43 +1,25 @@
1
- // cSpell Settings
2
1
  {
3
2
  "id": "rust",
4
3
  "name": "Rust",
5
4
  "description": "Rust Keyword Dictionary",
6
5
  "readonly": true,
7
- // List of dictionary files to add to the global list of dictionaries
8
6
  "dictionaryDefinitions": [
9
7
  {
10
8
  "name": "rust",
11
- "path": "./dict/rust.txt",
9
+ "path": "./dict/rust.txt.gz",
12
10
  "description": "Rust Keyword Dictionary"
11
+ },
12
+ {
13
+ "name": "rust-crates",
14
+ "path": "./dict/crates.txt.gz",
15
+ "description": "Common Rust Crates Dictionary"
13
16
  }
14
17
  ],
15
- // Dictionaries to always be used.
16
- // Generally left empty
17
- "dictionaries": [],
18
- // Language Rules to apply to matching files.
19
- // Files are matched on `languageId` and `locale`
20
18
  "languageSettings": [
21
19
  {
22
- // VSCode languageId. i.e. typescript, java, go, cpp, javascript, markdown, latex
23
- // * will match against any file type.
24
20
  "languageId": "rust",
25
- // Language locale. i.e. en-US, de-AT, or ru. * will match all locals.
26
- // Multiple locals can be specified like: "en, en-US" to match both English and English US.
27
21
  "locale": "*",
28
- // By default the whole text of a file is included for spell checking
29
- // Adding patterns to the "includeRegExpList" to only include matching patterns
30
- "includeRegExpList": [],
31
- // To exclude patterns, add them to "ignoreRegExpList"
32
- "ignoreRegExpList": [],
33
- // regex patterns than can be used with ignoreRegExpList or includeRegExpList
34
- // Example: "pattern": [{ "name": "mdash", "pattern": "&mdash;" }]
35
- // This could be included in "ignoreRegExpList": ["mdash"]
36
- "patterns": [],
37
- // List of dictionaries to enable by name in `dictionaryDefinitions`
38
- "dictionaries": ["rust"],
39
- // Dictionary definitions can also be supplied here. They are only used iff "languageId" and "locale" match.
40
- "dictionaryDefinitions": []
22
+ "dictionaries": ["rust", "rust-crates"]
41
23
  }
42
24
  ]
43
25
  }
package/dict/crates.txt.gz ADDED
Binary file
package/dict/rust.txt.gz ADDED
Binary file
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@cspell/dict-rust",
3
- "version": "4.0.11",
3
+ "version": "4.1.0",
4
4
  "description": "Rust dictionary for cspell.",
5
5
  "publishConfig": {
6
6
  "access": "public",
@@ -12,8 +12,8 @@
12
12
  "./cspell-ext.json": "./cspell-ext.json"
13
13
  },
14
14
  "scripts": {
15
- "build": "cspell-tools-cli compile --keep-raw-case src/rust.txt --no-compress -o ./dict",
16
- "test": "shx head -n 1000 src/rust.txt | cspell -c ./cspell-ext.json --locale=* --languageId=rust stdin",
15
+ "build": "cspell-tools-cli build",
16
+ "test": "cspell samples",
17
17
  "prepublishOnly": "echo pre-publish",
18
18
  "prepare:dictionary": "pnpm run build"
19
19
  },
@@ -39,8 +39,9 @@
39
39
  },
40
40
  "homepage": "https://github.com/streetsidesoftware/cspell-dicts/blob/main/dictionaries/rust#readme",
41
41
  "files": [
42
- "dict/rust.txt",
42
+ "dict/rust.txt.gz",
43
+ "dict/crates.txt.gz",
43
44
  "cspell-ext.json"
44
45
  ],
45
- "gitHead": "588365f8c00b710c7d9eb46db5477f6db48a920d"
46
+ "gitHead": "cb65800c6de2a5b0f05996cf68aab96fc71f45fa"
46
47
  }
package/dict/rust.txt DELETED
@@ -1,128 +0,0 @@
1
-
2
- # cspell-tools: keep-case no-split
3
-
4
- Add
5
- Arc
6
- BitAnd
7
- BitOr
8
- BitXor
9
- Deref
10
- DerefMut
11
- Div
12
- Err
13
- Fn
14
- FnMut
15
- FnOnce
16
- Mul
17
- Neg
18
- None
19
- Not
20
- PartialEq
21
- PartialOrd
22
- RefCell
23
- Rem
24
- Rustacean
25
- Self
26
- Shl
27
- Shr
28
- Some
29
- Sub
30
- abstract
31
- alignof
32
- alloc
33
- as
34
- assert
35
- assert_eq
36
- become
37
- bindgen
38
- bool
39
- box
40
- break
41
- char
42
- clippy
43
- cmp
44
- const
45
- continue
46
- crate
47
- deallocate
48
- dedup
49
- deserialize
50
- do
51
- drain
52
- else
53
- enum
54
- eprint
55
- eprintln
56
- extern
57
- f32
58
- f64
59
- final
60
- fold
61
- for
62
- format_args
63
- i16
64
- i32
65
- i64
66
- i8
67
- if
68
- impl
69
- in
70
- include_str
71
- isize
72
- iter
73
- let
74
- loop
75
- macro
76
- map
77
- match
78
- millis
79
- mod
80
- move
81
- mpsc
82
- msrv
83
- mut
84
- mutex
85
- offsetof
86
- option_env
87
- override
88
- panic
89
- powf
90
- powi
91
- println
92
- priv
93
- proc
94
- pub
95
- pure
96
- ref
97
- return
98
- rustdoc
99
- rustfmt
100
- rustup
101
- self
102
- serde
103
- sizeof
104
- static
105
- str
106
- stringify
107
- struct
108
- super
109
- sync
110
- tokio
111
- toml
112
- toolchain
113
- trait
114
- typeof
115
- u8
116
- unoptimized
117
- unsafe
118
- unsized
119
- unwrap
120
- use
121
- usize
122
- virtual
123
- wasm
124
- where
125
- while
126
- writeln
127
- yield
128
- zip