@cspell/cspell-tools 7.3.0 → 7.3.2

package/dist/app.js

@@ -5,7 +5,7 @@ import { build } from './build.js';
 import { processCompileAction } from './compile.js';
 import * as compiler from './compiler/index.js';
 import { logWithTimestamp } from './compiler/logWithTimestamp.js';
-import { gzip } from './gzip/index.js';
+import { gzip, OSFlags } from './gzip/index.js';
 import { reportCheckChecksumFile, reportChecksumForFiles, updateChecksumForFiles } from './shasum/shasum.js';
 import { toError } from './util/errors.js';
 const npmPackageRaw = readFileSync(new URL('../package.json', import.meta.url), 'utf8');
@@ -34,7 +34,7 @@ function addCompileOptions(compileCommand) {
 export async function run(program, argv, flags) {
     async function handleGzip(files) {
         try {
-            await gzip(files);
+            await gzip(files, OSFlags.Unix);
         }
         catch (error) {
             const err = toError(error);

package/dist/compiler/readers/readTextFile.js

@@ -1,17 +1,19 @@
+import assert from 'assert';
 import { promises as fs } from 'fs';
-import { promisify } from 'util';
-import * as zlib from 'zlib';
-const gunzip = promisify(zlib.gunzip);
+import { decompress } from '../../gzip/index.js';
 const isGzFile = /\.gz$/;
 export function readTextFile(filename) {
     const content = fs
         .readFile(filename)
-        .then((buffer) => (isGzFile.test(filename) ? gunzip(buffer) : buffer))
-        .then((buffer) => buffer.toString('utf8'));
+        .then(async (buffer) => (isGzFile.test(filename) ? decompress(buffer) : buffer))
+        .then((buffer) => (assertIsBuffer(buffer), buffer.toString('utf8')));
     return content;
 }
 export async function readTextFileLines(filename) {
     const content = await readTextFile(filename);
     return content.split('\n');
 }
+function assertIsBuffer(value) {
+    assert(Buffer.isBuffer(value));
+}
 //# sourceMappingURL=readTextFile.js.map

package/dist/compiler/writeTextToFile.js

@@ -1,12 +1,10 @@
 import { promises as fs } from 'fs';
-import { promisify } from 'util';
-import * as zlib from 'zlib';
-const gzip = promisify(zlib.gzip);
+import { compress } from '../gzip/index.js';
 const isGzFile = /\.gz$/;
 export async function writeTextToFile(filename, data) {
     const useGz = isGzFile.test(filename);
     const buf = Buffer.from(data, 'utf-8');
-    const buffer = useGz ? await gzip(buf) : buf;
+    const buffer = useGz ? await compress(buf) : buf;
     await fs.writeFile(filename, buffer);
 }
 export function writeTextLinesToFile(filename, lines) {

package/dist/gzip/compressFiles.d.ts

@@ -1,2 +1,16 @@
-export declare function compressFile(file: string): Promise<string>;
+/// <reference types="node" resolution-mode="require"/>
+export declare enum OSFlags {
+    auto = -1,
+    FAT = 0,
+    Unix = 3,
+    HPFS = 6,
+    MACOS = 7,
+    NTFS = 11
+}
+export declare function compressFile(file: string, os?: OSFlags): Promise<string>;
+export declare function compress(buf: string | Uint8Array | Buffer, os?: OSFlags): Promise<Uint8Array>;
+export declare function compressSync(buf: string | Uint8Array | Buffer, os?: OSFlags): Uint8Array;
+export declare function decompress(buf: Uint8Array | Buffer, encoding?: undefined): Promise<Uint8Array>;
+export declare function decompress(buf: Uint8Array | Buffer, encoding: 'utf8'): Promise<string>;
+export declare function decompress(buf: Uint8Array | Buffer, encoding: 'utf8' | undefined): Promise<string | Uint8Array>;
 //# sourceMappingURL=compressFiles.d.ts.map

package/dist/gzip/compressFiles.js

@@ -1,14 +1,42 @@
 import { readFile, writeFile } from 'node:fs/promises';
 import { promisify } from 'node:util';
-import { gzip as gz } from 'node:zlib';
+import { gunzip as gunzipCB, gzip as gz, gzipSync } from 'node:zlib';
 const gzip = promisify(gz);
-export async function compressFile(file) {
+const gunzip = promisify(gunzipCB);
+export var OSFlags;
+(function (OSFlags) {
+    OSFlags[OSFlags["auto"] = -1] = "auto";
+    OSFlags[OSFlags["FAT"] = 0] = "FAT";
+    OSFlags[OSFlags["Unix"] = 3] = "Unix";
+    OSFlags[OSFlags["HPFS"] = 6] = "HPFS";
+    OSFlags[OSFlags["MACOS"] = 7] = "MACOS";
+    OSFlags[OSFlags["NTFS"] = 11] = "NTFS";
+})(OSFlags || (OSFlags = {}));
+// https://docs.fileformat.com/compression/gz/#:~:text=A%20GZ%20file%20is%20a,compression%20formats%20on%20UNIX%20systems.
+const OSSystemIDOffset = 9;
+export async function compressFile(file, os) {
     if (file.endsWith('.gz'))
         return file;
     const targetFile = file + '.gz';
-    const buf = await readFile(file);
-    const zBuf = await gzip(buf);
+    const zBuf = await compress(await readFile(file), os);
     await writeFile(targetFile, zBuf);
     return targetFile;
 }
+export async function compress(buf, os) {
+    return fixOSSystemID(await gzip(buf), os);
+}
+export function compressSync(buf, os) {
+    return fixOSSystemID(gzipSync(buf), os);
+}
+function fixOSSystemID(zBuf, os = OSFlags.Unix) {
+    const osFlag = os == OSFlags.auto ? zBuf[OSSystemIDOffset] : os;
+    zBuf[OSSystemIDOffset] = osFlag;
+    return zBuf;
+}
+export async function decompress(buf, encoding) {
+    const dBuf = gunzip(buf);
+    if (!encoding)
+        return dBuf;
+    return (await dBuf).toString(encoding);
+}
 //# sourceMappingURL=compressFiles.js.map

package/dist/gzip/gzip.d.ts

@@ -1,2 +1,3 @@
-export declare function gzip(globs: string[]): Promise<void>;
+import type { OSFlags } from './compressFiles.js';
+export declare function gzip(globs: string[], os?: OSFlags): Promise<void>;
 //# sourceMappingURL=gzip.d.ts.map

package/dist/gzip/gzip.js

@@ -1,10 +1,10 @@
 import { globP } from '../util/globP.js';
 import { compressFile } from './compressFiles.js';
 // cspell:ignore nodir
-export async function gzip(globs) {
+export async function gzip(globs, os) {
     const files = await globP(globs, { nodir: true });
     for (const fileName of files) {
-        await compressFile(fileName);
+        await compressFile(fileName, os);
     }
 }
 //# sourceMappingURL=gzip.js.map

package/dist/gzip/index.d.ts

@@ -1,3 +1,3 @@
-export { compressFile } from './compressFiles.js';
+export { compress, compressFile, decompress, OSFlags } from './compressFiles.js';
 export { gzip } from './gzip.js';
 //# sourceMappingURL=index.d.ts.map

package/dist/gzip/index.js

@@ -1,3 +1,3 @@
-export { compressFile } from './compressFiles.js';
+export { compress, compressFile, decompress, OSFlags } from './compressFiles.js';
 export { gzip } from './gzip.js';
 //# sourceMappingURL=index.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cspell/cspell-tools",
-  "version": "7.3.0",
+  "version": "7.3.2",
   "description": "Tools to assist with the development of cSpell",
   "publishConfig": {
     "access": "public"
@@ -48,13 +48,13 @@
   },
   "homepage": "https://github.com/streetsidesoftware/cspell#readme",
   "dependencies": {
-    "@cspell/cspell-pipe": "7.3.0",
+    "@cspell/cspell-pipe": "7.3.2",
     "commander": "^11.0.0",
     "cosmiconfig": "8.0.0",
-    "cspell-trie-lib": "7.3.0",
+    "cspell-trie-lib": "7.3.2",
     "gensequence": "^5.0.2",
     "glob": "^10.3.4",
-    "hunspell-reader": "7.3.0",
+    "hunspell-reader": "7.3.2",
     "yaml": "^2.3.2"
   },
   "engines": {
@@ -68,5 +68,5 @@
     "ts-json-schema-generator": "^1.3.0"
   },
   "module": "bin.mjs",
-  "gitHead": "4a16b099b64c5b55645529a4ae79bc32aaf0fc8e"
+  "gitHead": "71d88d4e4d2252124a952c78d4fc03ce0a6d67e3"
 }