@cspell/dict-mn-mn 1.1.1 → 1.2.1

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 +106 -16
  2. package/dict/mn-mn.trie.gz +0 -0
  3. package/package.json +8 -8
package/README.md CHANGED
@@ -4,43 +4,133 @@ Mongolian dictionary for cspell.
4
4
 
5
5
  This is a pre-built dictionary for use with CSpell.
6
6
 
7
- ## Installation
7
+ <!--- @@inject: ../../static/requirements.md --->
8
8
 
9
- Global Install and add to CSpell global settings.
9
+ ## Requirements
10
+
11
+ | Tool | Version |
12
+ | ------------------------------------------------------------------------------------------------------------------------------------ | ------- |
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` |
15
+
16
+ <!--- @@inject-end: ../../static/requirements.md --->
17
+
18
+ <!--- @@inject: ./static/install.md --->
19
+
20
+ ## Local Installation
10
21
 
11
22
  ```sh
12
- npm install -g @cspell/dict-mn-mn
13
- cspell link add @cspell/dict-mn-mn
23
+ npm install -D @cspell/dict-mn-mn
14
24
  ```
15
25
 
16
- ## Uninstall from CSpell
26
+ ## Configuration
17
27
 
18
- ```sh
19
- cspell link remove @cspell/dict-mn-mn
28
+ <details>
29
+ <summary>VSCode Settings</summary>
30
+
31
+ Add the following to your VSCode settings:
32
+
33
+ **`.vscode/settings.json`**
34
+
35
+ ```jsonc
36
+ {
37
+ "cSpell.import": ["@cspell/dict-mn-mn/cspell-ext.json"],
38
+ "cSpell.language": "mn, mn-MN",
39
+ }
20
40
  ```
21
41
 
22
- ## Manual Installation
42
+ </details>
43
+
44
+ <details>
45
+ <summary>CSpell Settings `cspell.json`</summary>
23
46
 
24
- Manual installation is useful if you want to include this dictionary as part of your CI/CD lint process.
47
+ **`cspell.json`**
25
48
 
49
+ ```jsonc
50
+ {
51
+ "import": ["@cspell/dict-mn-mn/cspell-ext.json"],
52
+ "language": "mn, mn-MN",
53
+ }
26
54
  ```
27
- npm i @cspell/dict-mn-mn
55
+
56
+ </details>
57
+
58
+ <details>
59
+ <summary>CSpell Settings `cspell.config.yaml`</summary>
60
+
61
+ **`cspell.config.yaml`**
62
+
63
+ ```yaml
64
+ import:
65
+ - '@cspell/dict-mn-mn/cspell-ext.json'
66
+ language: mn, mn-MN
28
67
  ```
29
68
 
30
- The `cspell-ext.json` file in this package should be added to the import section in your `cspell.json` file.
69
+ </details>
70
+
71
+ ## CDN Configuration
72
+
73
+ <details>
74
+ <summary>VSCode Settings</summary>
75
+
76
+ Add the following to your VSCode settings:
77
+
78
+ **`.vscode/settings.json`**
31
79
 
32
- ```javascript
80
+ ```jsonc
33
81
  {
34
- // …
35
- "import": ["@cspell/dict-mn-mn/cspell-ext.json"],
36
- // …
82
+ "cSpell.import": ["https://cdn.jsdelivr.net/npm/@cspell/dict-mn-mn@latest/cspell-ext.json/cspell-ext.json"],
83
+ "cSpell.language": "mn, mn-MN",
37
84
  }
38
85
  ```
39
86
 
40
- # Dictionary Development
87
+ </details>
88
+
89
+ <details>
90
+ <summary>CSpell Settings `cspell.json`</summary>
91
+
92
+ **`cspell.json`**
93
+
94
+ ```jsonc
95
+ {
96
+ "import": ["https://cdn.jsdelivr.net/npm/@cspell/dict-mn-mn@latest/cspell-ext.json/cspell-ext.json"],
97
+ "language": "mn, mn-MN",
98
+ }
99
+ ```
100
+
101
+ </details>
102
+
103
+ <details>
104
+ <summary>CSpell Settings `cspell.config.yaml`</summary>
105
+
106
+ **`cspell.config.yaml`**
107
+
108
+ ```yaml
109
+ import:
110
+ - https://cdn.jsdelivr.net/npm/@cspell/dict-mn-mn@latest/cspell-ext.json/cspell-ext.json
111
+ language: mn, mn-MN
112
+ ```
113
+
114
+ </details>
115
+
116
+ <!--- @@inject-end: ./static/install.md --->
117
+
118
+ <!--- @@inject: ../../static/contributing.md --->
119
+
120
+ ## Contributing
121
+
122
+ Please help correct any mistakes in the dictionaries.
123
+
124
+ See: [Contributing](https://github.com/streetsidesoftware/cspell-dicts#contributing)
125
+
126
+ Special thanks to all of our amazing contributors!
127
+
128
+ ### Dictionary Development
41
129
 
42
130
  See: [How to Create a New Dictionary](https://github.com/streetsidesoftware/cspell-dicts#how-to-create-a-new-dictionary)
43
131
 
132
+ <!--- @@inject-end: ../../static/contributing.md --->
133
+
44
134
  ## License
45
135
 
46
136
  MIT
package/dict/mn-mn.trie.gz CHANGED
Binary file
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@cspell/dict-mn-mn",
3
- "version": "1.1.1",
3
+ "version": "1.2.1",
4
4
  "description": "Mongolian dictionary for cspell.",
5
5
  "publishConfig": {
6
6
  "access": "public",
@@ -15,11 +15,12 @@
15
15
  "build": "cross-env NODE_OPTIONS=--max_old_space_size=8192 cspell-tools-cli build",
16
16
  "test": "pnpm test:words && pnpm test:samples",
17
17
  "test:samples": "cspell samples",
18
- "test:words": "hunspell-reader words -n 1000 -m 0 \"src/hunspell/index.dic\" | cspell -c ./cspell-ext.json \"--locale=mn,mn-MN\" \"--languageId=*\" stdin",
18
+ "test:words": "hunspell-reader words -n 1000 -m 0 \"src/hunspell/mn_MN.dic\" | cspell -c ./cspell-ext.json \"--locale=mn,mn-MN\" \"--languageId=*\" stdin",
19
19
  "prepublishOnly": "pnpm run conditional-build && pnpm test",
20
20
  "prepare:dictionary": "cspell-tools-cli gzip \"dict/*.trie\"",
21
21
  "conditional-build": "pnpm run sync && pnpm run build --conditional && pnpm run prepare:dictionary",
22
- "sync": "pnpm cpy \"node_modules/dictionary-mn/*\" src/hunspell"
22
+ "sync:manual": "GITHUB_TOKEN=$(gh auth token) pnpm sync",
23
+ "sync": "sync-github-files bataak/dict-mn mn_MN LICENSE --latest -o src/hunspell"
23
24
  },
24
25
  "repository": {
25
26
  "type": "git",
@@ -35,20 +36,19 @@
35
36
  "spelling"
36
37
  ],
37
38
  "author": "Street Side Software <support@streetsidesoftware.nl>",
38
- "contributors": [],
39
+ "contributors": [
40
+ "Battseren Badral <bbattseren88@gmail.com>"
41
+ ],
39
42
  "license": "MIT",
40
43
  "bugs": {
41
44
  "url": "https://github.com/streetsidesoftware/cspell-dicts/issues"
42
45
  },
43
46
  "homepage": "https://github.com/streetsidesoftware/cspell-dicts/blob/main/dictionaries/mn_MN#readme",
44
- "devDependencies": {
45
- "dictionary-mn": "^3.0.0"
46
- },
47
47
  "files": [
48
48
  "dict/mn-mn.trie.gz",
49
49
  "cspell-ext.json",
50
50
  "*.js",
51
51
  "*.d.ts"
52
52
  ],
53
- "gitHead": "5aafcca7494be9a5a12cd68e3c34103a1973fe8b"
53
+ "gitHead": "30c5c53b8e28152fc1d8a6cf0c872b068a64221a"
54
54
  }