fix: support globs with gzip command. (#4625)

packages/cspell-tools/package.json

@@ -51,11 +51,11 @@
   "homepage": "https://github.com/streetsidesoftware/cspell#readme",
   "dependencies": {
     "@cspell/cspell-pipe": "workspace:*",
-    "commander": "^10.0.1",
+    "commander": "^11.0.0",
     "cosmiconfig": "8.0.0",
     "cspell-trie-lib": "workspace:*",
     "gensequence": "^5.0.2",
-    "glob": "^8.1.0",
+    "glob": "^10.3.3",
     "hunspell-reader": "workspace:*"
   },
   "engines": {

packages/cspell-tools/src/app.test.ts

@@ -221,10 +221,11 @@ describe('Validate the application', () => {
 
     test('app gzip', async () => {
         const commander = getCommander();
-        const args = argv('gzip', 'README.md', 'package.json');
+        const args = argv('gzip', '*.md', 'package.json');
 
         await expect(app.run(commander, args)).resolves.toBeUndefined();
         expect(mockedCompressFile).toHaveBeenCalledWith('README.md');
+        expect(mockedCompressFile).toHaveBeenCalledWith('CHANGELOG.md');
         expect(mockedCompressFile).toHaveBeenCalledWith('package.json');
     });
 });

packages/cspell-tools/src/app.ts

@@ -10,7 +10,7 @@ import { processCompileAction } from './compile.js';
 import * as compiler from './compiler/index.js';
 import { logWithTimestamp } from './compiler/logWithTimestamp.js';
 import type { FeatureFlags } from './FeatureFlags/index.js';
-import { compressFile } from './gzip/index.js';
+import { gzip } from './gzip/index.js';
 import { reportCheckChecksumFile, reportChecksumForFiles } from './shasum/shasum.js';
 import { toError } from './util/errors.js';
 
@@ -53,14 +53,12 @@ interface ShasumOptions {
 }
 
 export async function run(program: program.Command, argv: string[], flags?: FeatureFlags): Promise<void> {
-    async function gzip(files: string[]): Promise<void> {
-        for (const fileName of files) {
-            try {
-                await compressFile(fileName);
-            } catch (error) {
-                const err = toError(error);
-                program.error(err.message);
-            }
+    async function handleGzip(files: string[]): Promise<void> {
+        try {
+            await gzip(files);
+        } catch (error) {
+            const err = toError(error);
+            program.error(err.message);
         }
     }
 
@@ -103,7 +101,7 @@ export async function run(program: program.Command, argv: string[], flags?: Feat
         .option('-r, --root <directory>', 'Specify the run directory')
         .action(build);
 
-    program.command('gzip <files...>').description('GZip files while keeping the original.').action(gzip);
+    program.command('gzip <files...>').description('GZip files while keeping the original.').action(handleGzip);
 
     program
         .command('shasum [files...]')

packages/cspell-tools/src/compile.ts

@@ -3,9 +3,9 @@ import { opConcatMap, pipe } from '@cspell/cspell-pipe/sync';
 import type { CompileCommonAppOptions } from './AppOptions.js';
 import { compile } from './compiler/compile.js';
 import { createCompileRequest } from './compiler/createCompileRequest.js';
-import { globP } from './compiler/globP.js';
 import type { FeatureFlags } from './FeatureFlags/index.js';
 import { getSystemFeatureFlags, parseFlags } from './FeatureFlags/index.js';
+import { globP } from './util/globP.js';
 
 getSystemFeatureFlags().register('compound', 'Enable compound dictionary sources.');
 

packages/cspell-tools/src/gzip/gzip.ts

@@ -0,0 +1,11 @@
+import { globP } from '../util/globP.js';
+import { compressFile } from './compressFiles.js';
+
+// cspell:ignore nodir
+
+export async function gzip(globs: string[]): Promise<void> {
+    const files = await globP(globs, { nodir: true });
+    for (const fileName of files) {
+        await compressFile(fileName);
+    }
+}

packages/cspell-tools/src/gzip/index.ts

@@ -1 +1,2 @@
 export { compressFile } from './compressFiles.js';
+export { gzip } from './gzip.js';

packages/cspell-tools/src/util/globP.ts

@@ -0,0 +1,12 @@
+import { glob } from 'glob';
+
+interface Options {
+    cwd?: string | URL;
+    nodir?: boolean; // cspell:ignore nodir
+}
+
+export function globP(pattern: string | string[], options?: Options): Promise<string[]> {
+    // Convert windows separators.
+    const globs = (Array.isArray(pattern) ? pattern : [pattern]).map((pattern) => pattern.replace(/\\/g, '/'));
+    return glob(globs, options);
+}