fix: Update Bash dictionary (#3988)

streetsidesoftware · Jan 6, 2025 · 165c758 · 165c758
1 parent 681e8d2
commit 165c758
Show file tree

Hide file tree

Showing 13 changed files with 29 additions and 2 deletions.
diff --git a/dictionaries/bash/cspell-tools.config.yaml b/dictionaries/bash/cspell-tools.config.yaml
@@ -4,6 +4,8 @@ targets:
   - name: bash-words
     sources:
       - ./src/bash-words.txt
+      - listFile: ../shell/common-source-files.txt
+      - ../shell/src/shell-bash-words.txt
     format: plaintext
     targetDirectory: './dict'
     generateNonStrict: false
diff --git a/dictionaries/bash/dict/bash-words.txt b/dictionaries/bash/dict/bash-words.txt
diff --git a/dictionaries/bash/package.json b/dictionaries/bash/package.json
@@ -13,7 +13,7 @@
   },
   "scripts": {
     "build": "cspell-tools-cli build",
-    "test": "shx head -n 100 src/bash-words.txt | cspell -c ./cspell-ext.json \"--locale=*\" \"--languageId=shellscript\" stdin",
+    "test": "shx cat src/bash-words.txt | cspell -c ./cspell-ext.json \"--locale=*\" \"--languageId=shellscript\" stdin",
     "prepublishOnly": "echo pre-publish",
     "prepare:dictionary": "pnpm run build"
   },

diff --git a/dictionaries/shell/cspell-tools.config.yaml b/dictionaries/shell/cspell-tools.config.yaml
@@ -5,6 +5,7 @@ targets:
     sources:
       - listFile: ./common-source-files.txt
       - ./src/shell-bash-words.txt
+      - ../bash/src/bash-words.txt
     format: plaintext
     targetDirectory: './dict'
     generateNonStrict: false

diff --git a/dictionaries/shell/dict/bash-words.txt b/dictionaries/shell/dict/bash-words.txt
diff --git a/dictionaries/shell/package.json b/dictionaries/shell/package.json
@@ -13,7 +13,7 @@
   },
   "scripts": {
     "build": "cspell-tools-cli build",
-    "test": "shx head -n 100 src/legacy-words.txt | cspell -c ./cspell-ext.json \"--locale=*\" \"--languageId=shellscript\" stdin",
+    "test": "shx cat test/legacy-words.txt | cspell -c ./cspell-ext.json \"--locale=*\" \"--languageId=shellscript\" stdin",
     "prepublishOnly": "echo pre-publish",
     "prepare:dictionary": "pnpm run build"
   },

diff --git a/dictionaries/shell/src/command-words.txt b/dictionaries/shell/src/command-words.txt
@@ -1,3 +1,4 @@
+# General commands, functions, and tools
 chsh
 dbus
 dpkg

diff --git a/dictionaries/shell/src/glob-words.txt b/dictionaries/shell/src/glob-words.txt
@@ -1,3 +1,4 @@
+# Common Environment and Glob related terms.
 BASH_ARGV0
 BASH_COMPAT
 BASH_SOURCE

diff --git a/dictionaries/shell/src/miscellaneous-words.txt b/dictionaries/shell/src/miscellaneous-words.txt
@@ -1,3 +1,4 @@
+# Terms that are common to shell scripts but not a command, function, or keyword.
 alnum
 autoremove
 cntrl

diff --git a/dictionaries/shell/src/shell-bash-words.txt b/dictionaries/shell/src/shell-bash-words.txt
@@ -1,3 +1,4 @@
+# Bash related terms
 bashscript
 braceexpand
 builtin

diff --git a/dictionaries/shell/src/shell-sh-words.txt b/dictionaries/shell/src/shell-sh-words.txt
@@ -1,3 +1,4 @@
+# general shell functions and keyword shared across the various shells.
 alias
 allexport
 bg

diff --git a/dictionaries/shell/src/shell-zsh-words.txt b/dictionaries/shell/src/shell-zsh-words.txt
@@ -1,3 +1,4 @@
+# zsh related terms
 --no-globalrcs
 ARCHFLAGS
 autoload

diff --git a/dictionaries/shell/src/legacy-words.txt → dictionaries/shell/test/legacy-words.txt b/dictionaries/shell/src/legacy-words.txt → dictionaries/shell/test/legacy-words.txt
-Original file line number
+Diff line change
@@ -1,3 +1,4 @@
+    # General commands, functions, and tools
     chsh
     dbus
     dpkg
@@ Expand Down @@