@cspell/cspell-tools 8.10.0 → 8.10.2

package/cspell-tools.config.schema.json

@@ -144,6 +144,13 @@
           "description": "gzip the file?",
           "type": "boolean"
         },
+        "dictionaryDirectives": {
+          "description": "Injects `cspell-dictionary` directives into the dictionary header.\n\nExample:\n\n```ini # cspell-dictionary: no-generate-alternatives ```\n\nKnown Directives: ```yaml\n- split # Tell the dictionary loader to split words\n- no-split # Tell the dictionary loader to not split words (default)\n- generate-alternatives # Tell the dictionary loader to generate alternate spellings (default)\n- no-generate-alternatives # Tell the dictionary loader to not generate alternate spellings ```",
+          "items": {
+            "type": "string"
+          },
+          "type": "array"
+        },
         "excludeWordsFrom": {
           "description": "Words from the sources that are found in `excludeWordsFrom` files will not be added to the dictionary.",
           "items": {
@@ -156,7 +163,7 @@
           "description": "Format of the dictionary."
         },
         "generateNonStrict": {
-          "default": true,
+          "default": false,
           "description": "Generate lower case / accent free versions of words.",
           "type": "boolean"
         },
@@ -165,7 +172,7 @@
           "type": "string"
         },
         "sort": {
-          "default": ": true",
+          "default": true,
           "description": "Sort the words in the resulting dictionary. Does not apply to `trie` based formats.",
           "type": "boolean"
         },
@@ -221,8 +228,15 @@
         "boolean"
       ]
     },
+    "dictionaryDirectives": {
+      "description": "Injects `cspell-dictionary` directives into the dictionary header.\n\nExample:\n\n```ini # cspell-dictionary: no-generate-alternatives ```\n\nKnown Directives: ```yaml\n- split # Tell the dictionary loader to split words\n- no-split # Tell the dictionary loader to not split words (default)\n- generate-alternatives # Tell the dictionary loader to generate alternate spellings (default)\n- no-generate-alternatives # Tell the dictionary loader to not generate alternate spellings ```",
+      "items": {
+        "type": "string"
+      },
+      "type": "array"
+    },
     "generateNonStrict": {
-      "default": true,
+      "default": false,
       "description": "Generate lower case / accent free versions of words.",
       "type": "boolean"
     },
@@ -240,7 +254,7 @@
       "type": "string"
     },
     "sort": {
-      "default": ": true",
+      "default": true,
       "description": "Sort the words in the resulting dictionary. Does not apply to `trie` based formats.",
       "type": "boolean"
     },

package/dist/compiler/CompileOptions.d.ts

@@ -14,5 +14,16 @@ export interface CompileOptions {
      * @returns `true` to keep the word, `false` to exclude it.
      */
     filter?: (word: string) => boolean;
+    /**
+     * Injects `cspell-dictionary` directives into the dictionary header.
+     *
+     * Example:
+     *
+     * ```ini
+     * # cspell-dictionary: no-generate-alternatives
+     * ```
+     *
+     */
+    dictionaryDirectives?: string[] | undefined;
 }
 //# sourceMappingURL=CompileOptions.d.ts.map

package/dist/compiler/compile.d.ts

@@ -19,6 +19,7 @@ interface CompileTargetOptions {
     cwd: string | undefined;
     conditional: boolean;
     checksumFile: string | undefined;
+    dictionaryDirectives: string[] | undefined;
 }
 export declare function compileTarget(target: Target, options: CompileSourceConfig, compileOptions: CompileTargetOptions): Promise<string[]>;
 export {};

package/dist/compiler/compile.js

@@ -21,13 +21,20 @@ export async function compile(request, options) {
     };
     const conditional = options?.conditionalBuild || false;
     const checksumFile = resolveChecksumFile(request.checksumFile || conditional, rootDir);
+    const dictionaryDirectives = request.dictionaryDirectives;
     const dependencies = new Set();
     for (const target of targets) {
         const keep = options?.filter?.(target) ?? true;
         if (!keep)
             continue;
         const adjustedTarget = { ...targetOptions, ...target };
-        const deps = await compileTarget(adjustedTarget, request, { rootDir, cwd, conditional, checksumFile });
+        const deps = await compileTarget(adjustedTarget, request, {
+            rootDir,
+            cwd,
+            conditional,
+            checksumFile,
+            dictionaryDirectives,
+        });
         deps.forEach((dep) => dependencies.add(dep));
     }
     if (checksumFile && dependencies.size) {
@@ -48,6 +55,7 @@ export async function compileTarget(target, options, compileOptions) {
     const { rootDir, cwd, checksumFile, conditional } = compileOptions;
     const { format, sources, trieBase, sort = true, generateNonStrict = false, excludeWordsFrom } = target;
     const targetDirectory = path.resolve(rootDir, target.targetDirectory ?? cwd ?? process.cwd());
+    const dictionaryDirectives = compileOptions.dictionaryDirectives;
     const excludeFilter = await createExcludeFilter(excludeWordsFrom);
     const generateNonStrictTrie = target.generateNonStrict ?? true;
     const name = normalizeTargetName(target.name);
@@ -55,7 +63,12 @@ export async function compileTarget(target, options, compileOptions) {
     const filename = resolveTarget(name, targetDirectory, useTrie, target.compress ?? false);
     const filesToProcessAsync = pipeAsync(readSourceList(sources, rootDir), opMapAsync((src) => readFileSource(src, options)), opAwaitAsync());
     const filesToProcess = await toArray(filesToProcessAsync);
-    const normalizer = normalizeTargetWords({ sort: useTrie || sort, generateNonStrict, filter: excludeFilter });
+    const normalizer = normalizeTargetWords({
+        sort: useTrie || sort,
+        generateNonStrict,
+        filter: excludeFilter,
+        dictionaryDirectives,
+    });
     const checksumRoot = (checksumFile && path.dirname(checksumFile)) || rootDir;
     const deps = [...calculateDependencies(filename, filesToProcess, excludeWordsFrom, checksumRoot)];
     if (conditional && checksumFile) {
@@ -73,10 +86,11 @@ export async function compileTarget(target, options, compileOptions) {
                 trie3: format === 'trie3',
                 trie4: format === 'trie4',
                 generateNonStrict: generateNonStrictTrie,
+                dictionaryDirectives: undefined,
             });
         }
         : async (words, dst) => {
-            return compileWordList(pipe(words, normalizer), dst, { sort, generateNonStrict });
+            return compileWordList(pipe(words, normalizer), dst, { sort, generateNonStrict, dictionaryDirectives });
         };
     await processFiles(action, filesToProcess, filename);
     logWithTimestamp(`Done compile: ${target.name}`);

package/dist/compiler/wordListCompiler.js

@@ -10,12 +10,13 @@ const mkdirp = async (p) => {
 };
 // Indicate that a word list has already been processed.
 const wordListHeader = `
-# cspell-tools: keep-case no-split
-`;
+# cspell-tools: keep-case no-split`;
 const wordListHeaderLines = wordListHeader.split('\n').map((a) => a.trim());
 export async function compileWordList(lines, destFilename, options) {
     const finalLines = normalize(lines, options);
-    const finalSeq = pipe(wordListHeaderLines, opAppend(finalLines));
+    const directives = options.dictionaryDirectives ?? [];
+    const directivesLines = directives.map((a) => `# cspell-dictionary: ${a}`);
+    const finalSeq = pipe([...wordListHeaderLines, ...directivesLines, ''], opAppend(finalLines));
     return createWordListTarget(destFilename)(finalSeq);
 }
 function normalize(lines, options) {

package/dist/config/config.d.ts

@@ -39,13 +39,13 @@ export interface Experimental {
 export interface CompileTargetOptions {
     /**
      * Generate lower case / accent free versions of words.
-     * @default true
+     * @default false
      */
     generateNonStrict?: boolean | undefined;
     /**
      * Sort the words in the resulting dictionary.
      * Does not apply to `trie` based formats.
-     * @default: true
+     * @default true
      */
     sort?: boolean | undefined;
     /**
@@ -58,6 +58,24 @@ export interface CompileTargetOptions {
      * dictionary.
      */
     allowedSplitWords?: FilePath | FilePath[] | undefined;
+    /**
+     * Injects `cspell-dictionary` directives into the dictionary header.
+     *
+     * Example:
+     *
+     * ```ini
+     * # cspell-dictionary: no-generate-alternatives
+     * ```
+     *
+     * Known Directives:
+     * ```yaml
+     * - split # Tell the dictionary loader to split words
+     * - no-split # Tell the dictionary loader to not split words (default)
+     * - generate-alternatives # Tell the dictionary loader to generate alternate spellings (default)
+     * - no-generate-alternatives # Tell the dictionary loader to not generate alternate spellings
+     * ```
+     */
+    dictionaryDirectives?: string[] | undefined;
 }
 export interface Target extends CompileTargetOptions {
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cspell/cspell-tools",
-  "version": "8.10.0",
+  "version": "8.10.2",
   "description": "Tools to assist with the development of cSpell",
   "publishConfig": {
     "access": "public"
@@ -50,13 +50,13 @@
   },
   "homepage": "https://github.com/streetsidesoftware/cspell#readme",
   "dependencies": {
-    "@cspell/cspell-pipe": "8.10.0",
+    "@cspell/cspell-pipe": "8.10.2",
     "commander": "^12.1.0",
     "cosmiconfig": "9.0.0",
-    "cspell-trie-lib": "8.10.0",
+    "cspell-trie-lib": "8.10.2",
     "gensequence": "^7.0.0",
     "glob": "^10.4.2",
-    "hunspell-reader": "8.10.0",
+    "hunspell-reader": "8.10.2",
     "yaml": "^2.4.5"
   },
   "engines": {
@@ -68,5 +68,5 @@
     "ts-json-schema-generator": "^2.3.0"
   },
   "module": "bin.mjs",
-  "gitHead": "a5dde6ae7e2ac86ac956220d4b8c39a0e58e1bc6"
+  "gitHead": "1a1f15b593a0b25419c1e74eeb53d0b2839762cc"
 }