fix: move generated files to dict dir (#5219)

Author: Jason3S

dictionaries/scientific_terms_US/checksum.txt

@@ -1,3 +1,7 @@
-cc2775ed4da05d67a9dd76fc501732a6291ebfcd  custom_scientific_US.trie
+442d111940f52663d5547f81d5d793730695db8b  dict/custom_scientific_US.trie
+206aeaaf65a15bcb81d767c91b033cec93071119  dict/custom_scientific_US.trie.gz
+5ea5757e8a925b3eca72a77b4711ce4262a7ff5d  dict/mathematics_US.txt
+4df93ddb46e48aa99d15721547966bc9116fec4d  dict/mathematics_US.txt.gz
 833755fdf18d2e4685fea2bb58691d1e560dbcd9  src/additional_words.txt
 61efec43fbef76b3abbd49edc895e14925048c43  src/custom_scientific_US.dic.txt
+b858baec22e7bc2297a3114300fae142cbf2997f  src/mathematics.txt

dictionaries/scientific_terms_US/cspell-ext.json

@@ -1,47 +1,29 @@
-// cSpell Settings
 {
     "id": "scientific-terms-us",
     "name": "Scientific Terms US",
     "description": "Scientific Terms US dictionary.",
     "readonly": true,
-    // List of dictionary files to add to the global list of dictionaries
     "dictionaryDefinitions": [
         {
             "name": "scientific-terms-us",
-            "path": "./custom_scientific_US.trie.gz",
+            "path": "./dict/custom_scientific_US.trie.gz",
             "description": "Scientific Terms US dictionary."
         },
         {
             "name": "mathematics-terms-us",
-            "path": "./mathematics.trie.gz",
+            "path": "./dict/mathematics_US.txt.gz",
             "description": "Mathematics Terms US dictionary."
         }
     ],
-    // Dictionaries to always be used.
-    // Generally left empty
     "dictionaries": [],
-    // Language Rules to apply to matching files.
-    // Files are matched on `languageId` and `locale`
     "languageSettings": [
         {
-            // VSCode languageId. i.e. typescript, java, go, cpp, javascript, markdown, latex
-            // * will match against any file type.
             "languageId": "*",
-            // Language locale. 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.
             "locale": "*",
-            // 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": ["scientific-terms-us"],
-            // Dictionary definitions can also be supplied here. They are only used iff "languageId" and "locale" match.
+            "dictionaries": ["scientific-terms-us", "mathematics-terms-us"],
             "dictionaryDefinitions": []
         }
     ]

dictionaries/scientific_terms_US/cspell-tools.config.yaml

@@ -2,18 +2,22 @@
 
 targets:
   - name: custom_scientific_US
-    targetDirectory: .
-    compress: false
+    targetDirectory: dict
+    compress: true
+    keepUncompressed: true
     format: trie3
     sources:
       - src/custom_scientific_US.dic.txt
       - src/additional_words.txt
     generateNonStrict: true
+
   - name: mathematics_US
-    targetDirectory: .
-    compress: false
-    format: trie3
+    targetDirectory: dict
+    compress: true
+    keepUncompressed: true
+    format: plaintext
     sources:
       - src/mathematics.txt
-    generateNonStrict: true
+    generateNonStrict: false
+
 checksumFile: true

dictionaries/scientific_terms_US/custom_scientific_US.trie

@@ -0,0 +1,3 @@
+# Dict Directory
+
+NOTE: This directory contains generated content. Please edit [src](../src/README.md) files.

dictionaries/scientific_terms_US/dict/README.md

@@ -12,10 +12,10 @@
     "./cspell-ext.json": "./cspell-ext.json"
   },
   "scripts": {
-    "build": "cspell-tools-cli build && pnpm gz",
-    "conditional-build": "cspell-tools-cli build --conditional && pnpm gz",
+    "build": "cspell-tools-cli build",
+    "conditional-build": "cspell-tools-cli build --conditional",
     "test": "shx head -n 1000 \"src/custom_scientific_US.dic.txt\" | cspell -c ./cspell-ext.json --locale=en --languageId=* stdin",
-    "gz": "cspell-tools-cli gzip \"*.trie\"",
+    "gz": "cspell-tools-cli gzip \"dict/*.trie\" \"dict/*.txt\"",
     "prepare:dictionary": "pnpm gz",
     "prepublishOnly": "echo pre-publish"
   },
@@ -38,7 +38,7 @@
   },
   "homepage": "https://github.com/streetsidesoftware/cspell-dicts/blob/main/dictionaries/scientific_terms_US#readme",
   "files": [
-    "custom_scientific_US.trie.gz",
+    "dict/*.gz",
     "cspell-ext.json"
   ]
 }