@cspell/cspell-tools 9.6.0 → 9.6.2

package/dist/app.mjs

@@ -1,4 +1,4 @@
-import { a as reportCheckChecksumFile, c as toError, d as compressFile, i as logWithTimestamp, l as generateBTrie, n as compile, o as reportChecksumForFiles, r as setLogger, s as updateChecksumForFiles, t as build, u as OSFlags } from "./build-OgMPaXPZ.mjs";
+import { a as reportCheckChecksumFile, c as toError, d as compressFile, i as logWithTimestamp, l as generateBTrie, n as compile, o as reportChecksumForFiles, r as setLogger, s as updateChecksumForFiles, t as build, u as OSFlags } from "./build-Dxf6sFCy.mjs";
 import { readFileSync } from "node:fs";
 import { CommanderError, Option } from "commander";
 import { writeFile } from "node:fs/promises";

package/dist/{build-OgMPaXPZ.mjs → build-Dxf6sFCy.mjs}

@@ -1,7 +1,7 @@
 import { promises } from "node:fs";
 import fs, { mkdir, readFile, writeFile } from "node:fs/promises";
 import * as path from "node:path";
-import fsPath, { resolve, sep } from "node:path";
+import fsPath, { dirname, relative, resolve, sep } from "node:path";
 import * as Trie from "cspell-trie-lib";
 import { COMPOUND_FIX, FORBID_PREFIX, createDictionaryLineParser, decodeTrie, encodeTrieDataToBTrie, parseDictionary } from "cspell-trie-lib";
 import { promisify } from "node:util";
@@ -238,15 +238,17 @@ async function createReader(filename, options) {
 //#endregion
 //#region src/compiler/bTrie.ts
 async function generateBTrieFromFile(file, options) {
-	console.log(`Processing file: ${file}`);
+	const log$1 = options.logger || console.log.bind(console);
+	log$1(`Processing file: ${file}`);
 	const btrie = await createBTrieFromFile(file, options);
 	const outFile = bTrieFileName(file, options);
 	await mkdir(fsPath.dirname(outFile), { recursive: true });
 	await writeFile$1(outFile, btrie);
-	console.log(`Written BTrie to: ${outFile}`);
+	log$1(`Written BTrie to: ${outFile}`);
+	return outFile;
 }
 async function generateBTrieFromFiles(files, options) {
-	console.log(`Generating BTrie for ${files.length} file(s).`);
+	(options.logger || console.log.bind(console))(`Generating BTrie for ${files.length} file(s).`);
 	for (const file of files) await generateBTrieFromFile(file, options);
 }
 function bTrieFileName(inputFilename, options) {
@@ -343,16 +345,17 @@ async function shasumFile(filename, root) {
 /**
 *
 * @param filename - name of checksum file
-* @param files - optional list of files to check
+* @param files - optional list of files to check - they will be resolved relative to the checksum file.
 * @param root - optional root, default cwd.
 */
 async function checkShasumFile(filename, files, root) {
 	files = !files ? files : files.length ? files : void 0;
+	const resolvedRoot = resolve(root || ".");
+	const fileDir = dirname(resolve(resolvedRoot, filename));
 	const shaFiles = await readAndParseShasumFile(filename);
-	const filesToCheck = !files ? shaFiles.map(({ filename: filename$1 }) => filename$1) : files;
+	const relFilesToCheck = (!files ? shaFiles.map(({ filename: filename$1 }) => filename$1) : files).map((f) => relative(fileDir, resolve(fileDir, f)));
 	const mapNameToChecksum = new Map(shaFiles.map((r) => [normalizeFilename(r.filename), r.checksum]));
-	const resolvedRoot = resolve(root || ".");
-	const results = await Promise.all(filesToCheck.map(normalizeFilename).map((filename$1) => {
+	const results = await Promise.all(relFilesToCheck.map(normalizeFilename).map((filename$1) => {
 		return tryToCheckFile(filename$1, resolvedRoot, mapNameToChecksum.get(filename$1));
 	}));
 	return {
@@ -1160,11 +1163,36 @@ function resolveChecksumFile(checksumFile, root) {
 }
 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, excludeWordsFrom = [], excludeWordsNotFoundIn = [], excludeWordsMatchingRegex } = target;
+	const buildOptions = genBuildTargetDictionaryOptions(target, compileOptions);
+	const deps = /* @__PURE__ */ new Set();
+	addToSet(deps, await buildTargetDictionary(target, options, compileOptions, buildOptions), await compressDictionaryFileIfNeeded(buildOptions), await genBTrieForTarget(target, buildOptions));
+	logWithTimestamp(`Done compile: ${target.name}`);
+	const checksumRoot = buildOptions.checksumRoot;
+	return [...deps].map((d) => path.relative(checksumRoot, d));
+}
+function genBuildTargetDictionaryOptions(target, compileOptions) {
+	const { rootDir, checksumFile, cwd } = compileOptions;
 	let targetDirectory = target.targetDirectory ?? cwd ?? process.cwd();
 	targetDirectory = targetDirectory.replace("${cwd}", cwd ?? process.cwd());
 	targetDirectory = path.resolve(rootDir, targetDirectory);
+	const name = normalizeTargetName(target.name);
+	const useTrie = target.format.startsWith("trie");
+	const generateCompressed = target.compress ?? false;
+	const generateUncompressed = target.keepUncompressed ?? false;
+	const generateOnlyCompressedDictionary = generateCompressed && !generateUncompressed;
+	return {
+		name,
+		filename: resolveTarget(name, targetDirectory, useTrie),
+		useTrie,
+		generateOnlyCompressedDictionary,
+		generateCompressed,
+		checksumRoot: checksumFile && path.dirname(checksumFile) || rootDir
+	};
+}
+async function buildTargetDictionary(target, options, compileOptions, buildOptions) {
+	const { rootDir, checksumFile, conditional } = compileOptions;
+	const { format, sources, trieBase, sort = true, generateNonStrict = false, excludeWordsFrom = [], excludeWordsNotFoundIn = [], excludeWordsMatchingRegex } = target;
+	const { filename, useTrie, generateOnlyCompressedDictionary, checksumRoot } = buildOptions;
 	const dictionaryDirectives = target.dictionaryDirectives ?? compileOptions.dictionaryDirectives;
 	const removeDuplicates$1 = target.removeDuplicates ?? false;
 	const excludeFromFilter = await createExcludeFilter(excludeWordsFrom);
@@ -1173,14 +1201,7 @@ async function compileTarget(target, options, compileOptions) {
 	const excludeFilter = (word) => {
 		return excludeFromFilter(word) && includeFromFilter(word) && excludeRegexFilter(word);
 	};
-	const name = normalizeTargetName(target.name);
-	const useTrie = format.startsWith("trie");
-	const generateCompressed = target.compress ?? false;
-	const generateUncompressed = target.keepUncompressed ?? false;
-	const genSet = /* @__PURE__ */ new Set();
-	genSet.add(generateCompressed);
-	if (generateUncompressed) genSet.add(false);
-	const filename = resolveTarget(name, targetDirectory, useTrie);
+	const compress$1 = generateOnlyCompressedDictionary;
 	const filesToProcess = await toArray(pipeAsync(readSourceList(sources, rootDir), opMapAsync((src) => readFileSource(src, options)), opAwaitAsync()));
 	const normalizer = normalizeTargetWords({
 		sort: useTrie || sort,
@@ -1188,8 +1209,7 @@ async function compileTarget(target, options, compileOptions) {
 		filter: excludeFilter,
 		dictionaryDirectives
 	});
-	const checksumRoot = checksumFile && path.dirname(checksumFile) || rootDir;
-	const deps = [...calculateDependencies(filename + (generateCompressed ? ".gz" : ""), filesToProcess, [...excludeWordsFrom, ...excludeWordsNotFoundIn], checksumRoot)];
+	const deps = [...calculateDependencies(filename + (compress$1 ? ".gz" : ""), filesToProcess, [...excludeWordsFrom, ...excludeWordsNotFoundIn], checksumRoot)];
 	if (conditional && checksumFile) {
 		if ((await checkShasumFile(checksumFile, deps, checksumRoot).catch(() => void 0))?.passed) {
 			logWithTimestamp(`Skip ${target.name}, nothing changed.`);
@@ -1197,7 +1217,7 @@ async function compileTarget(target, options, compileOptions) {
 		}
 	}
 	async function action(words, dst) {
-		const data = iterableToString(pipe(words, normalizer, useTrie ? createTrieCompiler({
+		await createTargetFile(dst, iterableToString(pipe(words, normalizer, useTrie ? createTrieCompiler({
 			base: trieBase,
 			trie3: format === "trie3",
 			trie4: format === "trie4"
@@ -1206,34 +1226,45 @@ async function compileTarget(target, options, compileOptions) {
 			generateNonStrict,
 			dictionaryDirectives,
 			removeDuplicates: removeDuplicates$1
-		})));
-		for (const compress$1 of genSet) await createTargetFile(dst, data, compress$1);
+		}))), compress$1);
 	}
 	await processFiles({
 		action,
 		filesToProcess,
 		mergeTarget: filename
 	});
-	if (target.bTrie) await generateBTrieFromFile(filename, {
-		compress: true,
-		optimize: true,
-		useStringTable: true,
-		...typeof target.bTrie === "object" ? target.bTrie : {}
-	});
-	logWithTimestamp(`Done compile: ${target.name}`);
 	return deps;
 }
-function calculateDependencies(targetFile, filesToProcess, extraDependencyFiles, rootDir) {
+async function compressDictionaryFileIfNeeded(buildOptions) {
+	const { filename, generateCompressed, generateOnlyCompressedDictionary } = buildOptions;
+	if (generateOnlyCompressedDictionary || !generateCompressed) return [];
+	logWithTimestamp(`Compress: ${filename}`);
+	return [filename, await compressFile(filename)];
+}
+async function genBTrieForTarget(target, buildOptions) {
+	if (!target.bTrie) return [];
+	const cfg = typeof target.bTrie === "object" ? target.bTrie : {};
+	const { filename, generateOnlyCompressedDictionary } = buildOptions;
+	const srcFilename = filename + (generateOnlyCompressedDictionary ? ".gz" : "");
+	logWithTimestamp(`Generate BTrie from: ${srcFilename}`);
+	return [srcFilename, await generateBTrieFromFile(srcFilename, {
+		compress: cfg.compress ?? true,
+		optimize: cfg.optimize ?? true,
+		useStringTable: cfg.useStringTable ?? true,
+		logger: logWithTimestamp
+	})];
+}
+function calculateDependencies(targetFile, filesToProcess, extraDependencyFiles, checksumRoot) {
 	const dependencies = /* @__PURE__ */ new Set();
 	addDependency(targetFile);
 	extraDependencyFiles?.forEach((f) => addDependency(f));
 	filesToProcess.forEach((f) => addDependency(f.src));
 	return dependencies;
 	function addDependency(filename) {
-		const rel$1 = path.relative(rootDir, filename);
-		dependencies.add(rel$1);
-		dependencies.add(rel$1.replace(/\.aff$/, ".dic"));
-		dependencies.add(rel$1.replace(/\.dic$/, ".aff"));
+		const abs = path.resolve(checksumRoot, filename);
+		dependencies.add(abs);
+		dependencies.add(abs.replace(/\.aff$/, ".dic"));
+		dependencies.add(abs.replace(/\.dic$/, ".aff"));
 	}
 }
 function rel(filePath) {
@@ -1356,6 +1387,9 @@ function createExcludeRegexFilter(excludeWordsMatchingRegex) {
 function iterableToString(iter) {
 	return Array.isArray(iter) ? iter.join("") : [...iter].join("");
 }
+function addToSet(set, ...sources) {
+	for (const items of sources) for (const item of items) set.add(item);
+}
 
 //#endregion
 //#region src/build.ts
@@ -1400,4 +1434,4 @@ function normalizeRequest(buildInfo, root) {
 
 //#endregion
 export { reportCheckChecksumFile as a, toError as c, compressFile as d, logWithTimestamp as i, generateBTrie as l, compile as n, reportChecksumForFiles as o, setLogger as r, updateChecksumForFiles as s, build as t, OSFlags as u };
-//# sourceMappingURL=build-OgMPaXPZ.mjs.map
+//# sourceMappingURL=build-Dxf6sFCy.mjs.map

package/dist/index.d.mts

@@ -9,10 +9,14 @@ interface BTrieOptions {
   useStringTable?: boolean | undefined;
 }
 //#endregion
+//#region src/compiler/logger.d.ts
+type Logger = (message?: any, ...optionalParams: any[]) => void;
+//#endregion
 //#region src/compiler/bTrie.d.ts
 interface GenerateBTrieOptions extends BTrieOptions {
   /** output directory */
   output?: string;
+  logger?: Logger;
 }
 //#endregion
 //#region src/bTrie.d.ts

package/dist/index.mjs

@@ -1,3 +1,3 @@
-import { l as generateBTrie, t as build } from "./build-OgMPaXPZ.mjs";
+import { l as generateBTrie, t as build } from "./build-Dxf6sFCy.mjs";
 
 export { build, generateBTrie };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cspell/cspell-tools",
-  "version": "9.6.0",
+  "version": "9.6.2",
   "description": "Tools to assist with the development of cSpell",
   "publishConfig": {
     "access": "public",
@@ -64,12 +64,12 @@
   },
   "homepage": "https://github.com/streetsidesoftware/cspell/tree/main/packages/cspell-tools#readme",
   "dependencies": {
-    "@cspell/cspell-pipe": "9.6.0",
+    "@cspell/cspell-pipe": "9.6.2",
     "commander": "^14.0.2",
     "cosmiconfig": "9.0.0",
-    "cspell-trie-lib": "9.6.0",
+    "cspell-trie-lib": "9.6.2",
     "glob": "^13.0.0",
-    "hunspell-reader": "9.6.0",
+    "hunspell-reader": "9.6.2",
     "yaml": "^2.8.2"
   },
   "engines": {
@@ -80,5 +80,5 @@
     "ts-json-schema-generator": "^2.4.0"
   },
   "module": "bin.mjs",
-  "gitHead": "163793ddf2a0ad90bc7c90351698a106003297af"
+  "gitHead": "646e18a04ff36d43f78a74e5055540e0f5297e91"
 }