@redproof/testing 0.5.0 → 0.6.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +46 -0
  2. package/package.json +3 -2
package/README.md ADDED
@@ -0,0 +1,46 @@
1
+ # @redproof/testing
2
+
3
+ Redproof adapter for test suites. It reads a JUnit XML report, so any runner that writes one becomes a Redproof Gate you can prove.
4
+
5
+ Part of [Redproof](https://github.com/schalermthai/redproof). Redproof does not
6
+ just run your guardrails. It proves they can fail.
7
+
8
+ ## Install
9
+
10
+ ```bash
11
+ npm install --save-dev @redproof/testing redproof
12
+ ```
13
+
14
+ ## Use
15
+
16
+ ```ts
17
+ // gates/unit-tests.ts
18
+ import { vitest } from '@redproof/testing';
19
+ import { defineGate } from 'redproof';
20
+
21
+ const adapter = vitest({
22
+ configFile: 'vitest.config.js',
23
+ rules: {
24
+ testsPass: true,
25
+ noSkippedTests: true,
26
+ noTodoTests: true,
27
+ },
28
+ });
29
+
30
+ export default defineGate({ id: 'unit-tests', adapter });
31
+ ```
32
+
33
+ Then run:
34
+
35
+ ```bash
36
+ npx redproof check # do the rules hold right now?
37
+ npx redproof prove # can each rule actually fail?
38
+ ```
39
+
40
+ ## Documentation
41
+
42
+ See the [Redproof documentation](https://github.com/schalermthai/redproof#readme).
43
+
44
+ ## License
45
+
46
+ Apache-2.0
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@redproof/testing",
3
- "version": "0.5.0",
3
+ "version": "0.6.0",
4
4
  "description": "Redproof adapter for test suites and JUnit XML reports.",
5
5
  "type": "module",
6
6
  "exports": {
@@ -9,6 +9,7 @@
9
9
  "default": "./dist/index.js"
10
10
  }
11
11
  },
12
+ "types": "./dist/index.d.ts",
12
13
  "files": [
13
14
  "dist"
14
15
  ],
@@ -16,7 +17,7 @@
16
17
  "node": ">=22.6"
17
18
  },
18
19
  "dependencies": {
19
- "redproof": "0.5.0"
20
+ "redproof": "0.6.0"
20
21
  },
21
22
  "repository": {
22
23
  "type": "git",