Skip to content

Commit 26ccf41

Browse files
authored
ci: add Mnemonics dictionary (streetsidesoftware#306)
* ci: add Mnemonics dictionary * Update cspell-ext.json
1 parent abe4fe1 commit 26ccf41

File tree

7 files changed

+1041
-0
lines changed

7 files changed

+1041
-0
lines changed

dictionaries/mnemonics/CHANGELOG.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Change Log
2+
3+
## 1.0.0
4+
5+
- Initial Release

dictionaries/mnemonics/LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
The MIT License (MIT)
2+
3+
Copyright (c) 2017-2020 Jason Dent <[email protected]>
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in
13+
all copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21+
THE SOFTWARE.

dictionaries/mnemonics/README.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
# Cspell Mnemonics Dictionary
2+
3+
i86 Mnemonics dictionary for cspell
4+
5+
This is a pre-built dictionary for use with cspell.
6+
7+
## Installation
8+
9+
Global Install and add to cspell global settings.
10+
11+
```sh
12+
npm install -g @cspell/dict-mnemonics
13+
cspell link add @cspell/dict-mnemonics
14+
```
15+
16+
## Uninstall from cspell
17+
18+
```sh
19+
cspell link remove @cspell/dict-mnemonics
20+
```
21+
22+
## Manual Installation
23+
24+
Manual installation is useful if you want to include this dictionary as part of your CI/CD lint process.
25+
26+
```
27+
npm i @cspell/dict-mnemonics
28+
```
29+
30+
The `cspell-ext.json` file in this package should be added to the import section in your `cspell.json` file.
31+
32+
```javascript
33+
{
34+
//
35+
"import": ["@cspell/dict-mnemonics/cspell-ext.json"],
36+
//
37+
}
38+
```
39+
40+
# Dictionary Development
41+
42+
See: [How to Create a New Dictionary](https://github.com/streetsidesoftware/cspell-dicts#how-to-create-a-new-dictionary)
43+
44+
## License
45+
46+
MIT
47+
48+
> Some packages may have other licenses included.
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
{
2+
"id": "mnemonics",
3+
"name": "Mnemonics",
4+
"description": "i86 Mnemonics dictionary for cspell",
5+
"dictionaryDefinitions": [
6+
{
7+
"name": "mnemonics",
8+
"file": "./mnemonics.txt.gz",
9+
"description": "i86 Mnemonics dictionary for cspell"
10+
}
11+
],
12+
"languageSettings": [
13+
{
14+
"languageId": "c,cpp,h,hpp",
15+
"dictionaries": ["mnemonics"]
16+
}
17+
]
18+
}
2.26 KB
Binary file not shown.

dictionaries/mnemonics/package.json

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
{
2+
"name": "@cspell/dict-mnemonics",
3+
"version": "1.0.0",
4+
"description": "i86 Mnemonics dictionary for cspell",
5+
"exports": {
6+
".": "./cspell-ext.json",
7+
"./cspell": "./cspell-ext.json",
8+
"./cspell-ext.json": "./cspell-ext.json"
9+
},
10+
"scripts": {
11+
"build": "cross-env NODE_OPTIONS=--max_old_space_size=8192 cspell-tools compile \"src/mnemonics.txt\" -o .",
12+
"test": "head -n 1000 \"src/mnemonics.txt\" | cspell -v -c ./cspell-ext.json \"--local=*\" \"--languageId=cpp\" stdin",
13+
"prepublishOnly": "yarn test",
14+
"prepare": "yarn run build"
15+
},
16+
"repository": {
17+
"type": "git",
18+
"url": "git+https://github.com/streetsidesoftware/cspell-dicts.git"
19+
},
20+
"keywords": [
21+
"cspell",
22+
"mnemonics",
23+
"Mnemonics",
24+
"dictionary",
25+
"spelling"
26+
],
27+
"author": "Jason Dent",
28+
"license": "MIT",
29+
"bugs": {
30+
"url": "https://github.com/streetsidesoftware/cspell-dicts/issues"
31+
},
32+
"homepage": "https://github.com/streetsidesoftware/cspell-dicts/blob/master/packages/mnemonics#readme",
33+
"devDependencies": {},
34+
"dependencies": {},
35+
"files": [
36+
"mnemonics.txt.gz",
37+
"cspell-ext.json",
38+
"*.js",
39+
"*.d.ts"
40+
]
41+
}

0 commit comments

Comments
 (0)