@testream/vitest-reporter 1.2.2 → 1.2.3
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.
- package/README.md +32 -7
- package/package.json +16 -9
package/README.md
CHANGED
|
@@ -1,8 +1,17 @@
|
|
|
1
|
-
# @testream/vitest-reporter
|
|
1
|
+
# @testream/vitest-reporter: Vitest test reporting for Jira
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
`@testream/vitest-reporter` publishes fast Vitest unit and frontend test results from CI/CD to Testream as durable, Jira-visible evidence. Vitest remains the execution source, so teams do not need to recreate every automated test as a manual Jira case.
|
|
4
4
|
|
|
5
|
-
##
|
|
5
|
+
## What the reporter sends to Testream and Jira
|
|
6
|
+
|
|
7
|
+
- Passed, failed, skipped, and pending Vitest results
|
|
8
|
+
- Failure messages, stack traces, source locations, and bounded snippets
|
|
9
|
+
- Branch, commit, build, environment, and CI metadata
|
|
10
|
+
- Suite changes and trends for Jira work and release reviews
|
|
11
|
+
|
|
12
|
+
It fits Vite-based React, Vue, Angular, and other JavaScript or TypeScript projects that need automated test reporting connected to Jira.
|
|
13
|
+
|
|
14
|
+
## Install and configure
|
|
6
15
|
|
|
7
16
|
```bash
|
|
8
17
|
npm install --save-dev @testream/vitest-reporter
|
|
@@ -25,8 +34,24 @@ export default defineConfig({
|
|
|
25
34
|
})
|
|
26
35
|
```
|
|
27
36
|
|
|
28
|
-
The reporter enables Vitest `includeTaskLocation` automatically so generated
|
|
29
|
-
|
|
30
|
-
|
|
37
|
+
The reporter enables Vitest `includeTaskLocation` automatically so generated CTRF reports include line metadata and shared snippet enrichment can populate source evidence for JavaScript and TypeScript tests.
|
|
38
|
+
|
|
39
|
+
## Vitest evidence in CI/CD
|
|
40
|
+
|
|
41
|
+
Keep your normal Vitest command and store `TESTREAM_API_KEY` as a protected secret. The reporter publishes the completed run from GitHub Actions, GitLab CI/CD, Azure Pipelines, Jenkins, or another command-based CI provider. Testream then connects the results to Jira work and release context.
|
|
42
|
+
|
|
43
|
+
## Frequently asked questions
|
|
44
|
+
|
|
45
|
+
### Do we need to recreate automated tests as manual Jira cases?
|
|
46
|
+
|
|
47
|
+
No. Your Vitest suite remains the code-first execution source. Testream makes the results inspectable in Jira without introducing duplicate manual cases.
|
|
48
|
+
|
|
49
|
+
### Does it work outside React projects?
|
|
50
|
+
|
|
51
|
+
Yes. The reporter works with Vitest itself, including Vue, Angular, Vite, and other projects that use Vitest for unit or frontend testing.
|
|
52
|
+
|
|
53
|
+
## Official Testream resources
|
|
31
54
|
|
|
32
|
-
|
|
55
|
+
- [Vitest Jira integration](https://testream.app/vitest-jira-integration)
|
|
56
|
+
- [Complete Vitest reporter setup guide](https://docs.testream.app/reporters/vitest)
|
|
57
|
+
- [Install Testream – Automated Test Management for Jira](https://marketplace.atlassian.com/3048460704)
|
package/package.json
CHANGED
|
@@ -1,7 +1,8 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@testream/vitest-reporter",
|
|
3
|
-
"version": "1.2.
|
|
4
|
-
"description": "Vitest
|
|
3
|
+
"version": "1.2.3",
|
|
4
|
+
"description": "Publish Vitest test results, failures, source locations, and CI metadata to Testream and Jira.",
|
|
5
|
+
"homepage": "https://testream.app/vitest-jira-integration",
|
|
5
6
|
"main": "dist/cjs/index.js",
|
|
6
7
|
"module": "dist/esm/index.mjs",
|
|
7
8
|
"types": "dist/index.d.ts",
|
|
@@ -29,14 +30,20 @@
|
|
|
29
30
|
"url": "git+https://github.com/testream/docs.git"
|
|
30
31
|
},
|
|
31
32
|
"keywords": [
|
|
33
|
+
"testream",
|
|
32
34
|
"vitest",
|
|
33
|
-
"reporter",
|
|
34
|
-
"
|
|
35
|
-
"test-management",
|
|
36
|
-
"test-results",
|
|
35
|
+
"vitest-reporter",
|
|
36
|
+
"vitest-jira",
|
|
37
37
|
"jira",
|
|
38
|
+
"test-management",
|
|
39
|
+
"automated-test-management",
|
|
40
|
+
"test-reporting",
|
|
41
|
+
"ci-cd",
|
|
38
42
|
"ctrf",
|
|
39
|
-
"
|
|
43
|
+
"vite",
|
|
44
|
+
"react",
|
|
45
|
+
"vue",
|
|
46
|
+
"angular"
|
|
40
47
|
],
|
|
41
48
|
"author": "Testream",
|
|
42
49
|
"license": "SEE LICENSE IN LICENSE",
|
|
@@ -51,12 +58,12 @@
|
|
|
51
58
|
"@vercel/ncc": "^0.38.1",
|
|
52
59
|
"esbuild": "^0.28.1",
|
|
53
60
|
"vitest": "^4.1.9",
|
|
54
|
-
"@types/node": "^
|
|
61
|
+
"@types/node": "^25.9.3",
|
|
55
62
|
"@typescript-eslint/eslint-plugin": "^6.17.0",
|
|
56
63
|
"@typescript-eslint/parser": "^6.17.0",
|
|
57
64
|
"eslint": "^8.56.0",
|
|
58
65
|
"prettier": "^3.1.1",
|
|
59
|
-
"typescript": "^
|
|
66
|
+
"typescript": "^6.0.3"
|
|
60
67
|
},
|
|
61
68
|
"engines": {
|
|
62
69
|
"node": ">=18.0.0"
|