Ignore TS constructs for CC

Author: f1ames

package.json

@@ -19,7 +19,8 @@
     "lint:f": "eslint src/ test/ --ext .ts --fix",
     "prepare": "husky install",
     "coverage": "npm run coverage:generate && npx http-server coverage",
-    "coverage:generate": "npm run build && npm run coverage:unit && npm run coverage:bdd && npm run coverage:report",
+    "coverage:generate": "npm run build && npm run coverage:ignore && npm run coverage:unit && npm run coverage:bdd && npm run coverage:report",
+    "coverage:ignore": "node scripts/coverage-ignore.js",
     "coverage:check": "npm run build && npm run coverage:unit && npm run coverage:bdd && nyc report --check-coverage",
     "coverage:unit": "nyc --silent npm run test:run:unit && SCRAMJET_LOG=1 nyc --silent --no-clean npm run test:run:unit -- -m \"trace does not throw\"",
     "coverage:bdd": "nyc --silent --no-clean npm run test:run:bdd",

scripts/coverage-ignore.js

@@ -0,0 +1,38 @@
+#!/usr/bin/env node
+// Ignore TypeScript constructs (like decorator local functions) in coverage reports.
+
+const { join } = require("path");
+const { readFileSync, writeFileSync } = require("fs");
+
+const files = [
+    "build/src/streams/data-stream.js",
+    "build/src/streams/string-stream.js",
+    "build/src/streams/proxies/stream-node-writable-proxy.js"
+];
+
+const replacements = [
+    "var __decorate = (",
+    "var __metadata = (",
+    "var __asyncValues = (",
+    "var __importDefault = (",
+    [/__decorate\(\[/g, "__decorate(["]
+];
+
+for (const file of files) {
+    const filePath = join(__dirname, "..", file);
+    const fileContents = readFileSync(filePath, "utf8");
+
+    console.log(`coverage-ignore: Processing ${filePath}`);
+
+    let newContents = fileContents;
+
+    for (const replacement of replacements) {
+        if (Array.isArray(replacement)) {
+            newContents = newContents.replace(replacement[0], `/* istanbul ignore next */\n${replacement[1]}`);
+        } else {
+            newContents = newContents.replace(replacement, `/* istanbul ignore next */\n${replacement}`);
+        }
+    }
+
+    writeFileSync(filePath, newContents);
+}

src/streams/data-stream.ts

@@ -225,8 +225,12 @@ export class DataStream<IN, OUT = IN> implements BaseStream<IN, OUT>, AsyncItera
             onChunkCallback: async (chunk: OUT) => {
                 const items = await callback(chunk, ...args);
 
-                for await (const item of items) {
-                    await newStream.ifca.write(item);
+                /* istanbul ignore next */
+                // eslint-disable-next-line no-lone-blocks
+                {
+                    for await (const item of items) {
+                        await newStream.ifca.write(item);
+                    }
                 }
             },
             onEndCallback: async () => {
@@ -577,15 +581,19 @@ export class DataStream<IN, OUT = IN> implements BaseStream<IN, OUT>, AsyncItera
                 await this.corked.promise;
             }
 
-            for await (const data of iterable) {
-                if (this.corked) {
-                    await this.corked.promise;
-                }
+            /* istanbul ignore next */
+            // eslint-disable-next-line no-lone-blocks
+            {
+                for await (const data of iterable) {
+                    if (this.corked) {
+                        await this.corked.promise;
+                    }
 
-                const drain = this.ifca.write(data);
+                    const drain = this.ifca.write(data);
 
-                if (drain instanceof Promise) {
-                    await drain;
+                    if (drain instanceof Promise) {
+                        await drain;
+                    }
                 }
             }
 

tsconfig.build.json

@@ -2,6 +2,7 @@
   "extends": "./tsconfig.json",
   "compilerOptions": {
     "sourceMap": false,
+    "removeComments": false,
     "outDir": "build"
   },
   "watchOptions": {