cspell-dict-en_us - npm Package Compare versions

Comparing version 1.1.1 to 1.1.2

cspell-ext.json

@@ -5,16 +5,32 @@ // cSpell Settings
     "dictionaryDefinitions": [
-        { "name": "en_us", "file": "./en_US.trie.gz" }
+        { "name": "en_us", "file": "./en_US.trie.gz", "repMap": [["'|`|’", "'"]] }
     ],
+    // Dictionaries to always be used.
+    // Generally left empty
+    "dictionaries": [],
+    // Language Rules to apply to matching files.
+    // Files are matched on `languageId` and `local`
     "languageSettings": [
         {
+            // VSCode languageId. i.e. typescript, java, go, cpp, javascript, markdown, latex
+            // * will match against any file type.
             "languageId": "*",
-            "local": "en",
-            "dictionaries": ["en_us"]
-        },
-        {
-            "languageId": "*",
-            "local": "en-US",
-            "dictionaries": ["en_us"]
+            // Language local. i.e. en-US, de-AT, or ru. * will match all locals.
+            // Multiple locals can be specified like: "en, en-US" to match both English and English US.
+            "local": "en,en-US",
+            // By default the whole text of a file is included for spell checking
+            // Adding patterns to the "includeRegExpList" to only include matching patterns
+            "includeRegExpList": [],
+            // To exclude patterns, add them to "ignoreRegExpList"
+            "ignoreRegExpList": [],
+            // regex patterns than can be used with ignoreRegExpList or includeRegExpList
+            // Example: "pattern": [{ "name": "mdash", "pattern": "—" }]
+            // This could be included in "ignoreRegExpList": ["mdash"]
+            "patterns": [],
+            // List of dictionaries to enable by name in `dictionaryDefinitions`
+            "dictionaries": ["en_us"],
+            // Dictionary definitions can also be supplied here. They are only used iff "languageId" and "local" match.
+            "dictionaryDefinitions": []
         }
     ]
 }

package.json

 {
   "name": "cspell-dict-en_us",
-  "version": "1.1.1",
-  "description": "English dictionary for cspell",
+  "version": "1.1.2",
+  "description": "English dictionary for cspell.",
+  "bin": {
+    "cspell-dict-en-us-link": "./link.js",
+    "cspell-dict-en-us-unlink": "./unlink.js"
+  },
   "scripts": {
-    "build": "cspell-tools compile-trie \"en_US.txt\" -o ."
+    "build": "cspell-tools compile-trie \"en_US.txt\" -o .",
+    "cspell-link": "node link.js",
+    "cspell-unlink": "node unlink.js",
+    "publish-minor": "npm version minor && npm publish",
+    "publish-patch": "npm version patch && npm publish"
   },
@@ -17,2 +25,3 @@ "repository": {
     "American",
+    "US English",
     "dictionary",
@@ -30,6 +39,10 @@ "spelling"
   },
+  "dependencies": {
+    "configstore": "^3.1.0"
+  },
   "files": [
     "en_US.trie.gz",
-    "cspell-ext.json"
+    "cspell-ext.json",
+    "*.js"
   ]
 }

README.md

 # Cspell English Dictionary
 
+English dictionary for cspell.
+
 This is a pre-built dictionary for use with cspell.
 
-## Usage
+## Note
+This dictionary comes pre-installed with cspell. It should not be necessary to add it.
 
+## Installation
+
+Global Install and add to cspell global settings.
+
+```sh
+npm install -g cspell-dict-en-us
+cspell-dict-en-us-link
+```
+
+## Uninstall from cspell
+
+```sh
+cspell-dict-en-us-unlink
+```
+
+## Manual Installation
+
 The `cspell-ext.json` file in this package should be added to the import section in your cspell.json file.
@@ -11,3 +31,3 @@ ```javascript
     // …
-    "import": ["<path to node>/cspell-dict-en_us/cspell-ext.json"],
+    "import": ["<path to node_modules>/cspell-dict-en-us/cspell-ext.json"],
     // …
@@ -33,2 +53,3 @@ }
 
-MIT
+MIT
+> Some packages may have other licenses included.

No alert changes

Improved metrics

Total package byte prevSize

299424

increased by1.12%

Number of package files

9

increased by80%

Lines of code

81

increased by326.32%

Number of lines in readme file

54

increased by68.75%

Worsened metrics

Dependency count

1

increased byInfinity%

Dependency changes

• + Addedconfigstore@^3.1.0

• + Addedconfigstore@3.1.5(transitive)

• + Addedcrypto-random-string@1.0.0(transitive)

• + Addeddot-prop@4.2.1(transitive)

• + Addedgraceful-fs@4.2.11(transitive)

• + Addedimurmurhash@0.1.4(transitive)

• + Addedis-obj@1.0.1(transitive)

• + Addedmake-dir@1.3.0(transitive)

• + Addedpify@3.0.0(transitive)

• + Addedsignal-exit@3.0.7(transitive)

• + Addedunique-string@1.0.0(transitive)

• + Addedwrite-file-atomic@2.4.3(transitive)

• + Addedxdg-basedir@3.0.0(transitive)