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

package/README.md

@@ -14,28 +14,3 @@ in the [Teamscale Documentation](https://docs.teamscale.com/howto/setting-up-pro
 The Instrumenter instruments a given (set of) JavaScript file(s) such that (1) coverage 
 information is produced and (2) forwarded to the Collector.
 
-## Building
-
-The Instrumenter is written in TypeScript/JavaScript. For building and running it,
-NodeJs (>= v16) and pnpm are needed as prerequisites.
-
-``` 
-pnpm clean
-pnpm install
-pnpm build
-```
-
-## Workflow Integration
-
-There are several options to run the Instrumenter. For example, via `pnpm` by running
-
-```
-pnpm instrumenter
-```
-
-or via `npx` by running
-
-```
-npx @teamscale/javascript-instrumenter
-```
-

package/dist/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@teamscale/javascript-instrumenter",
-    "version": "1.0.0-beta.5",
+    "version": "1.0.0-beta.7",
     "description": "JavaScript coverage instrumenter with coverage forwarding to a collector process",
     "main": "dist/src/main.js",
     "bin": "dist/src/main.js",
@@ -14,53 +14,47 @@
         "build": "tsc --project tsconfig.json && pnpm buildVaccine",
         "buildVaccine": "node esbuild.mjs",
         "instrumenter": "node dist/src/main.js",
-        "test": "pnpm build && NODE_OPTIONS='--experimental-vm-modules --max-old-space-size=8192' jest --forceExit --coverage --silent=true --detectOpenHandles"
+        "test": "node --import tsx --test test/**/*.test.ts"
     },
     "files": [
         "dist/**/*"
     ],
     "devDependencies": {
-        "@babel/core": "^7.26.8",
-        "@babel/plugin-transform-modules-commonjs": "^7.26.3",
-        "@babel/preset-env": "^7.26.8",
-        "@types/async": "^3.2.24",
-        "@types/babel__generator": "^7.6.8",
-        "@types/babel__traverse": "^7.20.6",
+        "@babel/core": "^7.28.5",
+        "@babel/plugin-transform-modules-commonjs": "^7.27.1",
+        "@babel/preset-env": "^7.28.5",
+        "@types/async": "^3.2.25",
+        "@types/babel__generator": "^7.27.0",
+        "@types/babel__traverse": "^7.28.0",
         "@types/bunyan": "^1.8.11",
         "@types/convert-source-map": "^2.0.3",
-        "@types/glob": "^9.0.0",
-        "@types/jest": "^29.5.14",
-        "@types/node": "^22.13.4",
-        "@types/ws": "^8.5.14",
-        "@types/uuid": "^10.0.0",
-        "babel-jest": "^29.7.0",
-        "esbuild": "^0.25.0",
+        "@types/node": "^22.18.12",
+        "@types/ws": "^8.18.1",
+        "esbuild": "^0.25.11",
         "esbuild-plugin-inline-worker": "^0.1.1",
-        "jest": "^29.7.0",
         "rimraf": "^6.0.1",
-        "ts-jest": "^29.2.5",
-        "ts-node": "^10.9.2",
         "tslib": "^2.8.1",
-        "typescript": "^5.7.3"
+        "tsx": "^4.19.2",
+        "typescript": "^5.8.3"
     },
     "dependencies": {
+        "@babel/generator": "^7.28.5",
+        "@babel/parser": "^7.28.5",
+        "@babel/traverse": "^7.28.5",
+        "@babel/types": "^7.28.5",
         "@cqse/commons": "workspace:../cqse-commons",
         "@teamscale/lib-instrument": "workspace:../lib-instrument",
-        "@babel/generator": "^7.26.8",
-        "@babel/parser": "^7.26.8",
-        "@babel/traverse": "^7.26.8",
-        "@babel/types": "^7.26.8",
-        "@types/micromatch": "^4.0.9",
+        "@types/micromatch": "^4.0.10",
         "async": "^3.2.6",
         "bunyan": "^1.8.15",
         "convert-source-map": "^2.0.0",
-        "foreground-child": "^3.3.0",
-        "glob": "^11.0.1",
+        "foreground-child": "^3.3.1",
         "micromatch": "4.0.8",
         "mkdirp": "^3.0.1",
-        "source-map": "0.7.4",
+        "source-map": "0.7.6",
+        "tinyglobby": "^0.2.15",
         "unload": "^2.4.1",
-        "uuid": "^11.1.0",
+        "uuid": "^13.0.0",
         "web-worker": "^1.5.0"
     },
     "publishConfig": {

package/dist/src/App.d.ts

@@ -1,52 +1,16 @@
 import { TaskResult } from './instrumenter/Task';
 import Logger from 'bunyan';
 import { InstrumenterOptions } from './instrumenter/InstrumenterConfig';
-/**
- * Entry points of the instrumenter, including command line argument parsing.
- */
 export declare class App {
-    /**
-     * Main function of the instrumenter.
-     * Parses the command line options and the instrumentation accordingly.
-     */
     static run(): Promise<TaskResult>;
-    /**
-     * Runs the application with for the given command line arguments. Visible for testing.
-     */
     static runForArgv(argv: string[]): Promise<TaskResult>;
-    /**
-     * Parses the command-line arguments.
-     *
-     * @param args - Optional. For testing. If given, uses this as the arguments to parse and does not exit the process on errors.
-     *   If not given, uses the NodeJS process's arguments and exits on errors.
-     * @param beforeArgumentCheckCallback - To be executed before the arguments are checked for validity.
-     */
     static parseCommandLine(args?: string[], beforeArgumentCheckCallback?: (options: InstrumenterOptions) => void): InstrumenterOptions;
-    /**
-     * Sometimes we get inputs from shell environments where the strings are
-     * still quoted. We remove those here.
-     */
     static postprocessConfig(config: InstrumenterOptions): void;
-    /**
-     * Construct the logger.
-     */
     private static buildLogger;
-    /**
-     * A logger for testing.
-     */
     private static buildDummyLogger;
-    /**
-     * The instrumenter can also be started by providing the configuration dictionary explicitly.
-     *
-     * @param config - The dictionary with all configuration arguments.
-     * @param logger - The logger to use.
-     */
     static runForConfigArguments(config: InstrumenterOptions, logger?: Logger): Promise<TaskResult>;
     private static createInstrumentationTask;
     private static createInstrumenter;
-    /**
-     * Processes the task result and produces console outputs, and possibly a process exit with a corresponding code.
-     */
     private static finalizeAppRunWithConsoleOutputs;
 }
 //# sourceMappingURL=App.d.ts.map

package/dist/src/App.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"App.d.ts","sourceRoot":"","sources":["../../src/App.ts"],"names":[],"mappings":"AAAA,OAAO,EAAuB,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAYtE,OAAO,MAAM,MAAM,QAAQ,CAAC;AAE5B,OAAO,EAA4C,mBAAmB,EAAE,MAAM,mCAAmC,CAAC;AAGlH;;GAEG;AACH,qBAAa,GAAG;IACf;;;OAGG;WACiB,GAAG,IAAI,OAAO,CAAC,UAAU,CAAC;IAI9C;;OAEG;WACiB,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,UAAU,CAAC;IA2BnE;;;;;;OAMG;WACW,gBAAgB,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,EAAE,2BAA2B,CAAC,EAAE,CAAC,OAAO,EAAE,mBAAmB,KAAK,IAAI,GAAG,mBAAmB;IAM1I;;;OAGG;WACW,iBAAiB,CAAC,MAAM,EAAE,mBAAmB,GAAG,IAAI;IAwClE;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,WAAW;IA+B1B;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,gBAAgB;IAI/B;;;;;OAKG;WACW,qBAAqB,CAAC,MAAM,EAAE,mBAAmB,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC;IAqCtG,OAAO,CAAC,MAAM,CAAC,yBAAyB;IAIxC,OAAO,CAAC,MAAM,CAAC,kBAAkB;IAcjC;;OAEG;mBACkB,gCAAgC;CAmDrD"}
+{"version":3,"file":"App.d.ts","sourceRoot":"","sources":["../../src/App.ts"],"names":[],"mappings":"AAAA,OAAO,EAAuB,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAYtE,OAAO,MAAM,MAAM,QAAQ,CAAC;AAE5B,OAAO,EAA4C,mBAAmB,EAAE,MAAM,mCAAmC,CAAC;AAMlH,qBAAa,GAAG;WAKK,GAAG,IAAI,OAAO,CAAC,UAAU,CAAC;WAO1B,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,UAAU,CAAC;WAkCrD,gBAAgB,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,EAAE,2BAA2B,CAAC,EAAE,CAAC,OAAO,EAAE,mBAAmB,KAAK,IAAI,GAAG,mBAAmB;WAU5H,iBAAiB,CAAC,MAAM,EAAE,mBAAmB,GAAG,IAAI;IA2ClE,OAAO,CAAC,MAAM,CAAC,WAAW;IAkC1B,OAAO,CAAC,MAAM,CAAC,gBAAgB;WAUjB,qBAAqB,CAAC,MAAM,EAAE,mBAAmB,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC;IAqCtG,OAAO,CAAC,MAAM,CAAC,yBAAyB;IAIxC,OAAO,CAAC,MAAM,CAAC,kBAAkB;mBAiBZ,gCAAgC;CAmDrD"}

package/dist/src/App.js

@@ -47,20 +47,10 @@ const mkdirp_1 = require("mkdirp");
 const bunyan_1 = __importDefault(require("bunyan"));
 const InstrumenterConfig_1 = require("./instrumenter/InstrumenterConfig");
 const process = __importStar(require("node:process"));
-/**
- * Entry points of the instrumenter, including command line argument parsing.
- */
 class App {
-    /**
-     * Main function of the instrumenter.
-     * Parses the command line options and the instrumentation accordingly.
-     */
     static async run() {
         return this.runForArgv(process.argv);
     }
-    /**
-     * Runs the application with for the given command line arguments. Visible for testing.
-     */
     static async runForArgv(argv) {
         const config = this.parseCommandLine(argv.slice(2), options => {
             if (options.collectorOptionsList) {
@@ -75,29 +65,16 @@ class App {
                 process.exit(0);
             }
         });
-        // Build the logger
         const logger = this.buildLogger(config);
         logger.trace('Retrieved arguments', process.argv);
         logger.trace('Translated arguments to config', config);
-        // Run the instrumenter with the given configuration.
         return this.runForConfigArguments(config, logger);
     }
-    /**
-     * Parses the command-line arguments.
-     *
-     * @param args - Optional. For testing. If given, uses this as the arguments to parse and does not exit the process on errors.
-     *   If not given, uses the NodeJS process's arguments and exits on errors.
-     * @param beforeArgumentCheckCallback - To be executed before the arguments are checked for validity.
-     */
     static parseCommandLine(args, beforeArgumentCheckCallback) {
         const configParameters = (0, InstrumenterConfig_1.buildInstrumenterConfigurationParameters)();
         const appInfos = { about: package_json_1.description, version: package_json_1.version, name: package_json_1.name };
         return (0, commons_1.processCommandLine)(configParameters, appInfos, args, beforeArgumentCheckCallback);
     }
-    /**
-     * Sometimes we get inputs from shell environments where the strings are
-     * still quoted. We remove those here.
-     */
     static postprocessConfig(config) {
         function unquoteString(originalString) {
             if (originalString === undefined) {
@@ -126,33 +103,25 @@ class App {
         }
         for (const [property, value] of Object.entries(config)) {
             if (value === undefined) {
-                // In case the value is 'undefined' we can ignore this.
             }
             else if (typeof value === 'string') {
-                // eslint-disable-next-line  @typescript-eslint/no-explicit-any
                 config[property] = unquoteString(value);
             }
             else if (Array.isArray(value)) {
-                // eslint-disable-next-line  @typescript-eslint/no-explicit-any
                 config[property] = unquoteStringElements(value);
             }
         }
     }
-    /**
-     * Construct the logger.
-     */
     static buildLogger(config) {
-        var _a;
         const logfilePath = 'logs/instrumenter.log';
         mkdirp_1.mkdirp.sync(path.dirname(logfilePath));
-        const logLevel = (_a = config.logLevel) !== null && _a !== void 0 ? _a : 'info';
+        const logLevel = config.logLevel ?? 'info';
         return bunyan_1.default.createLogger({
             name: 'Instrumenter',
             streams: [
                 {
                     level: logLevel,
                     stream: {
-                        // eslint-disable-next-line @typescript-eslint/no-explicit-any
                         write: (rec) => {
                             console.log('[%s] %s: %s', rec.time.toISOString(), bunyan_1.default.nameFromLevel[rec.level], rec.msg);
                         }
@@ -166,18 +135,9 @@ class App {
             ]
         });
     }
-    /**
-     * A logger for testing.
-     */
     static buildDummyLogger() {
         return bunyan_1.default.createLogger({ name: 'Instrumenter' });
     }
-    /**
-     * The instrumenter can also be started by providing the configuration dictionary explicitly.
-     *
-     * @param config - The dictionary with all configuration arguments.
-     * @param logger - The logger to use.
-     */
     static runForConfigArguments(config, logger) {
         this.postprocessConfig(config);
         if (config.collectorConfigFile) {
@@ -194,7 +154,6 @@ class App {
         }
         if (config.collectorConfigFileContent) {
             try {
-                // We parse the collector config file once, to see if it is valid.
                 const collectorParameters = (0, commons_1.buildReconfigurableCollectorParameters)();
                 const { options } = (0, commons_1.parseConfigFile)(config.collectorConfigFileContent, collectorParameters);
                 if (!(0, commons_1.checkArguments)(collectorParameters, options)) {
@@ -207,17 +166,13 @@ class App {
         }
         const task = this.createInstrumentationTask(config);
         commons_1.Contract.require(task.elements.length > 0, 'The instrumentation task must not be empty.');
-        const instrumentationResult = this.createInstrumenter(logger !== null && logger !== void 0 ? logger : this.buildDummyLogger(), task.collector, task.targetBucket).instrument(task);
+        const instrumentationResult = this.createInstrumenter(logger ?? this.buildDummyLogger(), task.collector, task.targetBucket).instrument(task);
         return App.finalizeAppRunWithConsoleOutputs(instrumentationResult);
     }
     static createInstrumentationTask(config) {
         return new TaskBuilder_1.TaskBuilder().addFromConfig(config).build();
     }
     static createInstrumenter(logger, collector, targetBucket) {
-        // We have to deal with two different `__dirname` versions,
-        // which depends on whether we run from within the IDE or from
-        // the command line:
-        //     dist/src/    OR    src/
         const pathVariant1 = path.join(__dirname, '../vaccine.js');
         const pathVariant2 = path.join(__dirname, '../dist/vaccine.js');
         if ((0, fs_1.existsSync)(pathVariant1)) {
@@ -227,11 +182,7 @@ class App {
             return new Instrumenter_1.IstanbulInstrumenter(pathVariant2, logger, collector, targetBucket);
         }
     }
-    /**
-     * Processes the task result and produces console outputs, and possibly a process exit with a corresponding code.
-     */
     static async finalizeAppRunWithConsoleOutputs(resultPromise) {
-        var _a, _b;
         try {
             const result = await resultPromise;
             console.log('Instrumentation finished.');
@@ -242,8 +193,8 @@ class App {
             console.log(`\tUnsupported: ${result.unsupported}`);
             console.log(`\tWith warning: ${result.warnings}`);
             console.log(`\tFailed: ${result.failed}`);
-            if ((_a = result.task) === null || _a === void 0 ? void 0 : _a.originSourcePattern.patternsSpecified()) {
-                const stats = (_b = result.task) === null || _b === void 0 ? void 0 : _b.originSourcePattern.retrieveMatchingFiles();
+            if (result.task?.originSourcePattern.patternsSpecified()) {
+                const stats = result.task?.originSourcePattern.retrieveMatchingFiles();
                 console.log(`\tSource origin matches`);
                 console.log(`\t\tInclude patterns: [${stats.includePatterns}]`);
                 console.log(`\t\tExclude patterns: [${stats.excludePatterns}]`);
@@ -267,7 +218,6 @@ class App {
         }
         catch (reason) {
             if (reason instanceof commons_1.InvalidConfigurationException) {
-                // Do not print the stack trace for invalid configuration parameters from the user.
                 console.error(`Failed: ${reason.message}`);
             }
             else {

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

@@ -1,38 +1,10 @@
 import { RawSourceMap } from 'source-map';
-/**
- * Does the given `path` point to an existing file?
- */
 export declare function isExistingFile(path: string): boolean;
-/**
- * Does the given `path` point to an existing directory?
- */
 export declare function isExistingDirectory(path: string): boolean;
-/**
- * Ensure that the given directory `path` exists.
- */
 export declare function ensureExistingDirectory(path: string): void;
-/**
- * Given a root folder find a folder with a given name.
- */
 export declare function findSubFolders(startFromFolder: string, folderName: string): string[];
-/**
- * Is the given directory empty?
- */
 export declare function isDirectoryEmpty(path: string): boolean;
-/**
- * Expand a given Glob pattern to a list of files.
- *
- * @param toExpand - The Glob pattern.
- */
 export declare function expandToFileSet(toExpand: string): string[];
-/**
- * Read a source map from a source map file.
- *
- * @param mapFilePath
- */
 export declare function sourceMapFromMapFile(mapFilePath: string): RawSourceMap | undefined;
-/**
- * Ensure that the given name works as a file or folder name.
- */
 export declare function replaceNonFilesystemCharacters(name: string): string;
 //# sourceMappingURL=FileSystem.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"FileSystem.d.ts","sourceRoot":"","sources":["../../../src/instrumenter/FileSystem.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAE1C;;GAEG;AACH,wBAAgB,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAEpD;AAED;;GAEG;AACH,wBAAgB,mBAAmB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAEzD;AAED;;GAEG;AACH,wBAAgB,uBAAuB,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAU1D;AAED;;GAEG;AACH,wBAAgB,cAAc,CAAC,eAAe,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,MAAM,EAAE,CAgBpF;AAED;;GAEG;AACH,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAEtD;AAED;;;;GAIG;AACH,wBAAgB,eAAe,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,EAAE,CAc1D;AAED;;;;GAIG;AACH,wBAAgB,oBAAoB,CAAC,WAAW,EAAE,MAAM,GAAG,YAAY,GAAG,SAAS,CAGlF;AAED;;GAEG;AACH,wBAAgB,8BAA8B,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAKnE"}
+{"version":3,"file":"FileSystem.d.ts","sourceRoot":"","sources":["../../../src/instrumenter/FileSystem.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAM1C,wBAAgB,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAEpD;AAKD,wBAAgB,mBAAmB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAEzD;AAKD,wBAAgB,uBAAuB,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAU1D;AAKD,wBAAgB,cAAc,CAAC,eAAe,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,MAAM,EAAE,CAgBpF;AAKD,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAEtD;AAOD,wBAAgB,eAAe,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,EAAE,CAc1D;AAOD,wBAAgB,oBAAoB,CAAC,WAAW,EAAE,MAAM,GAAG,YAAY,GAAG,SAAS,CAGlF;AAKD,wBAAgB,8BAA8B,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAKnE"}

package/dist/src/instrumenter/FileSystem.js

@@ -48,22 +48,13 @@ const commons_1 = require("@cqse/commons");
 const fs = __importStar(require("fs"));
 const mkdirp = __importStar(require("mkdirp"));
 const path_1 = __importDefault(require("path"));
-const glob_1 = require("glob");
-/**
- * Does the given `path` point to an existing file?
- */
+const tinyglobby_1 = require("tinyglobby");
 function isExistingFile(path) {
     return fs.existsSync(path) && fs.lstatSync(path).isFile();
 }
-/**
- * Does the given `path` point to an existing directory?
- */
 function isExistingDirectory(path) {
     return fs.existsSync(path) && fs.lstatSync(path).isDirectory();
 }
-/**
- * Ensure that the given directory `path` exists.
- */
 function ensureExistingDirectory(path) {
     if (!fs.existsSync(path)) {
         mkdirp.sync(path);
@@ -72,9 +63,6 @@ function ensureExistingDirectory(path) {
         throw new commons_1.InvalidConfigurationException(`The specified path '${path}' does not point to an existing directory!`);
     }
 }
-/**
- * Given a root folder find a folder with a given name.
- */
 function findSubFolders(startFromFolder, folderName) {
     const matches = [];
     const entries = fs.readdirSync(startFromFolder, { withFileTypes: true });
@@ -90,17 +78,9 @@ function findSubFolders(startFromFolder, folderName) {
     }
     return matches;
 }
-/**
- * Is the given directory empty?
- */
 function isDirectoryEmpty(path) {
     return !isExistingDirectory(path) || fs.readdirSync(path).length > 0;
 }
-/**
- * Expand a given Glob pattern to a list of files.
- *
- * @param toExpand - The Glob pattern.
- */
 function expandToFileSet(toExpand) {
     let globPattern = toExpand;
     if (fs.existsSync(toExpand)) {
@@ -112,23 +92,13 @@ function expandToFileSet(toExpand) {
             globPattern = `${toExpand}${path_1.default.sep}**`;
         }
     }
-    return glob_1.glob.sync(globPattern, { nodir: true });
+    return (0, tinyglobby_1.globSync)(globPattern, { onlyFiles: true });
 }
-/**
- * Read a source map from a source map file.
- *
- * @param mapFilePath
- */
 function sourceMapFromMapFile(mapFilePath) {
     const content = fs.readFileSync(mapFilePath, 'utf8');
     return JSON.parse(content);
 }
-/**
- * Ensure that the given name works as a file or folder name.
- */
 function replaceNonFilesystemCharacters(name) {
-    // Replace undesired characters by underscore chars.
     const result = name.replace(/[^a-zA-Z0-9_\-.\\/]/g, '_');
-    // Remove repeated underscores (_) from `result.
     return result.replace(/_+/g, '_');
 }

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

@@ -1,92 +1,25 @@
 import { FileExcludePattern, InstrumentationTask, OriginSourcePattern, SourceMapReference, TaskElement, TaskResult } from './Task';
-import { RawSourceMap, SourceMapConsumer } from 'source-map';
+import { RawSourceMap } from 'source-map';
 import Logger from 'bunyan';
-import { CollectorSpecifier, CoverageBucketSpecifier } from '@src/vaccine/types';
+import { CollectorSpecifier, CoverageBucketSpecifier } from '../vaccine/types';
 export declare const IS_INSTRUMENTED_TOKEN = "$IS_JS_PROFILER_INSTRUMENTED=true";
-/**
- * An instrumenter that can conduct a {@code InstrumentationTask}.
- */
 export interface IInstrumenter {
-    /**
-     * Perform the given instrumentation task.
-     *
-     * @param task - The instrumentation task to conduct.
-     */
     instrument(task: InstrumentationTask): Promise<TaskResult>;
 }
-/**
- * An instrumenter based on the IstanbulJs instrumentation and coverage framework.
- */
 export declare class IstanbulInstrumenter implements IInstrumenter {
-    /**
-     * The vaccine to inject. The vaccine is a JavaScript
-     * file with the code to forward the coverage information
-     * produced by the Istanbul instrumentation.
-     */
     private readonly vaccineSource;
-    /**
-     * The logger instance to log to.
-     */
     private logger;
     constructor(vaccineFilePath: string, logger: Logger, collector: CollectorSpecifier, targetBucket: CoverageBucketSpecifier);
-    /**
-     * {@inheritDoc #IInstrumenter.instrument}
-     */
     instrument(task: InstrumentationTask): Promise<TaskResult>;
-    /**
-     * Perform the instrumentation for one given task element (file to instrument).
-     *
-     * @param collector - The collector to send the coverage information to.
-     * @param taskElement - The task element to perform the instrumentation for.
-     * @param excludeBundles - A exclude pattern to restrict which bundles should be instrumented
-     * @param sourcePattern - A pattern to restrict the instrumentation to only a fraction of the task element.
-     * @param dumpOriginsFile - A file path where all origins from the source map should be dumped in json format, or undefined if no origins should be dumped
-     */
     instrumentOne(taskElement: TaskElement, excludeBundles: FileExcludePattern, sourcePattern: OriginSourcePattern, dumpOriginsFile: string | undefined): Promise<TaskResult>;
     private instrumentBundle;
     private writeBundleFile;
-    /**
-     * Loads the vaccine from the vaccine file and adjusts some template parameters.
-     *
-     * @param filePath - The path to the vaccine file.
-     * @param collector - The collector to send coverage information to.
-     * @param targetBucket - The bucket within the collector to put the coverage into.
-     */
     private loadVaccine;
-    /**
-     * @returns whether the given file is supported for instrumentation.
-     */
     private isFileTypeSupported;
-    /**
-     * Determine the list of configurations to try conducting the
-     * given task element.
-     */
     private configurationAlternativesFor;
-    /** Deletes the file if it exists, such that it is now ready to be appended. */
     private clearFile;
-    /** Write the contents of the given object into the given file, if provided. */
     private dumpToJson;
 }
-/**
- * Extract the sourcemap from the given source code.
- *
- * @param instrumentedSource - The source code.
- * @param instrumentedSourceFileName - The file name to assume for the file name.
- */
-export declare function loadSourceMap(instrumentedSource: string, instrumentedSourceFileName: string): Promise<SourceMapConsumer | undefined>;
-/**
- * Given a source code file, load the corresponding sourcemap.
- *
- * @param inputSource - The source code that might contain sourcemap comments.
- * @param taskFile - The name of the file the `inputSource` is from.
- * @param externalSourceMapFile - An external source map file to consider.
- */
 export declare function loadInputSourceMap(inputSource: string, taskFile: string, externalSourceMapFile?: SourceMapReference): RawSourceMap | undefined;
-/**
- * Extract a sourcemap for a given code comment.
- *
- * @param sourcecode - The source code that is scanned for source map comments.
- * @param sourceFilePath - The file name the code was loaded from.
- */
 export declare function sourceMapFromCodeComment(sourcecode: string, sourceFilePath: string): RawSourceMap | undefined;
 //# sourceMappingURL=Instrumenter.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"Instrumenter.d.ts","sourceRoot":"","sources":["../../../src/instrumenter/Instrumenter.ts"],"names":[],"mappings":"AAAA,OAAO,EAEN,kBAAkB,EAElB,mBAAmB,EACnB,mBAAmB,EAEnB,kBAAkB,EAElB,WAAW,EACX,UAAU,EACV,MAAM,QAAQ,CAAC;AAEhB,OAAO,EAAE,YAAY,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAC;AAM7D,OAAO,MAAM,MAAM,QAAQ,CAAC;AAO5B,OAAO,EAAE,kBAAkB,EAAE,uBAAuB,EAAE,MAAM,oBAAoB,CAAC;AAEjF,eAAO,MAAM,qBAAqB,sCAAsC,CAAC;AAEzE;;GAEG;AACH,MAAM,WAAW,aAAa;IAC7B;;;;OAIG;IACH,UAAU,CAAC,IAAI,EAAE,mBAAmB,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;CAC3D;AA0BD;;GAEG;AACH,qBAAa,oBAAqB,YAAW,aAAa;IACzD;;;;OAIG;IACH,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAS;IAEvC;;OAEG;IACH,OAAO,CAAC,MAAM,CAAS;gBAEX,eAAe,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,kBAAkB,EAAE,YAAY,EAAE,uBAAuB;IAUzH;;OAEG;IACG,UAAU,CAAC,IAAI,EAAE,mBAAmB,GAAG,OAAO,CAAC,UAAU,CAAC;IA2BhE;;;;;;;;OAQG;IACG,aAAa,CAClB,WAAW,EAAE,WAAW,EACxB,cAAc,EAAE,kBAAkB,EAClC,aAAa,EAAE,mBAAmB,EAClC,eAAe,EAAE,MAAM,GAAG,SAAS,GACjC,OAAO,CAAC,UAAU,CAAC;YAsER,gBAAgB;IA8C9B,OAAO,CAAC,eAAe;IA0BvB;;;;;;OAMG;IACH,OAAO,CAAC,WAAW;IAQnB;;OAEG;IACH,OAAO,CAAC,mBAAmB;IAS3B;;;OAGG;IACH,OAAO,CAAC,4BAA4B;IAgBpC,+EAA+E;IAC/E,OAAO,CAAC,SAAS;IAUjB,+EAA+E;IAC/E,OAAO,CAAC,UAAU;CAYlB;AAED;;;;;GAKG;AACH,wBAAsB,aAAa,CAClC,kBAAkB,EAAE,MAAM,EAC1B,0BAA0B,EAAE,MAAM,GAChC,OAAO,CAAC,iBAAiB,GAAG,SAAS,CAAC,CAUxC;AAsBD;;;;;;GAMG;AACH,wBAAgB,kBAAkB,CACjC,WAAW,EAAE,MAAM,EACnB,QAAQ,EAAE,MAAM,EAChB,qBAAqB,CAAC,EAAE,kBAAkB,GACxC,YAAY,GAAG,SAAS,CAU1B;AAED;;;;;GAKG;AACH,wBAAgB,wBAAwB,CAAC,UAAU,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,GAAG,YAAY,GAAG,SAAS,CAwC7G"}
+{"version":3,"file":"Instrumenter.d.ts","sourceRoot":"","sources":["../../../src/instrumenter/Instrumenter.ts"],"names":[],"mappings":"AAAA,OAAO,EAEN,kBAAkB,EAElB,mBAAmB,EACnB,mBAAmB,EAEnB,kBAAkB,EAElB,WAAW,EACX,UAAU,EACV,MAAM,QAAQ,CAAC;AAEhB,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAM1C,OAAO,MAAM,MAAM,QAAQ,CAAC;AAO5B,OAAO,EAAE,kBAAkB,EAAE,uBAAuB,EAAE,MAAM,kBAAkB,CAAC;AAE/E,eAAO,MAAM,qBAAqB,sCAAsC,CAAC;AAKzE,MAAM,WAAW,aAAa;IAM7B,UAAU,CAAC,IAAI,EAAE,mBAAmB,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;CAC3D;AA6BD,qBAAa,oBAAqB,YAAW,aAAa;IAMzD,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAS;IAKvC,OAAO,CAAC,MAAM,CAAS;gBAEX,eAAe,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,kBAAkB,EAAE,YAAY,EAAE,uBAAuB;IAanH,UAAU,CAAC,IAAI,EAAE,mBAAmB,GAAG,OAAO,CAAC,UAAU,CAAC;IAmC1D,aAAa,CAClB,WAAW,EAAE,WAAW,EACxB,cAAc,EAAE,kBAAkB,EAClC,aAAa,EAAE,mBAAmB,EAClC,eAAe,EAAE,MAAM,GAAG,SAAS,GACjC,OAAO,CAAC,UAAU,CAAC;YAsER,gBAAgB;IA8C9B,OAAO,CAAC,eAAe;IAiCvB,OAAO,CAAC,WAAW;IAWnB,OAAO,CAAC,mBAAmB;IAa3B,OAAO,CAAC,4BAA4B;IAkBpC,OAAO,CAAC,SAAS;IAWjB,OAAO,CAAC,UAAU;CAYlB;AA6BD,wBAAgB,kBAAkB,CACjC,WAAW,EAAE,MAAM,EACnB,QAAQ,EAAE,MAAM,EAChB,qBAAqB,CAAC,EAAE,kBAAkB,GACxC,YAAY,GAAG,SAAS,CAU1B;AAQD,wBAAgB,wBAAwB,CAAC,UAAU,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,GAAG,YAAY,GAAG,SAAS,CAwC7G"}