xunit.ts 0.13.0 → 1.0.2

package/logo.svg

@@ -0,0 +1,154 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<svg
+   xmlns:dc="http://purl.org/dc/elements/1.1/"
+   xmlns:cc="http://creativecommons.org/ns#"
+   xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
+   xmlns:svg="http://www.w3.org/2000/svg"
+   xmlns="http://www.w3.org/2000/svg"
+   xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
+   xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
+   inkscape:export-ydpi="96"
+   inkscape:export-xdpi="96"
+   inkscape:export-filename="X:\ecoAPM\xunit.ts\logo-black.png"
+   sodipodi:docname="logo.svg"
+   inkscape:version="1.0 (4035a4fb49, 2020-05-01)"
+   id="svg8"
+   version="1.1"
+   viewBox="0 0 400 128"
+   height="128"
+   width="400">
+  <defs
+     id="defs2">
+    <rect
+       id="rect2858"
+       height="56"
+       width="61.5"
+       y="39"
+       x="127.5" />
+    <rect
+       id="rect2746"
+       height="38.364582"
+       width="5.0270834"
+       y="94.720833"
+       x="102.39375" />
+  </defs>
+  <sodipodi:namedview
+     inkscape:window-maximized="1"
+     inkscape:window-y="-8"
+     inkscape:window-x="-8"
+     inkscape:window-height="1137"
+     inkscape:window-width="1920"
+     inkscape:pagecheckerboard="false"
+     units="px"
+     showgrid="false"
+     inkscape:document-rotation="0"
+     inkscape:current-layer="layer1"
+     inkscape:document-units="px"
+     inkscape:cy="111.1524"
+     inkscape:cx="243.86486"
+     inkscape:zoom="2"
+     inkscape:pageshadow="2"
+     inkscape:pageopacity="0"
+     borderopacity="1.0"
+     bordercolor="#666666"
+     pagecolor="#000000"
+     id="base" />
+  <metadata
+     id="metadata5">
+    <rdf:RDF>
+      <cc:Work
+         rdf:about="">
+        <dc:format>image/svg+xml</dc:format>
+        <dc:type
+           rdf:resource="http://purl.org/dc/dcmitype/StillImage" />
+        <dc:title></dc:title>
+      </cc:Work>
+    </rdf:RDF>
+  </metadata>
+  <g
+     id="layer1"
+     inkscape:groupmode="layer"
+     inkscape:label="Layer 1">
+    <text
+       id="text2742"
+       y="168.27499"
+       x="-11.377083"
+       style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:127px;line-height:1.25;font-family:'Noto Sans';-inkscape-font-specification:'Noto Sans';fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.264583"
+       xml:space="preserve"><tspan
+         sodipodi:role="line"
+         style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:127px;font-family:'Noto Sans';-inkscape-font-specification:'Noto Sans';stroke-width:0.264583"
+         y="168.27499"
+         x="-11.377083"
+         id="tspan2740" /><tspan
+         id="tspan2754"
+         sodipodi:role="line"
+         style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:127px;font-family:'Noto Sans';-inkscape-font-specification:'Noto Sans';stroke-width:0.264583"
+         y="327.02499"
+         x="-11.377083" /></text>
+    <text
+       style="font-style:normal;font-weight:normal;font-size:10.5833px;line-height:1.25;font-family:sans-serif;white-space:pre;shape-inside:url(#rect2746);fill:#000000;fill-opacity:1;stroke:none;"
+       id="text2744"
+       xml:space="preserve" />
+    <text
+       id="text2752"
+       y="26.987499"
+       x="35.983334"
+       style="font-style:normal;font-weight:normal;font-size:10.5833px;line-height:1.25;font-family:sans-serif;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.264583"
+       xml:space="preserve"><tspan
+         style="stroke-width:0.264583"
+         y="26.987499"
+         x="35.983334"
+         id="tspan2750"
+         sodipodi:role="line" /></text>
+    <text
+       transform="scale(0.99994519,1.0000548)"
+       id="text2758"
+       y="98.652382"
+       x="112.43309"
+       style="font-style:normal;font-weight:normal;font-size:95.8669px;line-height:0;font-family:sans-serif;fill:#ffffff;fill-opacity:1;stroke:none;stroke-width:0.264216"
+       xml:space="preserve"><tspan
+         style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:95.8669px;line-height:1;font-family:'Noto Sans';-inkscape-font-specification:'Noto Sans';fill:#000000;fill-opacity:1;stroke-width:0.264216"
+         y="98.652382"
+         x="112.43309"
+         id="tspan2756"
+         sodipodi:role="line"><tspan
+           id="tspan3014"
+           style="fill:#ffffff;fill-opacity:1">unit</tspan><tspan
+           id="tspan3000"
+           style="fill:#808080;fill-opacity:1">.</tspan><tspan
+           id="tspan3016"
+           style="fill:#ffffff;fill-opacity:1">ts</tspan></tspan></text>
+    <text
+       style="fill:black;fill-opacity:1;line-height:1.25;stroke:none;font-family:sans-serif;font-style:normal;font-weight:normal;font-size:40px;white-space:pre;shape-inside:url(#rect2858);"
+       id="text2856"
+       xml:space="preserve" />
+  </g>
+  <g
+     inkscape:label="Layer 2"
+     id="layer2"
+     inkscape:groupmode="layer">
+    <g
+       transform="matrix(-3.7140083,0,0,3.7296903,884.38712,-159.89914)"
+       style="font-style:normal;font-weight:normal;font-size:50.8px;line-height:1.25;font-family:sans-serif;fill:#bfbfbf;fill-opacity:1;stroke:none;stroke-width:0.264583"
+       id="text2766-0"
+       aria-label="🗸">
+      <path
+         sodipodi:nodetypes="ccsccccc"
+         id="path2805"
+         style="font-size:50.8px;fill:#bfbfbf;fill-opacity:1;stroke-width:0.264583"
+         d="m 231.8494,43.408198 0.74414,1.289843 c -4.84518,3.423047 -9.33483,7.755599 -13.46894,12.997656 -4.13412,5.242057 -7.11895,10.376628 -8.9545,15.403711 l -1.0914,0.719336 c -0.94258,0.611849 -1.75287,1.223698 -2.43086,1.835547 -1.21639,-4.400349 7.20052,-16.248511 12.05508,-21.480859 4.15065,-4.415235 8.53281,-8.003646 13.14648,-10.765234 z" />
+    </g>
+    <text
+       transform="scale(0.99789547,1.002109)"
+       xml:space="preserve"
+       style="font-style:normal;font-weight:normal;font-size:189.07px;line-height:1.25;font-family:sans-serif;fill:#538d43;fill-opacity:1;stroke:none;stroke-width:0.984736"
+       x="-11.659009"
+       y="150.47635"
+       id="text2766"><tspan
+         sodipodi:role="line"
+         id="tspan2764"
+         x="-11.659009"
+         y="150.47635"
+         style="font-size:189.07px;fill:#538d43;fill-opacity:1;stroke-width:0.984736">🗸</tspan></text>
+  </g>
+</svg>

package/package.json

@@ -1,16 +1,18 @@
 {
   "name": "xunit.ts",
-  "version": "0.13.0",
+  "version": "1.0.2",
   "description": "A unit testing framework for TypeScript, following standard xUnit patterns",
   "main": "dist/xunit.js",
   "author": "ecoAPM LLC",
+  "homepage": "https://github.com/ecoAPM/xunit.ts",
+  "bugs": "https://github.com/ecoAPM/xunit.ts/issues",
   "license": "MIT",
   "dependencies": {
     "colors": "1.4.0",
     "command-line-args": "5.2.0",
     "command-line-usage": "6.1.1",
     "lodash.isequal": "4.5.0",
-    "typescript": "4.3.5",
+    "typescript": "4.5.2",
     "xml": "1.0.1"
   },
   "devDependencies": {
@@ -18,17 +20,17 @@
     "@types/command-line-args": "5.2.0",
     "@types/command-line-usage": "5.0.2",
     "@types/lodash.isequal": "4.5.5",
-    "@types/node": "16.6.0",
+    "@types/node": "16.11.10",
     "@types/xml": "1.0.6",
-    "notosans": "4.0.1",
+    "notosans": "5.0.0",
     "ts-mockito": "2.6.1",
-    "ts-node": "10.2.0"
+    "ts-node": "10.4.0"
   },
   "scripts": {
     "clean": "rm -rf dist",
     "build": "tsc",
     "test": "node dist/cli.js dist/tests",
-    "tsdoc": "cp -r node_modules/notosans/noto.css node_modules/notosans/dist docs/assets &&  ts-node tsdoc.ts"
+    "tsdoc": "cp -r node_modules/notosans/* docs/assets &&  ts-node tsdoc.ts"
   },
   "bin": {
     "xunit": "dist/cli.js"

package/sonar-project.properties

@@ -1,6 +1,6 @@
 sonar.organization=ecoapm
 sonar.projectKey=ecoAPM_xunit.ts
-sonar.sources=src
+sonar.sources=src,TSDoc
 sonar.tests=tests
 sonar.testExecutionReportPaths=sonar.xml
 sonar.javascript.lcov.reportPaths=coverage/lcov.info

package/src/Assertions/InstanceOf.ts

@@ -2,27 +2,27 @@ import { AssertionError } from "assert";
 
 /**
  * Asserts that a value is an instance of a certain type
- * 
+ *
  * @remarks
  * Passes if `object`'s type matches `type`
- * 
- * Fails if `object`'s type does not match `type` 
+ *
+ * Fails if `object`'s type does not match `type`
  *
  * @param type the expected type of the value
  * @param expression the value to check
  * @param message (optional) message to display on failure
- * 
+ *
  * @example
  * this.assert.instanceOf(type, object);
  */
 export default function InstanceOf<T>(type: any, expression: any, message?: string) {
-    if (expression instanceof type) {
-        return;
-    }
+	if (expression instanceof type) {
+		return;
+	}
 
-    throw new AssertionError({
-        message: message || `Expected expression of type, but was ${typeof expression}`,
-        expected: type,
-        actual: typeof expression
-    })
+	throw new AssertionError({
+		message: message || `Expected expression of type, but was ${typeof expression}`,
+		expected: type.name,
+		actual: typeof expression
+	})
 }

package/src/Assertions/StringContains.ts

@@ -15,8 +15,8 @@ import { AssertionError } from "assert";
  * @example
  * this.assert.stringContains(needle, haystack);
  */
-export default function StringContains(needle: string, haystack: string|null, message?: string) {
-    if(haystack !== undefined && haystack !== null && haystack.indexOf(needle) !== -1) {
+export default function StringContains(needle: string, haystack: string | null, message?: string) {
+    if (haystack !== undefined && haystack !== null && haystack.indexOf(needle) > -1) {
         return;
     }
 

package/src/Assertions/StringDoesNotEndWith.ts

@@ -15,8 +15,10 @@ import { AssertionError } from "assert";
  * @example
  * this.assert.stringDoesNotEndWith(needle, haystack);
  */
-export default function StringDoesNotEndWith(needle: string, haystack: string|null, message?: string) {
-    if(haystack === undefined || haystack === null || haystack.indexOf(needle) !== haystack.length - needle.length) {
+export default function StringDoesNotEndWith(needle: string, haystack: string | null, message?: string) {
+    if (haystack === undefined || haystack === null
+        || haystack.indexOf(needle) === -1
+        || haystack.indexOf(needle) !== haystack.length - needle.length) {
         return;
     }
 

package/src/Assertions/StringEndsWith.ts

@@ -15,8 +15,10 @@ import { AssertionError } from "assert";
  * @example
  * this.assert.stringEndsWith(needle, haystack);
  */
-export default function StringEndsWith(needle: string, haystack: string|null, message?: string) {
-    if(haystack !== undefined && haystack !== null && haystack.indexOf(needle) === haystack.length - needle.length) {
+export default function StringEndsWith(needle: string, haystack: string | null, message?: string) {
+    if (haystack !== undefined && haystack !== null
+        && haystack.indexOf(needle) > -1
+        && haystack.indexOf(needle) === haystack.length - needle.length) {
         return;
     }
 

package/src/CLI.ts

@@ -2,7 +2,6 @@ import Usage from 'command-line-usage';
 import JUnitReporter from './Reporters/JUnitReporter';
 import Process from "process";
 import Args from "command-line-args";
-import Factory from "./Factory";
 import Runner from "./Runners/Runner";
 import SonarReporter from "./Reporters/SonarReporter";
 
@@ -72,7 +71,7 @@ export default class CLI {
 
     private static readonly usage = Usage(CLI.sections);
 
-    constructor(private readonly process: typeof Process) {
+    constructor(private readonly runnerFactory: (args: Args.CommandLineOptions) => Runner, private readonly process: typeof Process) {
     }
 
     async run(): Promise<boolean> {
@@ -84,14 +83,16 @@ export default class CLI {
             return true;
         }
 
-        const runner = Factory.Runner(args);
+        const runner = this.runnerFactory(args);
 
         try {
             const results = await runner.runAll(args.dir);
             return Runner.allTestsPassed(results);
         } catch (error) {
-            this.process.stderr.write(`An unhandled ${error.name} occurred: ${error.message}\n`);
-            this.process.stderr.write(error.stack?.toString() || '(no call stack)\n');
+            if (error instanceof Error) {
+                this.process.stderr.write(`An unhandled ${error.name} occurred: ${error.message}\n`);
+                this.process.stderr.write(error.stack?.toString() || '(no call stack)\n');
+            }
             return false;
         }
     }

package/src/Factory.ts

@@ -10,16 +10,13 @@ import TestSuiteLoader from './Runners/TestSuiteLoader';
 import TestSuiteRunner from './Runners/TestSuiteRunner';
 import fs from "fs/promises";
 import SonarReporter from "./Reporters/SonarReporter";
-import Parser from "./TSDoc/Parser";
-import {TSDocParser} from "@microsoft/tsdoc";
-import Generator from "./TSDoc/Generator";
 
 export default class Factory {
-    private static readonly file_system = new FileSystem(fs);
+    static readonly file_system = new FileSystem(fs);
 
     static Runner(args: Args.CommandLineOptions) {
-        const loader = new TestSuiteLoader(this.file_system);
-        const reporters = this.Reporters(args);
+        const loader = new TestSuiteLoader(Factory.file_system);
+        const reporters = Factory.Reporters(args);
         const test_runner = new TestRunner(reporters);
         const test_suite_runner = new TestSuiteRunner(test_runner, reporters);
 
@@ -29,14 +26,8 @@ export default class Factory {
     static Reporters(args: Args.CommandLineOptions): ReadonlyArray<ResultReporter> {
         return [
             !args.quiet ? new ConsoleReporter(new Output(process.stdout)) : null,
-            args.junit !== undefined ? new JUnitReporter(this.file_system, args.junit ?? JUnitReporter.defaultFileName) : null,
-            args.sonar !== undefined ? new SonarReporter(this.file_system, args.sonar ?? SonarReporter.defaultFileName) : null
+            args.junit !== undefined ? new JUnitReporter(Factory.file_system, args.junit ?? JUnitReporter.defaultFileName) : null,
+            args.sonar !== undefined ? new SonarReporter(Factory.file_system, args.sonar ?? SonarReporter.defaultFileName) : null
         ].filter(r => r !== null) as ResultReporter[];
     }
-    
-    static TSDocGenerator() {
-        const parser = new Parser(new TSDocParser());
-        return new Generator(this.file_system, fs, parser);
-    }
-
 }

package/src/Runners/TestRunner.ts

@@ -25,13 +25,14 @@ export default class TestRunner {
 
         } catch (error) {
             const duration = TestRunner.msSince(start);
-            if (error instanceof AssertionError) {
-                await Promise.all(this.reporters.map(r => r.testFailed(suite, name, error, duration)));
-                return new TestResult(ResultType.Failed, duration, error);
+            const typedError = error as Error;
+            if (typedError instanceof AssertionError) {
+                await Promise.all(this.reporters.map(r => r.testFailed(suite, name, typedError, duration)));
+                return new TestResult(ResultType.Failed, duration, typedError);
             }
 
-            await Promise.all(this.reporters.map(r => r.testErrored(suite, name, error, duration)));
-            return new TestResult(ResultType.Error, duration, error);
+            await Promise.all(this.reporters.map(r => r.testErrored(suite, name, typedError, duration)));
+            return new TestResult(ResultType.Error, duration, typedError);
         }
     }
 

package/tsconfig.json

@@ -13,11 +13,13 @@
   },
   "files": [
     "xunit.ts",
-    "cli.ts"
+    "cli.ts",
+    "tsdoc.ts"
   ],
   "include": [
     "src/**/*.ts",
-    "tests/**/*.ts"
+    "tests/**/*.ts",
+    "TSDoc/**/*.ts"
   ],
   "exclude": [
     "node_modules",

package/dist/src/TSDoc/Generator.d.ts

@@ -1,14 +0,0 @@
-/// <reference types="node" />
-import FileSystem from "../IO/FileSystem";
-import FSPromises from "fs/promises";
-import Parser from "./Parser";
-export default class Generator {
-    private readonly fs;
-    private readonly fs_promises;
-    private readonly parser;
-    constructor(fs: FileSystem, fs_promises: typeof FSPromises, parser: Parser);
-    run(dir: string, out_dir: string): Promise<void>;
-    private generate;
-    private static getMarkdown;
-}
-//# sourceMappingURL=Generator.d.ts.map

package/dist/src/TSDoc/Generator.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"Generator.d.ts","sourceRoot":"","sources":["../../../src/TSDoc/Generator.ts"],"names":[],"mappings":";AAAA,OAAO,UAAU,MAAM,kBAAkB,CAAC;AAC1C,OAAO,UAAU,MAAM,aAAa,CAAC;AACrC,OAAO,MAAM,MAAM,UAAU,CAAC;AAM9B,MAAM,CAAC,OAAO,OAAO,SAAS;IACd,OAAO,CAAC,QAAQ,CAAC,EAAE;IAAc,OAAO,CAAC,QAAQ,CAAC,WAAW;IAAqB,OAAO,CAAC,QAAQ,CAAC,MAAM;gBAAxF,EAAE,EAAE,UAAU,EAAmB,WAAW,EAAE,OAAO,UAAU,EAAmB,MAAM,EAAE,MAAM;IAGvH,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;YAMxC,QAAQ;IActB,OAAO,CAAC,MAAM,CAAC,WAAW;CAY7B"}

package/dist/src/TSDoc/Generator.js

@@ -1,59 +0,0 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const Parser_1 = __importDefault(require("./Parser"));
-const path_1 = __importDefault(require("path"));
-const TestName_1 = __importDefault(require("../Framework/TestName"));
-const Markdown_1 = __importDefault(require("./Markdown"));
-class Generator {
-    constructor(fs, fs_promises, parser) {
-        this.fs = fs;
-        this.fs_promises = fs_promises;
-        this.parser = parser;
-    }
-    run(dir, out_dir) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const files = yield this.fs.getFiles(dir);
-            const tasks = files.map(file => this.generate(file, out_dir));
-            yield Promise.all(tasks);
-        });
-    }
-    generate(file, out_path) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const code = yield this.fs_promises.readFile(file);
-            const doc = yield this.parser.findDoc(code.toString());
-            const [base, dir, filename] = file.split(path_1.default.sep);
-            const md = Generator.getMarkdown(filename, doc);
-            if (md !== null) {
-                const out = path_1.default.join(out_path, file.substr(base.length + 1)).replace(/\.ts$/, '.md');
-                yield this.fs_promises.mkdir(path_1.default.join(out_path, dir), { recursive: true });
-                yield this.fs_promises.writeFile(out, md);
-            }
-        });
-    }
-    static getMarkdown(filename, doc) {
-        var _a, _b, _c, _d, _e;
-        const summary = Parser_1.default.renderNodes(doc.summarySection.nodes);
-        if (!summary) {
-            return null;
-        }
-        const title = TestName_1.default.toSentenceCase((_a = filename === null || filename === void 0 ? void 0 : filename.split('.')[0]) !== null && _a !== void 0 ? _a : '');
-        const example = Parser_1.default.renderNodes((_c = (_b = doc.customBlocks.filter(b => b.blockTag.tagName == '@example')[0]) === null || _b === void 0 ? void 0 : _b.content.nodes) !== null && _c !== void 0 ? _c : []);
-        const remarks = Parser_1.default.renderNodes((_e = (_d = doc.remarksBlock) === null || _d === void 0 ? void 0 : _d.content.nodes) !== null && _e !== void 0 ? _e : []);
-        const params = doc.params.blocks.map(p => `| \`${p.parameterName}\` | ${Parser_1.default.renderNodes(p.content.nodes)} |`).join('\n');
-        return Markdown_1.default.render(title, summary, example, remarks, params);
-    }
-}
-exports.default = Generator;
-//# sourceMappingURL=Generator.js.map

package/dist/src/TSDoc/Generator.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"Generator.js","sourceRoot":"","sources":["../../../src/TSDoc/Generator.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AAEA,sDAA8B;AAC9B,gDAAwB;AACxB,qEAA6C;AAC7C,0DAAkC;AAGlC,MAAqB,SAAS;IAC1B,YAA6B,EAAc,EAAmB,WAA8B,EAAmB,MAAc;QAAhG,OAAE,GAAF,EAAE,CAAY;QAAmB,gBAAW,GAAX,WAAW,CAAmB;QAAmB,WAAM,GAAN,MAAM,CAAQ;IAC7H,CAAC;IAEK,GAAG,CAAC,GAAW,EAAE,OAAe;;YAClC,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;YAC1C,MAAM,KAAK,GAAG,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC;YAC9D,MAAM,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QAC7B,CAAC;KAAA;IAEa,QAAQ,CAAC,IAAY,EAAE,QAAgB;;YACjD,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YACnD,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC;YAEvD,MAAM,CAAC,IAAI,EAAE,GAAG,EAAE,QAAQ,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,cAAI,CAAC,GAAG,CAAC,CAAC;YACnD,MAAM,EAAE,GAAG,SAAS,CAAC,WAAW,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;YAEhD,IAAI,EAAE,KAAK,IAAI,EAAE;gBACb,MAAM,GAAG,GAAG,cAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;gBACtF,MAAM,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,cAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,GAAG,CAAC,EAAE,EAAC,SAAS,EAAE,IAAI,EAAC,CAAC,CAAC;gBAC1E,MAAM,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;aAC7C;QACL,CAAC;KAAA;IAEO,MAAM,CAAC,WAAW,CAAC,QAAgB,EAAE,GAAe;;QACxD,MAAM,OAAO,GAAG,gBAAM,CAAC,WAAW,CAAC,GAAG,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;QAC7D,IAAI,CAAC,OAAO,EAAE;YACV,OAAO,IAAI,CAAC;SACf;QAED,MAAM,KAAK,GAAG,kBAAQ,CAAC,cAAc,CAAC,MAAA,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,KAAK,CAAC,GAAG,EAAE,CAAC,CAAC,mCAAI,EAAE,CAAC,CAAC;QACrE,MAAM,OAAO,GAAG,gBAAM,CAAC,WAAW,CAAC,MAAA,MAAA,GAAG,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,OAAO,IAAI,UAAU,CAAC,CAAC,CAAC,CAAC,0CAAE,OAAO,CAAC,KAAK,mCAAI,EAAE,CAAC,CAAC;QAC3H,MAAM,OAAO,GAAG,gBAAM,CAAC,WAAW,CAAC,MAAA,MAAA,GAAG,CAAC,YAAY,0CAAE,OAAO,CAAC,KAAK,mCAAI,EAAE,CAAC,CAAC;QAC1E,MAAM,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC,aAAa,QAAQ,gBAAM,CAAC,WAAW,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC5H,OAAO,kBAAQ,CAAC,MAAM,CAAC,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;IACrE,CAAC;CACJ;AApCD,4BAoCC"}

package/dist/src/TSDoc/Markdown.d.ts

@@ -1,4 +0,0 @@
-export default class Markdown {
-    static render(title: string, summary: string, example: string, remarks: string, params: string): string;
-}
-//# sourceMappingURL=Markdown.d.ts.map

package/dist/src/TSDoc/Markdown.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"Markdown.d.ts","sourceRoot":"","sources":["../../../src/TSDoc/Markdown.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,OAAO,OAAO,QAAQ;IACzB,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM;CAiB1G"}

package/dist/src/TSDoc/Markdown.js

@@ -1,23 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-class Markdown {
-    static render(title, summary, example, remarks, params) {
-        return `---\n`
-            + `title: ${title} \n`
-            + `---\n\n`
-            + `## Assertion: ${title} \n\n`
-            + `${summary} \n\n`
-            + (example ? '### Example \n\n' : '')
-            + (example ? '```ts \n' : '')
-            + example
-            + (example ? '\n``` \n\n' : '')
-            + (remarks ? '### Conditions \n\n' : '')
-            + (remarks ? `${remarks} \n\n` : '')
-            + (params ? '### Parameters \n\n' : '')
-            + (params ? '| Name | Description | \n' : '')
-            + (params ? '|---|---| \n' : '')
-            + params;
-    }
-}
-exports.default = Markdown;
-//# sourceMappingURL=Markdown.js.map

package/dist/src/TSDoc/Markdown.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"Markdown.js","sourceRoot":"","sources":["../../../src/TSDoc/Markdown.ts"],"names":[],"mappings":";;AAAA,MAAqB,QAAQ;IACzB,MAAM,CAAC,MAAM,CAAC,KAAa,EAAE,OAAe,EAAE,OAAe,EAAE,OAAe,EAAE,MAAc;QAC1F,OAAO,OAAO;cACR,UAAU,KAAK,KAAK;cACpB,SAAS;cACT,iBAAiB,KAAK,OAAO;cAC7B,GAAG,OAAO,OAAO;cACjB,CAAC,OAAO,CAAC,CAAC,CAAC,kBAAkB,CAAC,CAAC,CAAC,EAAE,CAAC;cACnC,CAAC,OAAO,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC;cAC3B,OAAO;cACP,CAAC,OAAO,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,CAAC;cAC7B,CAAC,OAAO,CAAC,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,EAAE,CAAC;cACtC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC;cAClC,CAAC,MAAM,CAAC,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,EAAE,CAAC;cACrC,CAAC,MAAM,CAAC,CAAC,CAAC,2BAA2B,CAAC,CAAC,CAAC,EAAE,CAAC;cAC3C,CAAC,MAAM,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,EAAE,CAAC;cAC9B,MAAM,CAAC;IACjB,CAAC;CACJ;AAlBD,2BAkBC"}

package/dist/src/TSDoc/Parser.d.ts

@@ -1,9 +0,0 @@
-import { DocComment, DocNode, TSDocParser } from "@microsoft/tsdoc";
-export default class Parser {
-    private readonly parser;
-    constructor(parser: TSDocParser);
-    findDoc(code: string): Promise<DocComment>;
-    private static renderNode;
-    static renderNodes(docNodes: ReadonlyArray<DocNode>): string;
-}
-//# sourceMappingURL=Parser.d.ts.map

package/dist/src/TSDoc/Parser.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"Parser.d.ts","sourceRoot":"","sources":["../../../src/TSDoc/Parser.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,UAAU,EAAc,OAAO,EAAE,WAAW,EAAC,MAAM,kBAAkB,CAAC;AAE9E,MAAM,CAAC,OAAO,OAAO,MAAM;IACX,OAAO,CAAC,QAAQ,CAAC,MAAM;gBAAN,MAAM,EAAE,WAAW;IAG1C,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC;IAMhD,OAAO,CAAC,MAAM,CAAC,UAAU;IAazB,MAAM,CAAC,WAAW,CAAC,QAAQ,EAAE,aAAa,CAAC,OAAO,CAAC,GAAG,MAAM;CAO/D"}

package/dist/src/TSDoc/Parser.js

@@ -1,45 +0,0 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const tsdoc_1 = require("@microsoft/tsdoc");
-class Parser {
-    constructor(parser) {
-        this.parser = parser;
-    }
-    findDoc(code) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const comment = code.substring(code.indexOf('/**'), code.indexOf('*/') + 2);
-            const context = this.parser.parseString(comment);
-            return context.docComment;
-        });
-    }
-    static renderNode(docNode) {
-        let result = '';
-        if (docNode) {
-            if (docNode instanceof tsdoc_1.DocExcerpt) {
-                result += docNode.content.toString();
-            }
-            for (const childNode of docNode.getChildNodes()) {
-                result += this.renderNode(childNode);
-            }
-        }
-        return result;
-    }
-    static renderNodes(docNodes) {
-        let result = '';
-        for (const docNode of docNodes) {
-            result += this.renderNode(docNode);
-        }
-        return result.trim();
-    }
-}
-exports.default = Parser;
-//# sourceMappingURL=Parser.js.map

package/dist/src/TSDoc/Parser.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"Parser.js","sourceRoot":"","sources":["../../../src/TSDoc/Parser.ts"],"names":[],"mappings":";;;;;;;;;;;AAAA,4CAA8E;AAE9E,MAAqB,MAAM;IACvB,YAA6B,MAAmB;QAAnB,WAAM,GAAN,MAAM,CAAa;IAChD,CAAC;IAEK,OAAO,CAAC,IAAY;;YACtB,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;YAC5E,MAAM,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;YACjD,OAAO,OAAO,CAAC,UAAU,CAAC;QAC9B,CAAC;KAAA;IAEO,MAAM,CAAC,UAAU,CAAC,OAAgB;QACtC,IAAI,MAAM,GAAW,EAAE,CAAC;QACxB,IAAI,OAAO,EAAE;YACT,IAAI,OAAO,YAAY,kBAAU,EAAE;gBAC/B,MAAM,IAAI,OAAO,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC;aACxC;YACD,KAAK,MAAM,SAAS,IAAI,OAAO,CAAC,aAAa,EAAE,EAAE;gBAC7C,MAAM,IAAI,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;aACxC;SACJ;QACD,OAAO,MAAM,CAAC;IAClB,CAAC;IAED,MAAM,CAAC,WAAW,CAAC,QAAgC;QAC/C,IAAI,MAAM,GAAW,EAAE,CAAC;QACxB,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE;YAC5B,MAAM,IAAI,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;SACtC;QACD,OAAO,MAAM,CAAC,IAAI,EAAE,CAAC;IACzB,CAAC;CACJ;AA9BD,yBA8BC"}

package/src/TSDoc/Generator.ts

@@ -1,45 +0,0 @@
-import FileSystem from "../IO/FileSystem";
-import FSPromises from "fs/promises";
-import Parser from "./Parser";
-import path from "path";
-import TestName from "../Framework/TestName";
-import Markdown from "./Markdown";
-import {DocComment} from "@microsoft/tsdoc";
-
-export default class Generator {
-    constructor(private readonly fs: FileSystem, private readonly fs_promises: typeof FSPromises, private readonly parser: Parser) {
-    }
-
-    async run(dir: string, out_dir: string): Promise<void> {
-        const files = await this.fs.getFiles(dir);
-        const tasks = files.map(file => this.generate(file, out_dir));
-        await Promise.all(tasks);
-    }
-
-    private async generate(file: string, out_path: string) {
-        const code = await this.fs_promises.readFile(file);
-        const doc = await this.parser.findDoc(code.toString());
-
-        const [base, dir, filename] = file.split(path.sep);
-        const md = Generator.getMarkdown(filename, doc);
-
-        if (md !== null) {
-            const out = path.join(out_path, file.substr(base.length + 1)).replace(/\.ts$/, '.md');
-            await this.fs_promises.mkdir(path.join(out_path, dir), {recursive: true});
-            await this.fs_promises.writeFile(out, md);
-        }
-    }
-
-    private static getMarkdown(filename: string, doc: DocComment): string | null {
-        const summary = Parser.renderNodes(doc.summarySection.nodes);
-        if (!summary) {
-            return null;
-        }
-
-        const title = TestName.toSentenceCase(filename?.split('.')[0] ?? '');
-        const example = Parser.renderNodes(doc.customBlocks.filter(b => b.blockTag.tagName == '@example')[0]?.content.nodes ?? []);
-        const remarks = Parser.renderNodes(doc.remarksBlock?.content.nodes ?? []);
-        const params = doc.params.blocks.map(p => `| \`${p.parameterName}\` | ${Parser.renderNodes(p.content.nodes)} |`).join('\n');
-        return Markdown.render(title, summary, example, remarks, params);
-    }
-}