storybook_vitest_addon 0.1.0 → 0.1.2

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 (3) hide show
  1. package/README.md +26 -9
  2. package/package.json +1 -1
  3. package/CHANGELOG.md +0 -101
package/README.md CHANGED
@@ -7,9 +7,20 @@
7
7
  Installation:
8
8
 
9
9
  ```
10
- yarn add --dev storybook_vitest_addon
10
+ yarn add storybook_vitest_addon
11
11
  ```
12
12
 
13
+ Compatibility:
14
+
15
+ ```
16
+ "storybook": "^7.5.2",
17
+ "@storybook/react": "^7.5.2",
18
+ "vite": "^4.5.0",
19
+ "vitest": "^0.34.6"
20
+ ```
21
+
22
+ Usage:
23
+
13
24
  Addon meant to display Vitest unit test results in a new Stoybook panel. Developed and tested with React.
14
25
  Simply add it to the addon list in your Storybook config, and then you can use it in any story.
15
26
 
@@ -19,21 +30,27 @@ It needs 2 params: `testResults` - test results file in json format and `testFil
19
30
  Example usage:
20
31
 
21
32
  ```
33
+
22
34
  // Button.stories.tsx
23
35
 
24
36
  import vitestResults from "./unit-test-results.json";
25
37
  /.../
26
38
  export default {
27
- title: "Example/Button",
28
- component: Button,
29
- parameters: {
30
- vitest: {
31
- testFile: "Button.test.tsx",
32
- testResults: vitestResults,
33
- },
34
- },
39
+ title: "Example/Button",
40
+ component: Button,
41
+ parameters: {
42
+ vitest: {
43
+ testFile: "Button.test.tsx",
44
+ testResults: vitestResults,
45
+ },
46
+ },
35
47
  };
36
48
  /.../
49
+
37
50
  ```
38
51
 
39
52
  ![](2022-04-01-22-48-00.png)
53
+
54
+ ```
55
+
56
+ ```
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "storybook_vitest_addon",
3
- "version": "0.1.0",
3
+ "version": "0.1.2",
4
4
  "description": "Adds a panel to display Vitest unit test results",
5
5
  "keywords": [
6
6
  "storybook-addons",
package/CHANGELOG.md DELETED
@@ -1,101 +0,0 @@
1
- # v0.0.8 (Fri Apr 15 2022)
2
-
3
- #### ⚠️ Pushed to `main`
4
-
5
- - Update README.md ([@krzysztofradomski](https://github.com/krzysztofradomski))
6
-
7
- #### Authors: 1
8
-
9
- - Krzysztof "Chris" Radomski ([@krzysztofradomski](https://github.com/krzysztofradomski))
10
-
11
- ---
12
-
13
- # v0.0.7 (Tue Apr 12 2022)
14
-
15
- #### ⚠️ Pushed to `main`
16
-
17
- - update readme (krzysztof.radomski@netigate.se)
18
- - fix: dont show panel contents when not active (krzysztof.radomski@netigate.se)
19
- - fix: dont show panel contents if not configured (krzysztof.radomski@netigate.se)
20
-
21
- #### Authors: 1
22
-
23
- - Krzysztof Radomski (krzysztof.radomski@netigate.se)
24
-
25
- ---
26
-
27
- # v0.0.6 (Fri Apr 01 2022)
28
-
29
- #### ⚠️ Pushed to `main`
30
-
31
- - match breaking change in vitest v0.8.0 (krzysztof.radomski@netigate.se)
32
-
33
- #### Authors: 1
34
-
35
- - Krzysztof Radomski (krzysztof.radomski@netigate.se)
36
-
37
- ---
38
-
39
- # v0.0.5 (Sun Mar 27 2022)
40
-
41
- #### ⚠️ Pushed to `main`
42
-
43
- - Merge branch 'main' of https://github.com/krzysztofradomski/storybook-addon-vitest (krzysztof.radomski@netigate.se)
44
- - update readme file (krzysztof.radomski@netigate.se)
45
- - improve config error messages (krzysztof.radomski@netigate.se)
46
-
47
- #### Authors: 1
48
-
49
- - Krzysztof Radomski (krzysztof.radomski@netigate.se)
50
-
51
- ---
52
-
53
- # v0.0.4 (Sun Mar 27 2022)
54
-
55
- #### ⚠️ Pushed to `main`
56
-
57
- - fix keywords order (krzysztof.radomski@netigate.se)
58
-
59
- #### Authors: 1
60
-
61
- - Krzysztof Radomski (krzysztof.radomski@netigate.se)
62
-
63
- ---
64
-
65
- # v0.0.3 (Sun Mar 27 2022)
66
-
67
- #### ⚠️ Pushed to `main`
68
-
69
- - add important keyword (krzysztof.radomski@netigate.se)
70
-
71
- #### Authors: 1
72
-
73
- - Krzysztof Radomski (krzysztof.radomski@netigate.se)
74
-
75
- ---
76
-
77
- # v0.0.2 (Sun Mar 27 2022)
78
-
79
- #### ⚠️ Pushed to `main`
80
-
81
- - update keywords and readme (krzysztof.radomski@netigate.se)
82
-
83
- #### Authors: 1
84
-
85
- - Krzysztof Radomski (krzysztof.radomski@netigate.se)
86
-
87
- ---
88
-
89
- # v0.0.1 (Sun Mar 27 2022)
90
-
91
- #### ⚠️ Pushed to `main`
92
-
93
- - remove postinstall script (krzysztof.radomski@netigate.se)
94
- - initial commit (krzysztof.radomski@netigate.se)
95
- - project setup (krzysztof.radomski@netigate.se)
96
- - Initial commit ([@krzysztofradomski](https://github.com/krzysztofradomski))
97
-
98
- #### Authors: 2
99
-
100
- - Krzysztof "Chris" Radomski ([@krzysztofradomski](https://github.com/krzysztofradomski))
101
- - Krzysztof Radomski (krzysztof.radomski@netigate.se)