@travetto/test 3.0.2 → 3.0.3

package/README.md

@@ -1,6 +1,7 @@
 <!-- This file was generated by @travetto/doc and should not be modified directly -->
-<!-- Please modify https://github.com/travetto/travetto/tree/main/module/test/DOC.ts and execute "npx trv doc" to rebuild -->
+<!-- Please modify https://github.com/travetto/travetto/tree/main/module/test/DOC.tsx and execute "npx trv doc" to rebuild -->
 # Testing
+
 ## Declarative test framework
 
 **Install: @travetto/test**
@@ -13,8 +14,6 @@ yarn add @travetto/test
 ```
 
 This module provides unit testing functionality that integrates with the framework. It is a declarative framework, using decorators to define tests and suites. The test produces results in the following formats:
-
-   
    *  [TAP 13](https://testanything.org/tap-version-13-specification.html), default and human-readable
    *  [JSON](https://www.json.org), best for integrating with at a code level
    *  [xUnit](https://en.wikipedia.org/wiki/XUnit), standard format for CI/CD systems e.g. Jenkins, Bamboo, etc.
@@ -22,8 +21,7 @@ This module provides unit testing functionality that integrates with the framewo
 **Note**: All tests should be under the `test/.*` folders.  The pattern for tests is defined as a regex and not standard globbing.
 
 ## Definition
-
-A test suite is a collection of individual tests.  All test suites are classes with the [@Suite](https://github.com/travetto/travetto/tree/main/module/test/src/decorator/suite.ts#L14) decorator. Tests are defined as methods on the suite class, using the [@Test](https://github.com/travetto/travetto/tree/main/module/test/src/decorator/test.ts#L20) decorator.  All tests intrinsically support `async`/`await`.
+A test suite is a collection of individual tests.  All test suites are classes with the [@Suite](https://github.com/travetto/travetto/tree/main/module/test/src/decorator/suite.ts#L14) decorator. Tests are defined as methods on the suite class, using the [@Test](https://github.com/travetto/travetto/tree/main/module/test/src/decorator/test.ts#L20) decorator.  All tests intrinsically support `async`/`await`. 
 
 A simple example would be:
 
@@ -112,8 +110,6 @@ AssertionError(
 ```
 
 The equivalences for all of the [assert](https://nodejs.org/api/assert.html) operations are:
-
-   
    *  `assert(a == b)` as `assert.equal(a, b)`
    *  `assert(a !== b)` as `assert.notEqual(a, b)`
    *  `assert(a === b)` as `assert.strictEqual(a, b)`
@@ -125,65 +121,62 @@ The equivalences for all of the [assert](https://nodejs.org/api/assert.html) ope
    *  `assert(a instanceof b)` as `assert.instanceOf(a, b)`
    *  `assert(a.includes(b))` as `assert.ok(a.includes(b))`
    *  `assert(/a/.test(b))` as `assert.ok(/a/.test(b))`
-
 In addition to the standard operations, there is support for throwing/rejecting errors (or the inverse).  This is useful for testing error states or ensuring errors do not occur.
 
-   
-   *  `throws`/`doesNotThrow` is for catching synchronous rejections
-     
-   **Code: Throws vs Does Not Throw**
-   ```typescript
-   import assert from 'assert';
-   
-   import { Suite, Test } from '@travetto/test';
-   
-   @Suite()
-   class SimpleTest {
-   
-     @Test()
-     async testThrows() {
-       assert.throws(() => {
-         throw new Error();
-       });
-   
-       assert.doesNotThrow(() => {
-   
-         let a = 5;
-       });
-     }
-   }
-   ```
-   
-     
-   *  `rejects`/`doesNotReject` is for catching asynchronous rejections
-     
-   **Code: Rejects vs Does Not Reject**
-   ```typescript
-   import assert from 'assert';
-   
-   import { Suite, Test } from '@travetto/test';
-   
-   @Suite()
-   class SimpleTest {
-   
-     @Test()
-     async testRejects() {
-       await assert.rejects(async () => {
-         throw new Error();
-       });
-   
-       await assert.doesNotReject(async () => {
-   
-         let a = 5;
-       });
-     }
-   }
-   ```
-   
-     
-
-Additionally, the `throws`/`rejects` assertions take in a secondary parameter to allow for specification of the type of error expected.  This can be:
-   
+### Throws
+`throws`/`doesNotThrow` is for catching synchronous rejections
+
+**Code: Throws vs Does Not Throw**
+```typescript
+import assert from 'assert';
+
+import { Suite, Test } from '@travetto/test';
+
+@Suite()
+class SimpleTest {
+
+  @Test()
+  async testThrows() {
+    assert.throws(() => {
+      throw new Error();
+    });
+
+    assert.doesNotThrow(() => {
+
+      let a = 5;
+    });
+  }
+}
+```
+
+### Rejects
+`rejects`/`doesNotReject` is for catching asynchronous rejections
+
+**Code: Rejects vs Does Not Reject**
+```typescript
+import assert from 'assert';
+
+import { Suite, Test } from '@travetto/test';
+
+@Suite()
+class SimpleTest {
+
+  @Test()
+  async testRejects() {
+    await assert.rejects(async () => {
+      throw new Error();
+    });
+
+    await assert.doesNotReject(async () => {
+
+      let a = 5;
+    });
+  }
+}
+```
+
+### Error Matching
+Additionally, the `throws`/`rejects` assertions take in a secondary parameter to allow for specification of the type of error expected. This can be:
    *  A regular expression or string to match against the error's message
    *  A class to ensure the returned error is an instance of the class passed in
    *  A function to allow for whatever custom verification of the error is needed
@@ -221,7 +214,6 @@ class SimpleTest {
 ```
 
 ## Running Tests
-
 To run the tests you can either call the [Command Line Interface](https://github.com/travetto/travetto/tree/main/module/cli#readme "CLI infrastructure for Travetto framework") by invoking
 
 **Terminal: Test Help Output**
@@ -240,10 +232,9 @@ Options:
 The regexes are the patterns of tests you want to run, and all tests must be found under the `test/` folder.
 
 ### Travetto Plugin
-
 The [VSCode plugin](https://marketplace.visualstudio.com/items?itemName=arcsine.travetto-plugin) also supports test running,  which will provide even more functionality for real-time testing and debugging.
 
 ## Additional Considerations
-During the test execution, a few things additionally happen that should be helpful.  The primary addition, is that all console output is captured, and will be exposed in the test output.  This allows for investigation at a later point in time by analyzing the output.
+During the test execution, a few things additionally happen that should be helpful.  The primary addition, is that all console output is captured, and will be exposed in the test output.  This allows for investigation at a later point in time by analyzing the output. 
 
 Like output, all promises are also intercepted.  This allows the code to ensure that all promises have been resolved before completing the test.  Any uncompleted promises will automatically trigger an error state and fail the test.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@travetto/test",
-  "version": "3.0.2",
+  "version": "3.0.3",
   "description": "Declarative test framework",
   "keywords": [
     "unit-testing",
@@ -27,15 +27,15 @@
     "directory": "module/test"
   },
   "dependencies": {
-    "@travetto/base": "^3.0.2",
-    "@travetto/registry": "^3.0.2",
-    "@travetto/terminal": "^3.0.2",
-    "@travetto/worker": "^3.0.2",
-    "@travetto/yaml": "^3.0.2"
+    "@travetto/base": "^3.0.3",
+    "@travetto/registry": "^3.0.3",
+    "@travetto/terminal": "^3.0.3",
+    "@travetto/worker": "^3.0.3",
+    "@travetto/yaml": "^3.0.3"
   },
   "peerDependencies": {
-    "@travetto/cli": "^3.0.2",
-    "@travetto/transformer": "^3.0.2"
+    "@travetto/cli": "^3.0.3",
+    "@travetto/transformer": "^3.0.3"
   },
   "peerDependenciesMeta": {
     "@travetto/transformer": {