@code-pushup/cli 0.4.1 → 0.4.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 +11 -0
- package/index.js +8 -9
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -128,6 +128,17 @@ jobs:
|
|
|
128
128
|
- run: npx code-pushup autorun --upload.apiKey=${{ secrets.PORTAL_API_KEY }}
|
|
129
129
|
```
|
|
130
130
|
|
|
131
|
+
## Custom Plugins
|
|
132
|
+
|
|
133
|
+
We provide comprehensive documentation on [how to create a custom plugin](./docs/custom-plugins.md).
|
|
134
|
+
|
|
135
|
+
The repository also maintains a set of plugin examples showcasing different scenarios.
|
|
136
|
+
Each example is fully tested to give demonstrate best practices for plugin testing.
|
|
137
|
+
|
|
138
|
+
**Example for custom plugins:**
|
|
139
|
+
|
|
140
|
+
- [File Size](../../examples/plugins/src/file-size)
|
|
141
|
+
|
|
131
142
|
## CLI commands and options
|
|
132
143
|
|
|
133
144
|
### Global Options
|
package/index.js
CHANGED
|
@@ -251,19 +251,18 @@ var auditGroupRefSchema = weightedRefSchema(
|
|
|
251
251
|
"Weighted references to audits",
|
|
252
252
|
"Reference slug to an audit within this plugin (e.g. 'max-lines')"
|
|
253
253
|
);
|
|
254
|
+
var auditGroupMetaSchema = metaSchema({
|
|
255
|
+
titleDescription: "Descriptive name for the group",
|
|
256
|
+
descriptionDescription: "Description of the group (markdown)",
|
|
257
|
+
docsUrlDescription: "Group documentation site",
|
|
258
|
+
description: "Group metadata"
|
|
259
|
+
});
|
|
254
260
|
var auditGroupSchema = scorableSchema(
|
|
255
261
|
'An audit group aggregates a set of audits into a single score which can be referenced from a category. E.g. the group slug "performance" groups audits and can be referenced in a category',
|
|
256
262
|
auditGroupRefSchema,
|
|
257
263
|
getDuplicateRefsInGroups,
|
|
258
264
|
duplicateRefsInGroupsErrorMsg
|
|
259
|
-
).merge(
|
|
260
|
-
metaSchema({
|
|
261
|
-
titleDescription: "Descriptive name for the group",
|
|
262
|
-
descriptionDescription: "Description of the group (markdown)",
|
|
263
|
-
docsUrlDescription: "Group documentation site",
|
|
264
|
-
description: "Group metadata"
|
|
265
|
-
})
|
|
266
|
-
);
|
|
265
|
+
).merge(auditGroupMetaSchema);
|
|
267
266
|
var auditGroupsSchema = z5.array(auditGroupSchema, {
|
|
268
267
|
description: "List of groups"
|
|
269
268
|
}).optional().refine(
|
|
@@ -1641,7 +1640,7 @@ function auditOutputsCorrelateWithPluginOutput(auditOutputs, pluginConfigAudits)
|
|
|
1641
1640
|
|
|
1642
1641
|
// packages/core/package.json
|
|
1643
1642
|
var name = "@code-pushup/core";
|
|
1644
|
-
var version = "0.4.
|
|
1643
|
+
var version = "0.4.3";
|
|
1645
1644
|
|
|
1646
1645
|
// packages/core/src/lib/implementation/collect.ts
|
|
1647
1646
|
async function collect(options2) {
|