xunit.ts 1.0.2 → 1.2.0

package/README.md

@@ -1,132 +0,0 @@
-![xunit.ts logo](docs/assets/logo.png)
-# xunit.ts
-### A TypeScript unit testing framework, following standard xUnit patterns
-
-[![npm version](https://img.shields.io/npm/v/xunit.ts?logo=npm&label=Install)](https://npmjs.com/package/xunit.ts)
-[![CI status](https://github.com/ecoAPM/xunit.ts/workflows/CI/badge.svg)](https://github.com/ecoAPM/xunit.ts/actions)
-[![Code Coverage](https://sonarcloud.io/api/project_badges/measure?project=ecoAPM_xunit.ts&metric=coverage)](https://sonarcloud.io/dashboard?id=ecoAPM_xunit.ts)
-
-[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=ecoAPM_xunit.ts&metric=sqale_rating)](https://sonarcloud.io/dashboard?id=ecoAPM_xunit.ts)
-[![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=ecoAPM_xunit.ts&metric=reliability_rating)](https://sonarcloud.io/dashboard?id=ecoAPM_xunit.ts)
-[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=ecoAPM_xunit.ts&metric=security_rating)](https://sonarcloud.io/dashboard?id=ecoAPM_xunit.ts)
-
-## Documentation
-
-Detailed documentation is available at https://ecoAPM.github.io/xunit.ts
-
-## Quick Start
-
-### Requirements
-
-- Node.js 16
-
-  (older versions may work, but only the latest LTS is actively supported)
-
-### Installation
-
-`npm install --dev xunit.ts`
-
-or
-
-`yarn add --dev xunit.ts`
-
-### Configure your test project
-
-At a minimum, your `tsconfig.json` will require the following:
-
-```json
-{
-    "compilerOptions": {
-        "target": "ES5", //or "ES6"
-        "module": "CommonJS",
-        "experimentalDecorators": true
-    }
-}
-```
-
-If you're using `rollup` or `vite`, you'll need to set `xunit.ts` as an `external` in your build config file (under `rollupOptions` in `vite`) for the tests to be detected.
-
-### Create your first test
-
-`MyTestSuite.ts`:
-
-```ts
-import { Test, TestSuite } from 'xunit.ts';
-
-export default class MyTestSuite extends TestSuite {
-    @Test()
-    async MyFirstTest() {
-        this.assert.equal(2, 1 + 1);
-    }
-}
-```
-
-### Run your tests
-
-You'll need to compile your TypeScript tests into JavaScript using `tsc` or a bundler such as `rollup`, `parcel`, `vite`, etc. (these are the supported ones, feel free to add your favorite to the `compiler-tests` directory!)
-
-Then run:
-
-`npm run xunit compiled_tests_dir`
-
-or
-
-`yarn xunit compiled_tests_dir`
-
-to run the tests.
-
-You can also run `xunit.ts` from a script in your `package.json`:
-
-```json
-{
-    "scripts": {
-        "test": "tsc --outDir compiled_tests_dir && xunit compiled_tests_dir"
-    }
-}
-```
-
-## Output
-
-### Console
-
-By default, `xunit.ts` will output test results to `stdout` so they can be captured by your terminal, or piped elsewhere:
-
-```
-~/example $ npm run test
-
-My Test Suite
-  ✓ My First Test
-
-    Passed: 1
-     Total: 1
-
-~/example $ _ 
-```
-
-See the [full documentation](https://ecoAPM.github.io/xunit.ts) for a list of all available output options.
-
-## Assertions
-
-`xunit.ts` has a built-in assertion library, accessible via `this.assert...` from within a `TestSuite`, or you can use your favorite third-party one: anything that uses Node.js' `AssertionError` is supported.
-
-If you prefer, you can `import { Assert } from 'xunit.ts` and call e.g. `Assert.true(expression);` instead of `this.assert.true(expression);` for any included assertion.
-
-See the [full documentation](https://ecoAPM.github.io/xunit.ts) for a list of all available assertions.
-
-## Contributing
-
-Please be sure to read and follow ecoAPM's [Contribution Guidelines](CONTRIBUTING.md) when submitting issues or pull requests.
-
-### Building / Testing locally
-
-1. `npm install` or `yarn install` to download all dependencies
-2. `npm run build` or `yarn build` will compile `xunit.ts` and its tests to the `dist` directory
-3. `npm run test` or `yarn test` will run all unit tests in `dist/tests`
-4. `npm run build && npm run test` or `yarn build && yarn test` will build and run tests in a single step
-
-### Missing an assertion?
-
-Create an issue or submit a pull request!
-1. Add a new function to `src/Assertions`
-2. Add tests for both the positive and negative cases in `tests/Assertions`
-3. Add a field for the assertion to `src/Assertions/index.ts`

package/SECURITY.md

@@ -1,11 +0,0 @@
-# Security Policy
-
-## Supported Versions
-
-Security updates are generally only applied to the newest release, and backported on an as-needed basis where appropriate.
-
-## Reporting a Vulnerability
-
-Unless a vulnerability is deemed critical or exposes PII, please create an issue in this repository using the "Report a Bug" template.
-
-For critical vulnerabilities, or those that expose PII, please email info@ecoAPM.com so that the issue can be fixed confidentially, prior to public disclosure.

package/icon.svg

@@ -1,83 +0,0 @@
-<?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"
-   sodipodi:docname="icon.svg"
-   inkscape:version="1.0 (4035a4fb49, 2020-05-01)"
-   inkscape:export-ydpi="96"
-   inkscape:export-xdpi="96"
-   inkscape:export-filename="X:\ecoAPM\xunit.ts\docs\assets\icon.png"
-   id="svg875"
-   version="1.1"
-   viewBox="0 0 128 128"
-   height="128"
-   width="128">
-  <defs
-     id="defs869" />
-  <sodipodi:namedview
-     inkscape:window-maximized="1"
-     inkscape:window-y="58"
-     inkscape:window-x="1912"
-     inkscape:window-height="987"
-     inkscape:window-width="1680"
-     width="128mm"
-     units="px"
-     showgrid="false"
-     inkscape:document-rotation="0"
-     inkscape:current-layer="layer1"
-     inkscape:document-units="px"
-     inkscape:cy="71.552618"
-     inkscape:cx="79.729008"
-     inkscape:zoom="3.959798"
-     inkscape:pageshadow="2"
-     inkscape:pageopacity="0.0"
-     borderopacity="1.0"
-     bordercolor="#666666"
-     pagecolor="#ffffff"
-     id="base" />
-  <metadata
-     id="metadata872">
-    <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">
-    <g
-       transform="matrix(-3.7139957,0,0,3.7296926,884.38404,-159.89924)"
-       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.99789345,1.002111)"
-       xml:space="preserve"
-       style="font-style:normal;font-weight:normal;font-size:189.069px;line-height:1.25;font-family:sans-serif;fill:#538d43;fill-opacity:1;stroke:none;stroke-width:0.984735"
-       x="-11.659032"
-       y="150.47607"
-       id="text2766"><tspan
-         sodipodi:role="line"
-         id="tspan2764"
-         x="-11.659032"
-         y="150.47607"
-         style="font-size:189.069px;fill:#538d43;fill-opacity:1;stroke-width:0.984735">🗸</tspan></text>
-  </g>
-</svg>

package/logo.svg

@@ -1,154 +0,0 @@
-<?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/sonar-project.properties

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