@teamscale/javascript-instrumenter 1.0.0-beta.6 → 1.0.0-beta.7

package/dist/src/instrumenter/Task.js

@@ -8,52 +8,32 @@ exports.createCollectorSpecifier = createCollectorSpecifier;
 const commons_1 = require("@cqse/commons");
 const micromatch_1 = __importDefault(require("micromatch"));
 const RelativeCollectorPatternParser_1 = require("./RelativeCollectorPatternParser");
-/**
- * An abstract source map type.
- */
 class SourceMapReference {
 }
 exports.SourceMapReference = SourceMapReference;
-/**
- * One element of an instrumentation task.
- * It corresponds to instrumenting a single file.
- */
 class TaskElement {
+    fromFile;
+    toFile;
+    externalSourceMapFile;
     constructor(fromFile, toFile, externalSourceMap) {
         this.fromFile = commons_1.Contract.requireDefined(fromFile);
         this.toFile = commons_1.Contract.requireDefined(toFile);
         this.externalSourceMapFile = externalSourceMap;
     }
-    /**
-     * Is it an in-place instrumentation task?
-     */
     isInPlace() {
-        // We assume that different file names link to different files on the storage
-        // and abstract from the fact that it might be a symlink.
         return this.fromFile === this.toFile;
     }
 }
 exports.TaskElement = TaskElement;
-/**
- * Given a command-line URL and an optional relative pattern, create a specifier for how the vaccine can
- * locate the connector.
- *
- * If a relative pattern is given, it is preferred, since the command-line interface always provides a URL
- * (the default URL in case the user didn't explicitly specify one).
- */
 function createCollectorSpecifier(commandLineUrl, relativePattern) {
     if (relativePattern !== undefined) {
         return RelativeCollectorPatternParser_1.RelativeCollectorPatternParser.parse(relativePattern);
     }
     return parseCommandLineUrl(commandLineUrl);
 }
-/**
- * Parses, validates and normalizes the given URL that the user provided on the command-line.
- */
 function parseCommandLineUrl(commandLineUrl) {
     let url;
     if (commandLineUrl.indexOf('://') > 0) {
-        // A trailing slash will be removed
         url = commandLineUrl.replace(/\/$/, '');
     }
     else {
@@ -67,22 +47,17 @@ function parseCommandLineUrl(commandLineUrl) {
         url,
     };
 }
-/**
- * Configuration used to match paths with `micromatch`.
- */
 const MATCHER_OPTIONS = {
     basename: false,
     lookbehinds: true,
     noglobstar: false
 };
-/**
- * Patterns that define which parts of a given bundle to instrument or not.
- *
- * The patterns describe a set of filenames that can be found in the origin,
- * that is, before conducting all the transpilation steps. The source maps
- * are used to determine the original file names.
- */
 class OriginSourcePattern {
+    include;
+    exclude;
+    includeMatches;
+    excludeMatches;
+    neitherExcludedNorIncluded;
     constructor(include, exclude) {
         this.include = normalizePatterns(include);
         this.exclude = normalizePatterns(exclude);
@@ -90,18 +65,6 @@ class OriginSourcePattern {
         this.excludeMatches = new Set();
         this.neitherExcludedNorIncluded = new Set();
     }
-    /**
-     * Does the given pattern require to include the given file?
-     *
-     * For example, a JavaScript bundle is compiled from several (origin) source files.
-     * If one of the files in the bundle is needed, then the full bundle is needed, that is,
-     * this function is required to return `true`.
-     *
-     * @param originFile - The file to decide for include or exclude.
-     *
-     * @returns `false` if (1) the given file is supposed to be excluded,
-     *   or (2) `true` if the given file is supposed to be included.
-     */
     isIncluded(originFile) {
         if (originFile.length === 0) {
             return true;
@@ -127,55 +90,33 @@ class OriginSourcePattern {
         this.neitherExcludedNorIncluded.add(normalizedOriginFile);
         return true;
     }
-    /**
-     * Variant of `isIncluded` working on a list of files to check.
-     * (Primarily, used for testing.)
-     */
     isAnyIncluded(originFiles) {
         return originFiles.find(value => this.isIncluded(value)) !== undefined;
     }
-    /**
-     * Retrieve the file names that have been matching the different patterns.
-     */
     retrieveMatchingFiles() {
-        var _a, _b;
         return {
-            includePatterns: (_a = this.include) !== null && _a !== void 0 ? _a : [],
-            excludePatterns: (_b = this.exclude) !== null && _b !== void 0 ? _b : [],
+            includePatterns: this.include ?? [],
+            excludePatterns: this.exclude ?? [],
             excludeMatches: [...this.excludeMatches],
             includeMatches: [...this.includeMatches],
             neitherExcludedNorIncluded: [...this.neitherExcludedNorIncluded]
         };
     }
-    /**
-     * Returns if include/exclude patterns are specified.
-     */
     patternsSpecified() {
         return this.include !== undefined || this.exclude !== undefined;
     }
 }
 exports.OriginSourcePattern = OriginSourcePattern;
-/**
- * Pattern describing files (bundles) to not instrument.
- */
 class FileExcludePattern {
+    exclude;
     constructor(exclude) {
-        var _a;
-        this.exclude = (_a = normalizePatterns(exclude)) !== null && _a !== void 0 ? _a : [];
+        this.exclude = normalizePatterns(exclude) ?? [];
     }
-    /**
-     * Return `true` if the given `filePath` is matched by any of the patterns in `exclude`.
-     */
     isExcluded(filePath) {
         return micromatch_1.default.isMatch(normalizePath(filePath), this.exclude);
     }
 }
 exports.FileExcludePattern = FileExcludePattern;
-/**
- * Normalizes all patterns (normally either include or exclude patterns), and returns all
- * valid normalized patterns. Returns undefined if the patterns list is undefined, or all
- * items inside the list are undefined.
- */
 function normalizePatterns(patterns) {
     if (patterns === undefined || patterns.length === 0) {
         return undefined;
@@ -192,16 +133,11 @@ function normalizeGlobPattern(pattern) {
     if (!pattern) {
         return pattern;
     }
-    // This should be in line with the logic in `normalizePath`.
     return removeTrailingDirectoryTraversals(removeTrailingCurrentWorkingDir(pattern));
 }
 function normalizePath(toNormalize) {
-    // This should be in line with the logic in `normalizeGlobPattern`.
     return removeTrailingDirectoryTraversals(removeTrailingCurrentWorkingDir(toNormalize.replace(/\\/g, '/')));
 }
-/**
- * `micromatch` cannot deal with leading `../`, so we remove those.
- */
 function removeTrailingDirectoryTraversals(toNormalize) {
     let result = toNormalize;
     while (result.startsWith("../")) {
@@ -218,10 +154,14 @@ function removePrefix(prefix, removeFrom) {
     }
     return removeFrom;
 }
-/**
- * The actual instrumentation task.
- */
 class InstrumentationTask {
+    collector;
+    targetBucket;
+    _elements;
+    originSourcePattern;
+    excludeFilesPattern;
+    dumpOriginsFile;
+    dumpMatchedOriginsFile;
     constructor(collector, targetBucket, elements, excludeFilesPattern, originSourcePattern, dumpOriginsFile, dumpMatchedOriginsFile) {
         this.collector = commons_1.Contract.requireDefined(collector);
         this.targetBucket = commons_1.Contract.requireDefined(targetBucket);
@@ -231,20 +171,20 @@ class InstrumentationTask {
         this.dumpOriginsFile = dumpOriginsFile;
         this.dumpMatchedOriginsFile = dumpMatchedOriginsFile;
     }
-    /**
-     * @returns the elements of the task.
-     */
     get elements() {
-        // Ensure immutability of this object by returning a copy
-        // of the list of immutable objects.
         return this._elements.slice();
     }
 }
 exports.InstrumentationTask = InstrumentationTask;
-/**
- * A summary of executing the instrumentation task.
- */
 class TaskResult {
+    translated;
+    excluded;
+    translatedFromCache;
+    alreadyInstrumented;
+    unsupported;
+    failed;
+    warnings;
+    task;
     constructor(translated, excluded, translatedFromCache, alreadyInstrumented, unsupported, failed, warnings, task) {
         commons_1.Contract.require(translated > -1);
         commons_1.Contract.require(excluded > -1);
@@ -262,45 +202,24 @@ class TaskResult {
         this.warnings = warnings;
         this.task = task;
     }
-    /**
-     * Returns the sum of the present task results and the given one.
-     *
-     * @param incBy - The task result to add (as delta).
-     */
     withIncrement(incBy) {
-        var _a;
-        return new TaskResult(this.translated + incBy.translated, this.excluded + incBy.excluded, this.translatedFromCache + incBy.translatedFromCache, this.alreadyInstrumented + incBy.alreadyInstrumented, this.unsupported + incBy.unsupported, this.failed + incBy.failed, this.warnings + incBy.warnings, (_a = this.task) !== null && _a !== void 0 ? _a : incBy.task);
+        return new TaskResult(this.translated + incBy.translated, this.excluded + incBy.excluded, this.translatedFromCache + incBy.translatedFromCache, this.alreadyInstrumented + incBy.alreadyInstrumented, this.unsupported + incBy.unsupported, this.failed + incBy.failed, this.warnings + incBy.warnings, this.task ?? incBy.task);
     }
-    /**
-     * @returns the neutral task element (adding it with {@code withIncrement} does not change the result).
-     */
     static neutral(task) {
         return new TaskResult(0, 0, 0, 0, 0, 0, 0, task);
     }
-    /**
-     * @returns a task result signaling one error.
-     *
-     * @param e - The error to add.
-     */
     static error(e) {
         console.error(e);
         return new TaskResult(0, 0, 0, 0, 0, 1, 0);
     }
-    /**
-     * @returns a task result signaling one warning.
-     *
-     * @param msg - The warning message to add.
-     */
     static warning(msg) {
         console.warn(msg);
         return new TaskResult(0, 0, 0, 0, 0, 0, 1);
     }
 }
 exports.TaskResult = TaskResult;
-/**
- * A source map in an external file.
- */
 class SourceMapFileReference extends SourceMapReference {
+    sourceMapFilePath;
     constructor(sourceMapFilePath) {
         super();
         this.sourceMapFilePath = sourceMapFilePath;

package/dist/src/instrumenter/TaskBuilder.d.ts

@@ -1,75 +1,25 @@
 import { InstrumentationTask, SourceMapReference } from './Task';
 import { InstrumenterOptions } from './InstrumenterConfig';
-/**
- * A builder for an instrumentation task.
- */
 export declare class TaskBuilder {
-    /** The elements of the instrumentation task. */
     private readonly elements;
-    /** The collector to send the coverage to. */
     private collector;
-    /** Origin include patterns. */
     private originSourceIncludePatterns;
-    /** Origin exclude patters. */
     private originSourceExcludePatterns;
-    /** Bundle exclude patters. */
     private bundleFileExcludePatterns;
-    /**
-     * File path where all origins from the source map should be dumped in JSON format,
-     * or undefined if no origins should be dumped */
     private dumpOriginsFile;
-    /**
-     * File path where the matched origin file names are stored as JSON,
-     * `undefined` if this information should not be dumped.
-     */
     private dumpMatchedOriginsFile;
-    /**
-     * The bucket within the collector the coverage is supposed to be sent to.
-     */
     private targetBucket;
-    /**
-     * The automatically generated unique app id to use.
-     */
     private appId;
     constructor();
-    /** Set the collector specification based on the command-line arguments. */
     setCollectorFromCommandLine(commandLineUrl: string, relativePattern?: string): this;
-    /** Set the coverage bucket to be used within the collector. */
     setCollectorTargetBucket(configId: string | undefined, commit: string, configOptions?: string, appName?: string): this;
-    /** Set the origin include pattern. If multiple patterns are present, concatenates them via the OR operator.  */
     setOriginSourceIncludePatterns(patterns: string[] | undefined): this;
-    /** Set the origin exclude pattern(s). If multiple patterns are present, concatenates them via the OR operator. */
     setOriginSourceExcludePatterns(patterns: string[] | undefined): this;
-    /** Sets the file bundle exclude pattern. If multiple patterns are present, concatenates them via the OR operator. */
     setBundleExcludePatterns(patterns: string[] | undefined): this;
-    /** Add a task element */
     addElement(fromFilePath: string, toFilePath: string, fromFileSourceMap?: SourceMapReference): this;
-    /**
-     * Add the task details based on a configuration (command line arguments).
-     *
-     * @param config - The configuration based on that the task is built.
-     */
     addFromConfig(config: InstrumenterOptions): this;
-    /**
-     * Adds instrumentation tasks based on a given pattern `inputs` describing the set of
-     * input files and produces the output files in the specified output folder `target.
-     *
-     * @param inputs - Glob pattern describing set of input files
-     * @param target - Target folder
-     * @param sourceMapInfo - Source map file for all the input files.
-     */
     private addInstrumentationTasksFromPatternWithTarget;
-    /**
-     * Adds in-place instrumentation tasks for the set of files described
-     * by the `inputs` pattern.
-     *
-     * @param inputs - Glob pattern.
-     * @param sourceMapInfo - Source map for the files described by the pattern.
-     */
     private addInPlaceTasksFromPattern;
-    /**
-     * Build the instrumentation task.
-     */
     build(): InstrumentationTask;
 }
 //# sourceMappingURL=TaskBuilder.d.ts.map

package/dist/src/instrumenter/TaskBuilder.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"TaskBuilder.d.ts","sourceRoot":"","sources":["../../../src/instrumenter/TaskBuilder.ts"],"names":[],"mappings":"AAAA,OAAO,EAEN,mBAAmB,EAGnB,kBAAkB,EAGlB,MAAM,QAAQ,CAAC;AAYhB,OAAO,EAAE,mBAAmB,EAAE,MAAM,sBAAsB,CAAC;AAoB3D;;GAEG;AACH,qBAAa,WAAW;IACvB,gDAAgD;IAChD,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAgB;IAEzC,6CAA6C;IAC7C,OAAO,CAAC,SAAS,CAA4B;IAE7C,+BAA+B;IAC/B,OAAO,CAAC,2BAA2B,CAAuB;IAE1D,8BAA8B;IAC9B,OAAO,CAAC,2BAA2B,CAAuB;IAE1D,8BAA8B;IAC9B,OAAO,CAAC,yBAAyB,CAAuB;IAExD;;qDAEiD;IACjD,OAAO,CAAC,eAAe,CAAqB;IAE5C;;;OAGG;IACH,OAAO,CAAC,sBAAsB,CAAqB;IAEnD;;OAEG;IACH,OAAO,CAAC,YAAY,CAAiC;IAErD;;OAEG;IACH,OAAO,CAAC,KAAK,CAAS;;IAStB,2EAA2E;IAC3E,2BAA2B,CAAC,cAAc,EAAE,MAAM,EAAE,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI;IAMnF,+DAA+D;IAC/D,wBAAwB,CAAC,QAAQ,EAAE,MAAM,GAAG,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,MAAM,EACtF,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI;IAO9B,gHAAgH;IAChH,8BAA8B,CAAC,QAAQ,EAAE,MAAM,EAAE,GAAG,SAAS,GAAG,IAAI;IAKpE,kHAAkH;IAClH,8BAA8B,CAAC,QAAQ,EAAE,MAAM,EAAE,GAAG,SAAS,GAAG,IAAI;IAKpE,qHAAqH;IACrH,wBAAwB,CAAC,QAAQ,EAAE,MAAM,EAAE,GAAG,SAAS,GAAG,IAAI;IAK9D,yBAAyB;IACzB,UAAU,CAAC,YAAY,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,iBAAiB,CAAC,EAAE,kBAAkB,GAAG,IAAI;IAKlG;;;;OAIG;IACH,aAAa,CAAC,MAAM,EAAE,mBAAmB,GAAG,IAAI;IAuChD;;;;;;;OAOG;IACH,OAAO,CAAC,4CAA4C;IAgCpD;;;;;;OAMG;IACH,OAAO,CAAC,0BAA0B;IASlC;;OAEG;IACI,KAAK,IAAI,mBAAmB;CAWnC"}
+{"version":3,"file":"TaskBuilder.d.ts","sourceRoot":"","sources":["../../../src/instrumenter/TaskBuilder.ts"],"names":[],"mappings":"AAAA,OAAO,EAEN,mBAAmB,EAGnB,kBAAkB,EAGlB,MAAM,QAAQ,CAAC;AAYhB,OAAO,EAAE,mBAAmB,EAAE,MAAM,sBAAsB,CAAC;AAuB3D,qBAAa,WAAW;IAEvB,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAgB;IAGzC,OAAO,CAAC,SAAS,CAA4B;IAG7C,OAAO,CAAC,2BAA2B,CAAuB;IAG1D,OAAO,CAAC,2BAA2B,CAAuB;IAG1D,OAAO,CAAC,yBAAyB,CAAuB;IAKxD,OAAO,CAAC,eAAe,CAAqB;IAM5C,OAAO,CAAC,sBAAsB,CAAqB;IAKnD,OAAO,CAAC,YAAY,CAAiC;IAKrD,OAAO,CAAC,KAAK,CAAS;;IAUtB,2BAA2B,CAAC,cAAc,EAAE,MAAM,EAAE,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI;IAOnF,wBAAwB,CAAC,QAAQ,EAAE,MAAM,GAAG,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,MAAM,EACtF,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI;IAQ9B,8BAA8B,CAAC,QAAQ,EAAE,MAAM,EAAE,GAAG,SAAS,GAAG,IAAI;IAMpE,8BAA8B,CAAC,QAAQ,EAAE,MAAM,EAAE,GAAG,SAAS,GAAG,IAAI;IAMpE,wBAAwB,CAAC,QAAQ,EAAE,MAAM,EAAE,GAAG,SAAS,GAAG,IAAI;IAM9D,UAAU,CAAC,YAAY,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,iBAAiB,CAAC,EAAE,kBAAkB,GAAG,IAAI;IAUlG,aAAa,CAAC,MAAM,EAAE,mBAAmB,GAAG,IAAI;IA+ChD,OAAO,CAAC,4CAA4C;IAuCpD,OAAO,CAAC,0BAA0B;IAY3B,KAAK,IAAI,mBAAmB;CAWnC"}

package/dist/src/instrumenter/TaskBuilder.js

@@ -40,12 +40,6 @@ const fs = __importStar(require("fs"));
 const path = __importStar(require("path"));
 const FileSystem_1 = require("./FileSystem");
 const uuid_1 = require("uuid");
-/**
- * Load a source map object from the given file (path).
- * Exception if the specified file does not exist.
- *
- * @param sourceMapPath - The path to the source map file.
- */
 function loadSourceMap(sourceMapPath) {
     if (sourceMapPath) {
         if (!fs.existsSync(sourceMapPath)) {
@@ -55,58 +49,52 @@ function loadSourceMap(sourceMapPath) {
     }
     return undefined;
 }
-/**
- * A builder for an instrumentation task.
- */
 class TaskBuilder {
+    elements;
+    collector;
+    originSourceIncludePatterns;
+    originSourceExcludePatterns;
+    bundleFileExcludePatterns;
+    dumpOriginsFile;
+    dumpMatchedOriginsFile;
+    targetBucket;
+    appId;
     constructor() {
         this.appId = (0, uuid_1.v4)();
         this.elements = [];
         this.collector = null;
         this.targetBucket = null;
     }
-    /** Set the collector specification based on the command-line arguments. */
     setCollectorFromCommandLine(commandLineUrl, relativePattern) {
         commons_1.Contract.requireNonEmpty(commandLineUrl, "The collector URL must not be empty");
         this.collector = (0, Task_1.createCollectorSpecifier)(commandLineUrl, relativePattern);
         return this;
     }
-    /** Set the coverage bucket to be used within the collector. */
     setCollectorTargetBucket(configId, commit, configOptions, appName) {
         commons_1.Contract.requireNonEmpty(commit, "The commit must not be empty");
         this.appId = generateAppId(appName);
         this.targetBucket = { appId: this.appId, configId, commit, configOptions };
         return this;
     }
-    /** Set the origin include pattern. If multiple patterns are present, concatenates them via the OR operator.  */
     setOriginSourceIncludePatterns(patterns) {
         this.originSourceIncludePatterns = patterns;
         return this;
     }
-    /** Set the origin exclude pattern(s). If multiple patterns are present, concatenates them via the OR operator. */
     setOriginSourceExcludePatterns(patterns) {
         this.originSourceExcludePatterns = patterns;
         return this;
     }
-    /** Sets the file bundle exclude pattern. If multiple patterns are present, concatenates them via the OR operator. */
     setBundleExcludePatterns(patterns) {
         this.bundleFileExcludePatterns = patterns;
         return this;
     }
-    /** Add a task element */
     addElement(fromFilePath, toFilePath, fromFileSourceMap) {
         this.elements.push(new Task_1.TaskElement(fromFilePath, toFilePath, fromFileSourceMap));
         return this;
     }
-    /**
-     * Add the task details based on a configuration (command line arguments).
-     *
-     * @param config - The configuration based on that the task is built.
-     */
     addFromConfig(config) {
-        var _a, _b, _c;
-        const inputs = ((_a = config.input) !== null && _a !== void 0 ? _a : []);
-        const inPlace = (_b = config.inPlace) !== null && _b !== void 0 ? _b : false;
+        const inputs = (config.input ?? []);
+        const inPlace = config.inPlace ?? false;
         const target = config.to;
         const sourceMap = config.sourceMap;
         this.dumpOriginsFile = config.dumpOriginsTo;
@@ -115,12 +103,8 @@ class TaskBuilder {
         this.setOriginSourceIncludePatterns(config.includeOrigin);
         this.setOriginSourceExcludePatterns(config.excludeOrigin);
         this.setBundleExcludePatterns(config.excludeBundle);
-        this.setCollectorTargetBucket(config.configId, (_c = config.commit) !== null && _c !== void 0 ? _c : 'HEAD', config.collectorConfigFileContent, config.appName);
-        // Handle an explicitly specified source map
+        this.setCollectorTargetBucket(config.configId, config.commit ?? 'HEAD', config.collectorConfigFileContent, config.appName);
         const sourceMapInfo = loadSourceMap(sourceMap);
-        // If an in-place instrumentation is needed,
-        // the task has to be built differently and different invariants
-        // have to be satisfied by the passed configuration.
         if (inPlace) {
             if (target) {
                 throw new commons_1.InvalidConfigurationException('No target path must be specified in case an in-place instrumentation is enabled.');
@@ -128,7 +112,6 @@ class TaskBuilder {
             this.addInPlaceTasksFromPattern(inputs, sourceMapInfo);
         }
         else if (!inPlace) {
-            // A target directory must be specified
             if (!target) {
                 throw new commons_1.InvalidConfigurationException('A target path must be specified using `--to`.');
             }
@@ -136,14 +119,6 @@ class TaskBuilder {
         }
         return this;
     }
-    /**
-     * Adds instrumentation tasks based on a given pattern `inputs` describing the set of
-     * input files and produces the output files in the specified output folder `target.
-     *
-     * @param inputs - Glob pattern describing set of input files
-     * @param target - Target folder
-     * @param sourceMapInfo - Source map file for all the input files.
-     */
     addInstrumentationTasksFromPatternWithTarget(inputs, target, sourceMapInfo) {
         (0, FileSystem_1.ensureExistingDirectory)(target);
         for (const input of inputs) {
@@ -173,13 +148,6 @@ class TaskBuilder {
             }
         }
     }
-    /**
-     * Adds in-place instrumentation tasks for the set of files described
-     * by the `inputs` pattern.
-     *
-     * @param inputs - Glob pattern.
-     * @param sourceMapInfo - Source map for the files described by the pattern.
-     */
     addInPlaceTasksFromPattern(inputs, sourceMapInfo) {
         inputs
             .map(input => expandAndCheck(input))
@@ -188,17 +156,11 @@ class TaskBuilder {
         }, [])
             .forEach(filePath => this.addElement(filePath, filePath, sourceMapInfo));
     }
-    /**
-     * Build the instrumentation task.
-     */
     build() {
         return new Task_1.InstrumentationTask(commons_1.Contract.requireDefined(this.collector), commons_1.Contract.requireDefined(this.targetBucket), this.elements, new Task_1.FileExcludePattern(this.bundleFileExcludePatterns), new Task_1.OriginSourcePattern(this.originSourceIncludePatterns, this.originSourceExcludePatterns), this.dumpOriginsFile, this.dumpMatchedOriginsFile);
     }
 }
 exports.TaskBuilder = TaskBuilder;
-/**
- * Generates an application ID, if an `appName` is given, with a user-friendly prefix.
- */
 function generateAppId(appName) {
     const result = (0, uuid_1.v4)();
     if (appName) {
@@ -207,18 +169,9 @@ function generateAppId(appName) {
     }
     return result;
 }
-/**
- * Does the given string look like a RegExp or Glob pattern?
- */
 function isPattern(text) {
     return text.includes('*') || text.includes('+') || text.includes('?') || text.includes('|');
 }
-/**
- * Expand the given Glob pattern and check if files matched.
- * Raises an exception is the result is empty.
- *
- * @param pattern - The Glob pattern used for matching.
- */
 function expandAndCheck(pattern) {
     const result = (0, FileSystem_1.expandToFileSet)(pattern);
     if (result.length === 0) {

package/dist/src/instrumenter/WebToolkit.d.ts

@@ -1,40 +1,13 @@
 import { Bundle, GwtBundle } from './Task';
 import { RawSourceMap } from 'source-map';
-/**
- * Information on a GWT function call, typically with code to be evaluated as arguments.
- */
 export type GwtCallInfos = {
     codeArguments: string[];
     functionName: string;
     codeAsArrayArgument: boolean;
 };
-/**
- * There are different places where a 'symbolMaps' folder can be:
- * (1) within the `WEB-INF` folder (`WEB-INF/deploy/<module-name>/symbolMaps`)
- * or (2) it can be a sibling of the parent `deferredjs` folder.
- *
- * @param taskFile - Path to the JS bundle file to start searching from.
- */
 export declare function determineSymbolMapsDir(taskFile: string): string[];
-/**
- * Extract the GWT function calls from the GWT bundle. These function calls
- * do have the actual application code as arguments.
- *
- * Examples of `bundleContent` (without the double quotes):
- * 		"showcase.onScriptDownloaded(["var $wnd =  .....  __gwtModuleFunction.__moduleStartupDone($gwt.permProps);\n//# sourceURL=showcase-0.js\n"]);"
- * 	    "$wnd.showcase.runAsyncCallback3("function bc(a){Wb((Ze(),Xe),a) ..... nZ5b(El)(3);\n//# sourceURL=showcase-3.js\n")
- */
 export declare function extractGwtCallInfos(bundleContent: string): GwtCallInfos | null;
-/**
- * Load the source map for the given GWT bundle.
- */
 export declare function loadInputSourceMapsGwt(taskFile: string, bundleFile: GwtBundle): Array<RawSourceMap | undefined>;
-/**
- * Determine the ID of the given GWT bundle file.
- */
 export declare function determineGwtFileUid(filename: string): string | undefined;
-/**
- * Is the given bundle a GWT bundle?
- */
 export declare function isGwtBundle(bundle: Bundle): bundle is GwtBundle;
 //# sourceMappingURL=WebToolkit.d.ts.map

package/dist/src/instrumenter/WebToolkit.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"WebToolkit.d.ts","sourceRoot":"","sources":["../../../src/instrumenter/WebToolkit.ts"],"names":[],"mappings":"AAeA,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,QAAQ,CAAC;AAC3C,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAE1C;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG;IAAE,aAAa,EAAE,MAAM,EAAE,CAAC;IAAC,YAAY,EAAE,MAAM,CAAC;IAAC,mBAAmB,EAAE,OAAO,CAAA;CAAE,CAAC;AAE3G;;;;;;GAMG;AACH,wBAAgB,sBAAsB,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,EAAE,CAqBjE;AAkBD;;;;;;;GAOG;AACH,wBAAgB,mBAAmB,CAAC,aAAa,EAAE,MAAM,GAAG,YAAY,GAAG,IAAI,CA+B9E;AAED;;GAEG;AACH,wBAAgB,sBAAsB,CAAC,QAAQ,EAAE,MAAM,EAAE,UAAU,EAAE,SAAS,GAAG,KAAK,CAAC,YAAY,GAAG,SAAS,CAAC,CAgC/G;AAED;;GAEG;AACH,wBAAgB,mBAAmB,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAOxE;AAED;;GAEG;AACH,wBAAgB,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,IAAI,SAAS,CAE/D"}
+{"version":3,"file":"WebToolkit.d.ts","sourceRoot":"","sources":["../../../src/instrumenter/WebToolkit.ts"],"names":[],"mappings":"AAeA,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,QAAQ,CAAC;AAC3C,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAK1C,MAAM,MAAM,YAAY,GAAG;IAAE,aAAa,EAAE,MAAM,EAAE,CAAC;IAAC,YAAY,EAAE,MAAM,CAAC;IAAC,mBAAmB,EAAE,OAAO,CAAA;CAAE,CAAC;AAS3G,wBAAgB,sBAAsB,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,EAAE,CAqBjE;AA0BD,wBAAgB,mBAAmB,CAAC,aAAa,EAAE,MAAM,GAAG,YAAY,GAAG,IAAI,CA+B9E;AAKD,wBAAgB,sBAAsB,CAAC,QAAQ,EAAE,MAAM,EAAE,UAAU,EAAE,SAAS,GAAG,KAAK,CAAC,YAAY,GAAG,SAAS,CAAC,CAgC/G;AAKD,wBAAgB,mBAAmB,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAOxE;AAKD,wBAAgB,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,IAAI,SAAS,CAE/D"}

package/dist/src/instrumenter/WebToolkit.js

@@ -13,13 +13,6 @@ const FileSystem_1 = require("./FileSystem");
 const types_1 = require("@babel/types");
 const parser_1 = require("@babel/parser");
 const commons_1 = require("@cqse/commons");
-/**
- * There are different places where a 'symbolMaps' folder can be:
- * (1) within the `WEB-INF` folder (`WEB-INF/deploy/<module-name>/symbolMaps`)
- * or (2) it can be a sibling of the parent `deferredjs` folder.
- *
- * @param taskFile - Path to the JS bundle file to start searching from.
- */
 function determineSymbolMapsDir(taskFile) {
     const symbolMapDirs = [];
     let webInfDir = null;
@@ -55,14 +48,6 @@ function extractQualifiedFunctionName(call) {
     }
     throw new commons_1.IllegalArgumentException('Type of callee not yet supported.');
 }
-/**
- * Extract the GWT function calls from the GWT bundle. These function calls
- * do have the actual application code as arguments.
- *
- * Examples of `bundleContent` (without the double quotes):
- * 		"showcase.onScriptDownloaded(["var $wnd =  .....  __gwtModuleFunction.__moduleStartupDone($gwt.permProps);\n//# sourceURL=showcase-0.js\n"]);"
- * 	    "$wnd.showcase.runAsyncCallback3("function bc(a){Wb((Ze(),Xe),a) ..... nZ5b(El)(3);\n//# sourceURL=showcase-3.js\n")
- */
 function extractGwtCallInfos(bundleContent) {
     const ast = (0, parser_1.parse)(bundleContent);
     if (ast.program.body.length === 0) {
@@ -95,13 +80,7 @@ function extractGwtCallInfos(bundleContent) {
     }
     return null;
 }
-/**
- * Load the source map for the given GWT bundle.
- */
 function loadInputSourceMapsGwt(taskFile, bundleFile) {
-    // taskFile:
-    //    war/stockwatcher/E2C1FB09E006E0A2420123D036967150.cache.js
-    //    war/showcase/deferredjs/28F63AD125178AAAB80993C11635D26F/5.cache.js
     const mapDirs = determineSymbolMapsDir(taskFile);
     const fileNumberMatcher = /sourceURL=(.*)-(\d+).js(\\n)*\s*$/;
     const mapModules = bundleFile.codeArguments.map(code => {
@@ -127,9 +106,6 @@ function loadInputSourceMapsGwt(taskFile, bundleFile) {
         return undefined;
     });
 }
-/**
- * Determine the ID of the given GWT bundle file.
- */
 function determineGwtFileUid(filename) {
     const fileUidMatcher = /.*([0-9A-Fa-f]{32}).*/;
     const uidMatches = fileUidMatcher.exec(filename);
@@ -138,9 +114,6 @@ function determineGwtFileUid(filename) {
     }
     return uidMatches[1];
 }
-/**
- * Is the given bundle a GWT bundle?
- */
 function isGwtBundle(bundle) {
     return bundle.type === 'gwt';
 }

package/dist/src/main.js

@@ -2,7 +2,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const App_1 = require("./App");
-// Main function of the instrumenter
 App_1.App.run().catch(reason => {
     console.error(reason);
+    if (process.exitCode === 0 || process.exitCode === undefined) {
+        process.exitCode = 1;
+    }
 });