xunit.ts 1.0.1 → 1.1.0

package/logo.svg

@@ -1,112 +1,112 @@
 <?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
+		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:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
+		xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
+		xmlns="http://www.w3.org/2000/svg"
+		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
+         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
+		<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"
@@ -114,41 +114,41 @@
          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
+				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>
+	</g>
 </svg>

package/package.json

@@ -1,38 +1,45 @@
 {
-  "name": "xunit.ts",
-  "version": "1.0.1",
-  "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.5.2",
-    "xml": "1.0.1"
-  },
-  "devDependencies": {
-    "@microsoft/tsdoc": "0.13.2",
-    "@types/command-line-args": "5.2.0",
-    "@types/command-line-usage": "5.0.2",
-    "@types/lodash.isequal": "4.5.5",
-    "@types/node": "16.11.10",
-    "@types/xml": "1.0.6",
-    "notosans": "5.0.0",
-    "ts-mockito": "2.6.1",
-    "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/* docs/assets &&  ts-node tsdoc.ts"
-  },
-  "bin": {
-    "xunit": "dist/cli.js"
-  }
-}
+	"name": "xunit.ts",
+	"version": "1.1.0",
+	"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.1",
+		"command-line-usage": "6.1.1",
+		"lodash.isequal": "4.5.0",
+		"xml": "1.0.1"
+	},
+	"devDependencies": {
+		"@microsoft/tsdoc": "0.13.2",
+		"@types/command-line-args": "5.2.0",
+		"@types/command-line-usage": "5.0.2",
+		"@types/lodash.isequal": "4.5.5",
+		"@types/node": "17.0.19",
+		"@types/xml": "1.0.8",
+		"@typescript-eslint/eslint-plugin": "5.12.1",
+		"@typescript-eslint/parser": "5.12.1",
+		"eslint": "8.9.0",
+		"notosans": "5.0.0",
+		"ts-mockito": "2.6.1",
+		"ts-node": "10.5.0",
+		"typescript": "4.5.5"
+	},
+	"peerDependencies": {
+		"typescript": "^4.0.0"
+	},
+	"scripts": {
+		"clean": "rm -rf dist",
+		"build": "tsc",
+		"test": "node dist/cli.js dist/tests",
+		"xunit": "ts-node cli.ts",
+		"tsdoc": "cp -r node_modules/notosans/* docs/assets && ts-node tsdoc.ts"
+	},
+	"bin": {
+		"xunit": "dist/cli.js"
+	}
+}

package/src/Assertions/Contains.ts

@@ -2,10 +2,10 @@ import { AssertionError } from "assert";
 
 /**
  * Asserts that an array contains a given element
- * 
+ *
  * @remarks
  * Passes if array `haystack` contains an element with a value of `needle`
- * 
+ *
  * Fails if array `haystack` does not contain an element with a value of `needle`
  *
  * @param needle the element to find
@@ -16,13 +16,13 @@ import { AssertionError } from "assert";
  * this.assert.contains(needle, haystack);
  */
 export default function Contains<T>(needle: T, haystack: ReadonlyArray<T>, message?: string) {
-    if(haystack.includes(needle)) {
-        return;
-    }
+	if (haystack.includes(needle)) {
+		return;
+	}
 
-    throw new AssertionError({
-        message: message || 'Expected array containing expression, but array did not contain expression',
-        expected: needle,
-        actual: haystack
-    });
+	throw new AssertionError({
+		message: message || "Expected array containing expression, but array did not contain expression",
+		expected: needle,
+		actual: haystack
+	});
 }

package/src/Assertions/Count.ts

@@ -2,27 +2,27 @@ import { AssertionError } from "assert";
 
 /**
  * Asserts that an array contains a certain number of elements
- * 
+ *
  * @remarks
  * Passes if `array` contains `expected` number of elements
- * 
+ *
  * Fails if `array` does not contain `expected` number of elements
  *
  * @param expected the number of array elements expected
  * @param array the array to check the length of
  * @param message (optional) message to display on failure
- * 
+ *
  * @example
  * this.assert.count(expected, array);
  */
 export default function Count(expected: number, array: ReadonlyArray<any>, message?: string) {
-    if(array.length === expected) {
-        return;
-    }
+	if (array.length === expected) {
+		return;
+	}
 
-    throw new AssertionError({
-        message: message || `Expected array with ${expected} elements, but array had ${array.length} elements`,
-        expected: expected,
-        actual: array.length
-    });
+	throw new AssertionError({
+		message: message || `Expected array with ${expected} elements, but array had ${array.length} elements`,
+		expected: expected,
+		actual: array.length
+	});
 }

package/src/Assertions/Defined.ts

@@ -2,26 +2,26 @@ import { AssertionError } from "assert";
 
 /**
  * Asserts that a value is defined (any value other than `undefined`)
- * 
+ *
  * @remarks
  * Passes if `expression` does not evaluate to `undefined`
- * 
+ *
  * Fails if `expression` evaluates to `undefined`
  *
  * @param expression the value to check
  * @param message (optional) message to display on failure
- * 
+ *
  * @example
  * this.assert.defined(expression);
  */
 export default function Defined(expression: any, message?: string) {
-    if(expression !== undefined) {
-        return;
-    }
+	if (expression !== undefined) {
+		return;
+	}
 
-    throw new AssertionError({
-        message: message || 'Expected expression to be defined, but expression is undefined',
-        expected: '(not undefined expression)',
-        actual: expression
-    });
+	throw new AssertionError({
+		message: message || "Expected expression to be defined, but expression is undefined",
+		expected: "(not undefined expression)",
+		actual: expression
+	});
 }

package/src/Assertions/DoesNotContain.ts

@@ -2,27 +2,27 @@ import { AssertionError } from "assert";
 
 /**
  * Asserts that an array does not contain a given element
- * 
+ *
  * @remarks
  * Passes if array `haystack` does not contain an element with a value of `needle`
- * 
+ *
  * Fails if array `haystack` contains an element with a value of `needle`
  *
  * @param needle the element to find
  * @param haystack the array to search
  * @param message (optional) message to display on failure
- * 
+ *
  * @example
  * this.assert.doesNotContain(needle, haystack);
  */
 export default function DoesNotContain<T>(needle: T, haystack: ReadonlyArray<T>, message?: string) {
-    if(!haystack.includes(needle)) {
-        return;
-    }
+	if (!haystack.includes(needle)) {
+		return;
+	}
 
-    throw new AssertionError({
-        message: message || 'Expected array not containing expression, but array contained expression',
-        expected: needle,
-        actual: haystack
-    });
+	throw new AssertionError({
+		message: message || "Expected array not containing expression, but array contained expression",
+		expected: needle,
+		actual: haystack
+	});
 }

package/src/Assertions/DoesNotThrow.ts

@@ -2,27 +2,27 @@ import { AssertionError } from "assert";
 
 /**
  * Asserts that an expression does not throw an error/exception
- * 
+ *
  * @remarks
  * Passes if calling `expression` does not throw an error/exception
- * 
+ *
  * Fails if calling `expression` throws an error/exception
  *
  * @param expression the expression to run
  * @param message (optional) message to display on failure
- * 
+ *
  * @example
  * this.assert.doesNotThrow(() => expression);
  */
 export default function DoesNotThrow(expression: () => any, message?: string) {
-    try {
-        expression();
-        return;
-    } catch (exception) {
-        throw new AssertionError({
-            message: message || 'Expected expression to not throw exception, but expression did throw exception',
-            expected: '(no exception)',
-            actual: exception
-        });
-    }
+	try {
+		expression();
+		return;
+	} catch (exception) {
+		throw new AssertionError({
+			message: message || "Expected expression to not throw exception, but expression did throw exception",
+			expected: "(no exception)",
+			actual: exception
+		});
+	}
 }

package/src/Assertions/Empty.ts

@@ -2,26 +2,26 @@ import { AssertionError } from "assert";
 
 /**
  * Asserts that an array is empty
- * 
+ *
  * @remarks
  * Passes if `array` contains zero elements
- * 
+ *
  * Fails if `array` contains any elements
  *
  * @param array the array to check
  * @param message (optional) message to display on failure
- * 
+ *
  * @example
  * this.assert.empty(array);
  */
 export default function Empty(array: ReadonlyArray<any>, message?: string) {
-    if(array.length === 0) {
-        return;
-    }
+	if (array.length === 0) {
+		return;
+	}
 
-    throw new AssertionError({
-        message: message || 'Expected expression to be empty, but expression was not empty',
-        expected: [],
-        actual: array
-    })
+	throw new AssertionError({
+		message: message || "Expected expression to be empty, but expression was not empty",
+		expected: [],
+		actual: array
+	});
 }