feat: Allow RegExp for ignoreEntries (#318)

Author: ffflorian

README.md

@@ -59,7 +59,7 @@ The structure of the configuration file is the following:
   force?: boolean;
 
   /** Ignore entries (e.g. `*.js.map`). */
-  ignoreEntries?: string[];
+  ignoreEntries?: Array<string | RegExp>;
 
   /** Add or extract files. */
   mode: 'add' | 'extract';

config-examples/.jsziprc.example.js

@@ -5,10 +5,11 @@ module.exports = {
   ],
   force: true,
   ignoreEntries: [
-    '*.map'
+    '*.map',
+    new RegExp('\\.html?$')
   ],
   mode: 'extract',
-  outputEntry: 'dist2/',
+  outputEntry: 'dist/',
   quiet: false,
   verbose: false,
 };

spec/BuildService.test.ts

@@ -55,4 +55,25 @@ describe('BuildService', () => {
     expect(buildService['addFile']).not.toHaveBeenCalledWith(jasmine.objectContaining({zipPath: 'b.js.map'}));
     expect(buildService['fileService'].writeFile).toHaveBeenCalledTimes(1);
   });
+
+  it('allows RegExp usage for ignoreEntries', async () => {
+    jsZipCLI = new JSZipCLI({
+      ignoreEntries: [/.*\.map/],
+      outputEntry: 'file.zip',
+      quiet: true,
+      verbose: false,
+    });
+    const files = ['a.js', 'b.js', 'b.js.map'];
+    const buildService = jsZipCLI.add(files);
+
+    addDefaultSpies(buildService);
+
+    const {compressedFilesCount} = await jsZipCLI.save();
+    expect(compressedFilesCount).toBe(2);
+
+    expect(buildService['addFile']).toHaveBeenCalledWith(jasmine.objectContaining({zipPath: 'a.js'}));
+    expect(buildService['addFile']).toHaveBeenCalledWith(jasmine.objectContaining({zipPath: 'b.js'}));
+    expect(buildService['addFile']).not.toHaveBeenCalledWith(jasmine.objectContaining({zipPath: 'b.js.map'}));
+    expect(buildService['fileService'].writeFile).toHaveBeenCalledTimes(1);
+  });
 });

src/BuildService.ts

@@ -27,7 +27,9 @@ export class BuildService {
     });
     this.logger.state = {isEnabled: options.verbose};
     this.entries = [];
-    this.ignoreEntries = this.options.ignoreEntries.map(entry => new RegExp(entry.replace('*', '.*')));
+    this.ignoreEntries = this.options.ignoreEntries.map(entry =>
+      entry instanceof RegExp ? entry : new RegExp(entry.replace('*', '.*'))
+    );
     this.outputFile = this.options.outputEntry ? path.resolve(this.options.outputEntry) : null;
     this.progressBar = new progress('Compressing [:bar] :percent :elapseds', {
       complete: '=',

src/interfaces.ts

@@ -8,7 +8,7 @@ export interface TerminalOptions {
   /** Force overwriting files and directories when extracting (default: false). */
   force?: boolean;
   /** Ignore entries (e.g. `*.js.map`). */
-  ignoreEntries?: string[];
+  ignoreEntries?: Array<string | RegExp>;
   /** Set the output directory (default: stdout). */
   outputEntry?: string | null;
   /** Don't log anything excluding errors (default: false). */