Move shell script words into their own package.

dictionaries/bash/README.md

@@ -38,14 +38,6 @@ The `cspell-ext.json` file in this package should be added to the import section
 }
 ```
 
-## Building
-
-Building is only necessary if you want to modify the contents of the dictionary. Note: Building will take a few minutes for large files.
-
-```sh
-npm run build
-```
-
 ## License
 
 MIT

dictionaries/bash/cspell-ext.json

@@ -1,30 +1,20 @@
 {
-    "id": "shellscript",
-    "name": "ShellScript",
-    "description": "ShellScript dictionary for cspell.",
+    "id": "bash",
+    "name": "bash",
+    "description": "Bash dictionary for cspell.",
     "readonly": true,
     "dictionaryDefinitions": [
         {
             "name": "bash",
             "path": "./dict/bash-words.txt",
             "description": "Bash dictionary for cspell."
-        },
-        {
-            "name": "shellscript",
-            "path": "./dict/shell-all-words.txt",
-            "description": "ShellScript dictionary for cspell."
         }
     ],
     "dictionaries": [],
     "languageSettings": [
         {
             "languageId": "shellscript",
             "locale": "*",
-            "dictionaries": ["shellscript"]
-        },
-        {
-            "languageId": "bashscript",
-            "locale": "*",
             "dictionaries": ["bash"]
         }
     ]

dictionaries/bash/cspell-tools.config.yaml

@@ -3,16 +3,7 @@
 targets:
   - name: bash-words
     sources:
-      - listFile: ./common-source-files.txt
-      - ./src/shell-bash-words.txt
-    format: plaintext
-    targetDirectory: "./dict"
-    generateNonStrict: false
-  - name: shell-all-words
-    sources:
-      - listFile: ./common-source-files.txt
-      - ./src/shell-bash-words.txt
-      - ./src/shell-zsh-words.txt
+      - ./src/bash-words.txt
     format: plaintext
     targetDirectory: "./dict"
     generateNonStrict: false

dictionaries/bash/cspell.json

@@ -4,7 +4,7 @@
         "**/*.{md,txt}"
     ],
     "dictionaries": [
-        "shellscript"
+        "bash"
     ],
     "import": [
         "./cspell-ext.json"

dictionaries/bash/dict/bash-words.txt

@@ -50,7 +50,6 @@ PPID
 PROMPT_COMMAND
 PS1
 PS2
-PS3
 PS4
 READLINE_LINE
 READLINE_MARK
@@ -72,6 +71,7 @@ UID
 alias
 allexport
 autoremove
+bashscript
 bg
 bind
 braceexpand
@@ -85,6 +85,7 @@ compgen
 complete
 compopt
 continue
+coproc
 dbus
 dearmor
 declare
@@ -98,7 +99,6 @@ elif
 else
 emacs
 enable
-enarmor
 errexit
 errtrace
 esac
@@ -142,7 +142,6 @@ noglob
 nolog
 notify
 nounset
-nvim
 onecmd
 physical
 pipefail
@@ -183,7 +182,6 @@ unset
 until
 verbose
 vi
-vim
 wait
 while
 xtrace

dictionaries/shell/CHANGELOG.md

@@ -0,0 +1 @@
+# Change Log

dictionaries/shell/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017-2020 Jason Dent <jason@streetsidesoftware.nl>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

dictionaries/shell/README.md

@@ -0,0 +1,45 @@
+# CSpell Shell Script Dictionary
+
+Shell Script dictionary for cspell.
+
+This is a pre-built dictionary for use with cspell.
+
+## Requirements
+
+| Tool                                                                                                                                 | Version |
+| ------------------------------------------------------------------------------------------------------------------------------------ | ------- |
+| [cspell](https://github.com/streetsidesoftware/cspell)                                                                               | `>= 6`  |
+| [Code Spell Checker - Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker) | `>= 2`  |
+
+## Installation
+
+Global Install and add to cspell global settings.
+
+```sh
+npm install -g @cspell/dict-shell
+cspell link add @cspell/dict-shell
+```
+
+## Uninstall from cspell
+
+```sh
+cspell link remove @cspell/dict-shell
+```
+
+## Manual Installation
+
+The `cspell-ext.json` file in this package should be added to the import section in your cspell.json file.
+
+```javascript
+{
+    // …
+    "import": ["@cspell/dict-shell/cspell-ext.json"],
+    // …
+}
+```
+
+## License
+
+MIT
+
+> Some packages may have other licenses included.

dictionaries/shell/cspell-ext.json

@@ -0,0 +1,31 @@
+{
+    "id": "shellscript",
+    "name": "ShellScript",
+    "description": "ShellScript dictionary for cspell.",
+    "readonly": true,
+    "dictionaryDefinitions": [
+        {
+            "name": "bash",
+            "path": "./dict/bash-words.txt",
+            "description": "Bash dictionary for cspell."
+        },
+        {
+            "name": "shellscript",
+            "path": "./dict/shell-all-words.txt",
+            "description": "ShellScript dictionary for cspell."
+        }
+    ],
+    "dictionaries": [],
+    "languageSettings": [
+        {
+            "languageId": "shellscript",
+            "locale": "*",
+            "dictionaries": ["shellscript"]
+        },
+        {
+            "languageId": "bashscript",
+            "locale": "*",
+            "dictionaries": ["bash"]
+        }
+    ]
+}

dictionaries/shell/cspell-tools.config.yaml

@@ -0,0 +1,18 @@
+# yaml-language-server: $schema=https://raw.githubusercontent.com/streetsidesoftware/cspell/main/packages/cspell-tools/cspell-tools.config.schema.json
+
+targets:
+  - name: bash-words
+    sources:
+      - listFile: ./common-source-files.txt
+      - ./src/shell-bash-words.txt
+    format: plaintext
+    targetDirectory: "./dict"
+    generateNonStrict: false
+  - name: shell-all-words
+    sources:
+      - listFile: ./common-source-files.txt
+      - ./src/shell-bash-words.txt
+      - ./src/shell-zsh-words.txt
+    format: plaintext
+    targetDirectory: "./dict"
+    generateNonStrict: false

dictionaries/shell/cspell.json

@@ -0,0 +1,15 @@
+{
+    "version": "0.2",
+    "files": [
+        "**/*.{md,txt}"
+    ],
+    "dictionaries": [
+        "shellscript"
+    ],
+    "import": [
+        "./cspell-ext.json"
+    ],
+    "words": [
+        "mdash"
+    ]
+}