@cspell/cspell-tools 8.3.1 → 8.4.0

package/dist/app.d.ts

@@ -1,4 +1,4 @@
-import type * as program from 'commander';
+import type { Command } from 'commander';
 import type { FeatureFlags } from './FeatureFlags/index.js';
-export declare function run(program: program.Command, argv: string[], flags?: FeatureFlags): Promise<void>;
+export declare function run(program: Command, argv: string[], flags?: FeatureFlags): Promise<void>;
 //# sourceMappingURL=app.d.ts.map

package/dist/compiler/CompileOptions.d.ts

@@ -8,5 +8,11 @@ export interface CompileOptions {
      * Generate lower case / accent free versions of words.
      */
     generateNonStrict: boolean;
+    /**
+     * Optional filter function to filter out words.
+     * @param word the word to test
+     * @returns `true` to keep the word, `false` to exclude it.
+     */
+    filter?: (word: string) => boolean;
 }
 //# sourceMappingURL=CompileOptions.d.ts.map

package/dist/compiler/compile.js

@@ -4,7 +4,7 @@ import { opConcatMap, opMap, pipe } from '@cspell/cspell-pipe/sync';
 import * as path from 'path';
 import { isFileListSource, isFilePath, isFileSource } from '../config/index.js';
 import { checkShasumFile, updateChecksumForFiles } from '../shasum/index.js';
-import { createAllowedSplitWordsFromFiles } from './createWordsCollection.js';
+import { createAllowedSplitWordsFromFiles, createWordsCollectionFromFiles } from './createWordsCollection.js';
 import { logWithTimestamp } from './logWithTimestamp.js';
 import { readTextFile } from './readers/readTextFile.js';
 import { streamSourceWordsFromFile } from './streamSourceWordsFromFile.js';
@@ -46,17 +46,18 @@ function resolveChecksumFile(checksumFile, root) {
 export async function compileTarget(target, options, compileOptions) {
     logWithTimestamp(`Start compile: ${target.name}`);
     const { rootDir, cwd, checksumFile, conditional } = compileOptions;
-    const { format, sources, trieBase, sort = true, generateNonStrict = false } = target;
+    const { format, sources, trieBase, sort = true, generateNonStrict = false, excludeWordsFrom } = target;
     const targetDirectory = path.resolve(rootDir, target.targetDirectory ?? cwd ?? process.cwd());
+    const excludeFilter = await createExcludeFilter(excludeWordsFrom);
     const generateNonStrictTrie = target.generateNonStrict ?? true;
     const name = normalizeTargetName(target.name);
     const useTrie = format.startsWith('trie');
     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 });
+    const normalizer = normalizeTargetWords({ sort: useTrie || sort, generateNonStrict, filter: excludeFilter });
     const checksumRoot = (checksumFile && path.dirname(checksumFile)) || rootDir;
-    const deps = [...calculateDependencies(filename, filesToProcess, checksumRoot)];
+    const deps = [...calculateDependencies(filename, filesToProcess, excludeWordsFrom, checksumRoot)];
     if (conditional && checksumFile) {
         const check = await checkShasumFile(checksumFile, deps, checksumRoot).catch(() => undefined);
         if (check?.passed) {
@@ -81,9 +82,10 @@ export async function compileTarget(target, options, compileOptions) {
     logWithTimestamp(`Done compile: ${target.name}`);
     return deps;
 }
-function calculateDependencies(targetFile, filesToProcess, rootDir) {
+function calculateDependencies(targetFile, filesToProcess, excludeFiles, rootDir) {
     const dependencies = new Set();
     addDependency(targetFile);
+    excludeFiles?.forEach((f) => addDependency(f));
     filesToProcess.forEach((f) => addDependency(f.src));
     return dependencies;
     function addDependency(filename) {
@@ -187,4 +189,10 @@ function logProgress(freq = 100000) {
     }
     return logProgress;
 }
+async function createExcludeFilter(excludeWordsFrom) {
+    if (!excludeWordsFrom || !excludeWordsFrom.length)
+        return () => true;
+    const excludeWords = await createWordsCollectionFromFiles(excludeWordsFrom);
+    return (word) => !excludeWords.has(word);
+}
 //# sourceMappingURL=compile.js.map

package/dist/compiler/wordListParser.js

@@ -13,6 +13,7 @@ export function normalizeTargetWords(options) {
         lineParser,
         options.sort ? createInlineBufferedSort(10000) : undefined,
         opFilter(uniqueFilter(10000)),
+        options.filter ? opFilter(options.filter) : undefined,
     ].filter(isDefined);
     return opCombine(...operations);
 }

package/dist/config/config.d.ts

@@ -86,7 +86,7 @@ export interface Target extends CompileTargetOptions {
      * Words from the sources that are found in `excludeWordsFrom` files
      * will not be added to the dictionary.
      *
-     * @version TBD
+     * @version 8.3.2
      */
     excludeWordsFrom?: FilePath[] | undefined;
     /**

package/dist/test/TestHelper.d.ts

@@ -1,5 +1,7 @@
 export interface TestHelper {
+    /** path to `.../cspell/package/cspell-tools/` */
     readonly packageRoot: string;
+    /** path to `...cspell/` */
     readonly repoRoot: string;
     readonly tempDir: string;
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cspell/cspell-tools",
-  "version": "8.3.1",
+  "version": "8.4.0",
   "description": "Tools to assist with the development of cSpell",
   "publishConfig": {
     "access": "public"
@@ -49,13 +49,13 @@
   },
   "homepage": "https://github.com/streetsidesoftware/cspell#readme",
   "dependencies": {
-    "@cspell/cspell-pipe": "8.3.1",
-    "commander": "^11.1.0",
+    "@cspell/cspell-pipe": "8.4.0",
+    "commander": "^12.0.0",
     "cosmiconfig": "9.0.0",
-    "cspell-trie-lib": "8.3.1",
+    "cspell-trie-lib": "8.4.0",
     "gensequence": "^6.0.0",
     "glob": "^10.3.10",
-    "hunspell-reader": "8.3.1",
+    "hunspell-reader": "8.4.0",
     "yaml": "^2.3.4"
   },
   "engines": {
@@ -67,5 +67,5 @@
     "ts-json-schema-generator": "^1.5.0"
   },
   "module": "bin.mjs",
-  "gitHead": "7136c39fd5f47c2acd44bec0bede924e55e1a107"
+  "gitHead": "f9ad457ca2102c6642c377417a95a4415f5ec3d8"
 }