Skip to content

Commit a383080

Browse files
aramirezjaramirezj
committed
fix(plugin-jsdocs-e2e): fix e2e snapshopt
1 parent cc808be commit a383080

File tree

2 files changed

+228
-0
lines changed

2 files changed

+228
-0
lines changed

‎e2e/plugin-jsdocs-e2e/tests/__snapshots__/report.json‎

Lines changed: 197 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,197 @@
1+
{
2+
"packageName": "@code-pushup/core",
3+
"plugins": [
4+
{
5+
"title": "JSDoc coverage",
6+
"slug": "jsdocs",
7+
"icon": "folder-docs",
8+
"description": "Official Code PushUp JSDoc coverage plugin.",
9+
"docsUrl": "https://www.npmjs.com/package/@code-pushup/jsdocs-plugin/",
10+
"groups": [
11+
{
12+
"slug": "documentation-coverage",
13+
"refs": [
14+
{
15+
"slug": "classes-coverage",
16+
"weight": 2
17+
},
18+
{
19+
"slug": "methods-coverage",
20+
"weight": 2
21+
},
22+
{
23+
"slug": "functions-coverage",
24+
"weight": 2
25+
},
26+
{
27+
"slug": "interfaces-coverage",
28+
"weight": 1
29+
},
30+
{
31+
"slug": "variables-coverage",
32+
"weight": 1
33+
},
34+
{
35+
"slug": "properties-coverage",
36+
"weight": 1
37+
},
38+
{
39+
"slug": "types-coverage",
40+
"weight": 1
41+
},
42+
{
43+
"slug": "enums-coverage",
44+
"weight": 1
45+
}
46+
],
47+
"title": "Documentation coverage",
48+
"description": "Documentation coverage"
49+
}
50+
],
51+
"audits": [
52+
{
53+
"slug": "enums-coverage",
54+
"displayValue": "0 undocumented enums",
55+
"value": 0,
56+
"score": 1,
57+
"details": {
58+
"issues": []
59+
},
60+
"title": "Enums coverage",
61+
"description": "Documentation coverage of enums"
62+
},
63+
{
64+
"slug": "interfaces-coverage",
65+
"displayValue": "0 undocumented interfaces",
66+
"value": 0,
67+
"score": 1,
68+
"details": {
69+
"issues": []
70+
},
71+
"title": "Interfaces coverage",
72+
"description": "Documentation coverage of interfaces"
73+
},
74+
{
75+
"slug": "types-coverage",
76+
"displayValue": "0 undocumented types",
77+
"value": 0,
78+
"score": 1,
79+
"details": {
80+
"issues": []
81+
},
82+
"title": "Types coverage",
83+
"description": "Documentation coverage of types"
84+
},
85+
{
86+
"slug": "functions-coverage",
87+
"displayValue": "2 undocumented functions",
88+
"value": 2,
89+
"score": 0.3333,
90+
"details": {
91+
"issues": [
92+
{
93+
"message": "Missing functions documentation for notRealisticFunction",
94+
"severity": "warning",
95+
"source": {
96+
"file": "tmp/e2e/plugin-jsdocs-e2e/__test__/angular/src/app.component.spec.ts",
97+
"position": {
98+
"startLine": 1
99+
}
100+
}
101+
},
102+
{
103+
"message": "Missing functions documentation for mapEventToCustomEvent",
104+
"severity": "warning",
105+
"source": {
106+
"file": "tmp/e2e/plugin-jsdocs-e2e/__test__/angular/src/map-event.function.ts",
107+
"position": {
108+
"startLine": 3
109+
}
110+
}
111+
}
112+
]
113+
},
114+
"title": "Functions coverage",
115+
"description": "Documentation coverage of functions"
116+
},
117+
{
118+
"slug": "variables-coverage",
119+
"displayValue": "1 undocumented variables",
120+
"value": 1,
121+
"score": 0,
122+
"details": {
123+
"issues": [
124+
{
125+
"message": "Missing variables documentation for someVariable",
126+
"severity": "warning",
127+
"source": {
128+
"file": "tmp/e2e/plugin-jsdocs-e2e/__test__/angular/src/map-event.function.ts",
129+
"position": {
130+
"startLine": 1
131+
}
132+
}
133+
}
134+
]
135+
},
136+
"title": "Variables coverage",
137+
"description": "Documentation coverage of variables"
138+
},
139+
{
140+
"slug": "classes-coverage",
141+
"displayValue": "0 undocumented classes",
142+
"value": 0,
143+
"score": 1,
144+
"details": {
145+
"issues": []
146+
},
147+
"title": "Classes coverage",
148+
"description": "Documentation coverage of classes"
149+
},
150+
{
151+
"slug": "methods-coverage",
152+
"displayValue": "1 undocumented methods",
153+
"value": 1,
154+
"score": 0.5,
155+
"details": {
156+
"issues": [
157+
{
158+
"message": "Missing methods documentation for sendEvent",
159+
"severity": "warning",
160+
"source": {
161+
"file": "tmp/e2e/plugin-jsdocs-e2e/__test__/angular/src/app.component.ts",
162+
"position": {
163+
"startLine": 15
164+
}
165+
}
166+
}
167+
]
168+
},
169+
"title": "Methods coverage",
170+
"description": "Documentation coverage of methods"
171+
},
172+
{
173+
"slug": "properties-coverage",
174+
"displayValue": "1 undocumented properties",
175+
"value": 1,
176+
"score": 0,
177+
"details": {
178+
"issues": [
179+
{
180+
"message": "Missing properties documentation for title",
181+
"severity": "warning",
182+
"source": {
183+
"file": "tmp/e2e/plugin-jsdocs-e2e/__test__/angular/src/app.component.ts",
184+
"position": {
185+
"startLine": 5
186+
}
187+
}
188+
}
189+
]
190+
},
191+
"title": "Properties coverage",
192+
"description": "Documentation coverage of properties"
193+
}
194+
]
195+
}
196+
]
197+
}

‎e2e/plugin-jsdocs-e2e/tests/__snapshots__/report.txt‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
Code PushUp CLI
2+
[ info ] Run collect...
3+
Code PushUp Report - @code-pushup/core@0.57.0
4+
5+
6+
JSDoc coverage audits
7+
8+
● Properties coverage 1 undocumented
9+
properties
10+
● Variables coverage 1 undocumented
11+
variables
12+
● Functions coverage 2 undocumented
13+
functions
14+
● Methods coverage 1 undocumented
15+
methods
16+
● ... 4 audits with perfect scores omitted for brevity ...
17+
18+
Made with ❤ by code-pushup.dev
19+
20+
[ success ] Collecting report successful!
21+
[ info ] 💡 Configure categories to see the scores in an overview table. See: https://github.com/code-pushup/cli/blob/main/packages/cli/README.md
22+
╭────────────────────────────────────────────────────────────────────────────────────────────╮
23+
│ │
24+
│ 💡 Visualize your reports │
25+
│ │
26+
│ ❯ npx code-pushup upload - Run upload to upload the created report to the server │
27+
│ https://github.com/code-pushup/cli/tree/main/packages/cli#upload-command │
28+
│ ❯ npx code-pushup autorun - Run collect & upload │
29+
│ https://github.com/code-pushup/cli/tree/main/packages/cli#autorun-command │
30+
│ │
31+
╰────────────────────────────────────────────────────────────────────────────────────────────╯

0 commit comments

Comments
 (0)