@code-pushup/core 0.61.0 → 0.63.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.
- package/package.json +3 -3
- package/src/lib/collect-and-persist.js +4 -5
- package/src/lib/collect-and-persist.js.map +1 -1
- package/src/lib/implementation/execute-plugin.d.ts +2 -3
- package/src/lib/implementation/execute-plugin.js +3 -4
- package/src/lib/implementation/execute-plugin.js.map +1 -1
- package/src/lib/implementation/runner.d.ts +3 -3
- package/src/lib/implementation/runner.js +12 -5
- package/src/lib/implementation/runner.js.map +1 -1
- package/src/lib/types.d.ts +0 -1
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@code-pushup/core",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.63.0",
|
|
4
4
|
"license": "MIT",
|
|
5
5
|
"description": "Core business logic for the used by the Code PushUp CLI",
|
|
6
6
|
"homepage": "https://github.com/code-pushup/cli/tree/main/packages/core#readme",
|
|
@@ -39,8 +39,8 @@
|
|
|
39
39
|
},
|
|
40
40
|
"type": "module",
|
|
41
41
|
"dependencies": {
|
|
42
|
-
"@code-pushup/models": "0.
|
|
43
|
-
"@code-pushup/utils": "0.
|
|
42
|
+
"@code-pushup/models": "0.63.0",
|
|
43
|
+
"@code-pushup/utils": "0.63.0",
|
|
44
44
|
"ansis": "^3.3.0"
|
|
45
45
|
},
|
|
46
46
|
"peerDependencies": {
|
|
@@ -1,17 +1,16 @@
|
|
|
1
1
|
import { pluginReportSchema, } from '@code-pushup/models';
|
|
2
|
-
import { logStdoutSummary, scoreReport, sortReport,
|
|
2
|
+
import { isVerbose, logStdoutSummary, scoreReport, sortReport, } from '@code-pushup/utils';
|
|
3
3
|
import { collect } from './implementation/collect.js';
|
|
4
4
|
import { logPersistedResults, persistReport, } from './implementation/persist.js';
|
|
5
5
|
export async function collectAndPersistReports(options) {
|
|
6
|
-
const { exec } = verboseUtils(options.verbose);
|
|
7
6
|
const report = await collect(options);
|
|
8
7
|
const sortedScoredReport = sortReport(scoreReport(report));
|
|
9
8
|
const persistResults = await persistReport(report, sortedScoredReport, options.persist);
|
|
10
9
|
// terminal output
|
|
11
|
-
logStdoutSummary(sortedScoredReport
|
|
12
|
-
|
|
10
|
+
logStdoutSummary(sortedScoredReport);
|
|
11
|
+
if (isVerbose()) {
|
|
13
12
|
logPersistedResults(persistResults);
|
|
14
|
-
}
|
|
13
|
+
}
|
|
15
14
|
// validate report and throw if invalid
|
|
16
15
|
report.plugins.forEach(plugin => {
|
|
17
16
|
// Running checks after persisting helps while debugging as you can check the invalid output after the error is thrown
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"collect-and-persist.js","sourceRoot":"","sources":["../../../../../packages/core/src/lib/collect-and-persist.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,kBAAkB,GACnB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EACL,gBAAgB,EAChB,WAAW,EACX,UAAU,
|
|
1
|
+
{"version":3,"file":"collect-and-persist.js","sourceRoot":"","sources":["../../../../../packages/core/src/lib/collect-and-persist.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,kBAAkB,GACnB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EACL,SAAS,EACT,gBAAgB,EAChB,WAAW,EACX,UAAU,GACX,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,OAAO,EAAE,MAAM,6BAA6B,CAAC;AACtD,OAAO,EACL,mBAAmB,EACnB,aAAa,GACd,MAAM,6BAA6B,CAAC;AAQrC,MAAM,CAAC,KAAK,UAAU,wBAAwB,CAC5C,OAAwC;IAExC,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,OAAO,CAAC,CAAC;IACtC,MAAM,kBAAkB,GAAG,UAAU,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC;IAE3D,MAAM,cAAc,GAAG,MAAM,aAAa,CACxC,MAAM,EACN,kBAAkB,EAClB,OAAO,CAAC,OAAO,CAChB,CAAC;IAEF,kBAAkB;IAClB,gBAAgB,CAAC,kBAAkB,CAAC,CAAC;IAErC,IAAI,SAAS,EAAE,EAAE,CAAC;QAChB,mBAAmB,CAAC,cAAc,CAAC,CAAC;IACtC,CAAC;IAED,uCAAuC;IACvC,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE;QAC9B,sHAAsH;QACtH,kBAAkB,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IACnC,CAAC,CAAC,CAAC;AACL,CAAC"}
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { type
|
|
1
|
+
import { type PluginConfig, type PluginReport } from '@code-pushup/models';
|
|
2
2
|
/**
|
|
3
3
|
* Error thrown when plugin output is invalid.
|
|
4
4
|
*/
|
|
@@ -10,7 +10,6 @@ export declare class PluginOutputMissingAuditError extends Error {
|
|
|
10
10
|
*
|
|
11
11
|
* @public
|
|
12
12
|
* @param pluginConfig - {@link ProcessConfig} object with runner and meta
|
|
13
|
-
* @param onProgress - progress handler {@link OnProgress}
|
|
14
13
|
* @returns {Promise<AuditOutput[]>} - audit outputs from plugin runner
|
|
15
14
|
* @throws {PluginOutputMissingAuditError} - if plugin runner output is invalid
|
|
16
15
|
*
|
|
@@ -27,7 +26,7 @@ export declare class PluginOutputMissingAuditError extends Error {
|
|
|
27
26
|
* console.error(e.message);
|
|
28
27
|
* }
|
|
29
28
|
*/
|
|
30
|
-
export declare function executePlugin(pluginConfig: PluginConfig
|
|
29
|
+
export declare function executePlugin(pluginConfig: PluginConfig): Promise<PluginReport>;
|
|
31
30
|
/**
|
|
32
31
|
* Execute multiple plugins and aggregates their output.
|
|
33
32
|
* @public
|
|
@@ -16,7 +16,6 @@ export class PluginOutputMissingAuditError extends Error {
|
|
|
16
16
|
*
|
|
17
17
|
* @public
|
|
18
18
|
* @param pluginConfig - {@link ProcessConfig} object with runner and meta
|
|
19
|
-
* @param onProgress - progress handler {@link OnProgress}
|
|
20
19
|
* @returns {Promise<AuditOutput[]>} - audit outputs from plugin runner
|
|
21
20
|
* @throws {PluginOutputMissingAuditError} - if plugin runner output is invalid
|
|
22
21
|
*
|
|
@@ -33,12 +32,12 @@ export class PluginOutputMissingAuditError extends Error {
|
|
|
33
32
|
* console.error(e.message);
|
|
34
33
|
* }
|
|
35
34
|
*/
|
|
36
|
-
export async function executePlugin(pluginConfig
|
|
35
|
+
export async function executePlugin(pluginConfig) {
|
|
37
36
|
const { runner, audits: pluginConfigAudits, description, docsUrl, groups, ...pluginMeta } = pluginConfig;
|
|
38
37
|
// execute plugin runner
|
|
39
38
|
const runnerResult = typeof runner === 'object'
|
|
40
|
-
? await executeRunnerConfig(runner
|
|
41
|
-
: await executeRunnerFunction(runner
|
|
39
|
+
? await executeRunnerConfig(runner)
|
|
40
|
+
: await executeRunnerFunction(runner);
|
|
42
41
|
const { audits: unvalidatedAuditOutputs, ...executionMeta } = runnerResult;
|
|
43
42
|
// validate auditOutputs
|
|
44
43
|
const result = auditOutputsSchema.safeParse(unvalidatedAuditOutputs);
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"execute-plugin.js","sourceRoot":"","sources":["../../../../../../packages/core/src/lib/implementation/execute-plugin.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,OAAO,CAAC;AAC7B,OAAO,
|
|
1
|
+
{"version":3,"file":"execute-plugin.js","sourceRoot":"","sources":["../../../../../../packages/core/src/lib/implementation/execute-plugin.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,OAAO,CAAC;AAC7B,OAAO,EAOL,kBAAkB,GACnB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAEL,cAAc,EACd,aAAa,EACb,kBAAkB,EAClB,cAAc,GACf,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,qBAAqB,EAAE,MAAM,iBAAiB,CAAC;AACxD,OAAO,EAAE,mBAAmB,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAC;AAEzE;;GAEG;AACH,MAAM,OAAO,6BAA8B,SAAQ,KAAK;IACtD,YAAY,SAAiB;QAC3B,KAAK,CACH,8DAA8D,IAAI,CAChE,SAAS,CACV,EAAE,CACJ,CAAC;IACJ,CAAC;CACF;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,CAAC,KAAK,UAAU,aAAa,CACjC,YAA0B;IAE1B,MAAM,EACJ,MAAM,EACN,MAAM,EAAE,kBAAkB,EAC1B,WAAW,EACX,OAAO,EACP,MAAM,EACN,GAAG,UAAU,EACd,GAAG,YAAY,CAAC;IAEjB,wBAAwB;IACxB,MAAM,YAAY,GAChB,OAAO,MAAM,KAAK,QAAQ;QACxB,CAAC,CAAC,MAAM,mBAAmB,CAAC,MAAM,CAAC;QACnC,CAAC,CAAC,MAAM,qBAAqB,CAAC,MAAM,CAAC,CAAC;IAC1C,MAAM,EAAE,MAAM,EAAE,uBAAuB,EAAE,GAAG,aAAa,EAAE,GAAG,YAAY,CAAC;IAE3E,wBAAwB;IACxB,MAAM,MAAM,GAAG,kBAAkB,CAAC,SAAS,CAAC,uBAAuB,CAAC,CAAC;IACrE,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;QACpB,MAAM,IAAI,KAAK,CAAC,4BAA4B,MAAM,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;IACD,MAAM,YAAY,GAAG,MAAM,CAAC,IAAI,CAAC;IACjC,qCAAqC,CAAC,YAAY,EAAE,kBAAkB,CAAC,CAAC;IAExE,MAAM,sBAAsB,GAAG,MAAM,qBAAqB,CAAC,YAAY,CAAC,CAAC;IAEzE,yCAAyC;IACzC,MAAM,YAAY,GAAkB,sBAAsB,CAAC,GAAG,CAC5D,CAAC,WAAwB,EAAE,EAAE,CAAC,CAAC;QAC7B,GAAG,WAAW;QACd,GAAI,kBAAkB,CAAC,IAAI,CACzB,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,KAAK,WAAW,CAAC,IAAI,CAC/B;KACZ,CAAC,CACH,CAAC;IAEF,uBAAuB;IACvB,OAAO;QACL,GAAG,UAAU;QACb,GAAG,aAAa;QAChB,MAAM,EAAE,YAAY;QACpB,GAAG,CAAC,WAAW,IAAI,EAAE,WAAW,EAAE,CAAC;QACnC,GAAG,CAAC,OAAO,IAAI,EAAE,OAAO,EAAE,CAAC;QAC3B,GAAG,CAAC,MAAM,IAAI,EAAE,MAAM,EAAE,CAAC;KAC1B,CAAC;AACJ,CAAC;AAED,MAAM,YAAY,GAAG,KAAK,EACxB,SAAuB,EACvB,KAAa,EACb,WAA+B,EAC/B,EAAE;IACF,WAAW,EAAE,WAAW,CAAC,aAAa,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;IAC/D,IAAI,CAAC;QACH,MAAM,YAAY,GAAG,MAAM,aAAa,CAAC,SAAS,CAAC,CAAC;QACpD,WAAW,EAAE,gBAAgB,CAAC,KAAK,CAAC,CAAC;QACrC,OAAO,YAAY,CAAC;IACtB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,WAAW,EAAE,gBAAgB,CAAC,KAAK,CAAC,CAAC;QACrC,MAAM,IAAI,KAAK,CACb,KAAK,YAAY,KAAK;YACpB,CAAC,CAAC,YAAY,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,KAAK,IAAI,CACxC,SAAS,CAAC,IAAI,CACf,wCAAwC,KAAK,CAAC,OAAO,EAAE;YAC1D,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAClB,CAAC;IACJ,CAAC;AACH,CAAC,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,CAAC,KAAK,UAAU,cAAc,CAClC,OAAuB,EACvB,OAAgC;IAEhC,MAAM,EAAE,QAAQ,GAAG,KAAK,EAAE,GAAG,OAAO,IAAI,EAAE,CAAC;IAE3C,MAAM,WAAW,GAAG,QAAQ,CAAC,CAAC,CAAC,cAAc,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IAEpE,MAAM,aAAa,GAAG,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE,CAC5C,YAAY,CAAC,SAAS,EAAE,OAAO,CAAC,MAAM,EAAE,WAAW,CAAC,CACrD,CAAC;IAEF,MAAM,eAAe,GAAG,CAAC,EAAE,MAAM,EAAyB,EAAE,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IAC9E,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;IAExD,WAAW,EAAE,WAAW,CAAC,sBAAsB,CAAC,CAAC;IAEjD,kBAAkB,CAAC,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,eAAe,CAAC,CAAC;IAEnE,MAAM,EAAE,SAAS,EAAE,QAAQ,EAAE,GAAG,aAAa,CAAC,OAAO,CAAC,CAAC;IACvD,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACxB,MAAM,aAAa,GAAG,QAAQ;aAC3B,GAAG,CAAC,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;aACnC,IAAI,CAAC,IAAI,CAAC,CAAC;QACd,MAAM,IAAI,KAAK,CACb,aAAa,cAAc,CACzB,QAAQ,EACR,QAAQ,CAAC,MAAM,CAChB,eAAe,aAAa,MAAM,CACpC,CAAC;IACJ,CAAC;IAED,OAAO,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;AAC/C,CAAC;AAED,SAAS,qCAAqC,CAC5C,YAA0B,EAC1B,kBAA0C;IAE1C,YAAY,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE;QACjC,MAAM,aAAa,GAAG,kBAAkB,CAAC,IAAI,CAC3C,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,KAAK,WAAW,CAAC,IAAI,CACzC,CAAC;QACF,IAAI,CAAC,aAAa,EAAE,CAAC;YACnB,MAAM,IAAI,6BAA6B,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;QAC5D,CAAC;IACH,CAAC,CAAC,CAAC;AACL,CAAC"}
|
|
@@ -1,8 +1,8 @@
|
|
|
1
|
-
import type {
|
|
1
|
+
import type { RunnerConfig, RunnerFunction } from '@code-pushup/models';
|
|
2
2
|
export type RunnerResult = {
|
|
3
3
|
date: string;
|
|
4
4
|
duration: number;
|
|
5
5
|
audits: unknown;
|
|
6
6
|
};
|
|
7
|
-
export declare function executeRunnerConfig(cfg: RunnerConfig
|
|
8
|
-
export declare function executeRunnerFunction(runner: RunnerFunction
|
|
7
|
+
export declare function executeRunnerConfig(cfg: RunnerConfig): Promise<RunnerResult>;
|
|
8
|
+
export declare function executeRunnerFunction(runner: RunnerFunction): Promise<RunnerResult>;
|
|
@@ -1,12 +1,19 @@
|
|
|
1
1
|
import path from 'node:path';
|
|
2
|
-
import { calcDuration, executeProcess, readJsonFile, removeDirectoryIfExists, } from '@code-pushup/utils';
|
|
3
|
-
export async function executeRunnerConfig(cfg
|
|
2
|
+
import { calcDuration, executeProcess, isVerbose, readJsonFile, removeDirectoryIfExists, ui, } from '@code-pushup/utils';
|
|
3
|
+
export async function executeRunnerConfig(cfg) {
|
|
4
4
|
const { args, command, outputFile, outputTransform } = cfg;
|
|
5
5
|
// execute process
|
|
6
6
|
const { duration, date } = await executeProcess({
|
|
7
7
|
command,
|
|
8
8
|
args,
|
|
9
|
-
observer: {
|
|
9
|
+
observer: {
|
|
10
|
+
onStdout: stdout => {
|
|
11
|
+
if (isVerbose()) {
|
|
12
|
+
ui().logger.log(stdout);
|
|
13
|
+
}
|
|
14
|
+
},
|
|
15
|
+
onStderr: stderr => ui().logger.error(stderr),
|
|
16
|
+
},
|
|
10
17
|
});
|
|
11
18
|
// read process output from file system and parse it
|
|
12
19
|
const outputs = await readJsonFile(outputFile);
|
|
@@ -21,11 +28,11 @@ export async function executeRunnerConfig(cfg, onProgress) {
|
|
|
21
28
|
audits,
|
|
22
29
|
};
|
|
23
30
|
}
|
|
24
|
-
export async function executeRunnerFunction(runner
|
|
31
|
+
export async function executeRunnerFunction(runner) {
|
|
25
32
|
const date = new Date().toISOString();
|
|
26
33
|
const start = performance.now();
|
|
27
34
|
// execute plugin runner
|
|
28
|
-
const audits = await runner(
|
|
35
|
+
const audits = await runner();
|
|
29
36
|
// create runner result
|
|
30
37
|
return {
|
|
31
38
|
date,
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"runner.js","sourceRoot":"","sources":["../../../../../../packages/core/src/lib/implementation/runner.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,WAAW,CAAC;
|
|
1
|
+
{"version":3,"file":"runner.js","sourceRoot":"","sources":["../../../../../../packages/core/src/lib/implementation/runner.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,WAAW,CAAC;AAE7B,OAAO,EACL,YAAY,EACZ,cAAc,EACd,SAAS,EACT,YAAY,EACZ,uBAAuB,EACvB,EAAE,GACH,MAAM,oBAAoB,CAAC;AAQ5B,MAAM,CAAC,KAAK,UAAU,mBAAmB,CACvC,GAAiB;IAEjB,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,UAAU,EAAE,eAAe,EAAE,GAAG,GAAG,CAAC;IAE3D,kBAAkB;IAClB,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,GAAG,MAAM,cAAc,CAAC;QAC9C,OAAO;QACP,IAAI;QACJ,QAAQ,EAAE;YACR,QAAQ,EAAE,MAAM,CAAC,EAAE;gBACjB,IAAI,SAAS,EAAE,EAAE,CAAC;oBAChB,EAAE,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;gBAC1B,CAAC;YACH,CAAC;YACD,QAAQ,EAAE,MAAM,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC;SAC9C;KACF,CAAC,CAAC;IAEH,oDAAoD;IACpD,MAAM,OAAO,GAAG,MAAM,YAAY,CAAC,UAAU,CAAC,CAAC;IAC/C,qDAAqD;IACrD,MAAM,uBAAuB,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC;IAExD,gDAAgD;IAChD,MAAM,MAAM,GAAG,eAAe,CAAC,CAAC,CAAC,MAAM,eAAe,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC;IAE1E,uBAAuB;IACvB,OAAO;QACL,QAAQ;QACR,IAAI;QACJ,MAAM;KACP,CAAC;AACJ,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,qBAAqB,CACzC,MAAsB;IAEtB,MAAM,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;IACtC,MAAM,KAAK,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC;IAEhC,wBAAwB;IACxB,MAAM,MAAM,GAAG,MAAM,MAAM,EAAE,CAAC;IAE9B,uBAAuB;IACvB,OAAO;QACL,IAAI;QACJ,QAAQ,EAAE,YAAY,CAAC,KAAK,CAAC;QAC7B,MAAM;KACP,CAAC;AACJ,CAAC"}
|
package/src/lib/types.d.ts
CHANGED