@code-pushup/utils 0.78.0 → 0.79.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 +2 -2
- package/src/index.d.ts +1 -1
- package/src/index.js +1 -1
- package/src/index.js.map +1 -1
- package/src/lib/env.d.ts +6 -0
- package/src/lib/env.js +24 -0
- package/src/lib/env.js.map +1 -1
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@code-pushup/utils",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.79.0",
|
|
4
4
|
"description": "Low-level utilities (helper functions, etc.) used by Code PushUp CLI",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"homepage": "https://github.com/code-pushup/cli/tree/main/packages/utils#readme",
|
|
@@ -27,7 +27,7 @@
|
|
|
27
27
|
"node": ">=17.0.0"
|
|
28
28
|
},
|
|
29
29
|
"dependencies": {
|
|
30
|
-
"@code-pushup/models": "0.
|
|
30
|
+
"@code-pushup/models": "0.79.0",
|
|
31
31
|
"@isaacs/cliui": "^8.0.2",
|
|
32
32
|
"@poppinss/cliui": "^6.4.0",
|
|
33
33
|
"ansis": "^3.3.0",
|
package/src/index.d.ts
CHANGED
|
@@ -3,7 +3,7 @@ export { camelCaseToKebabCase, capitalize, kebabCaseToCamelCase, lowercase, toSe
|
|
|
3
3
|
export { filesCoverageToTree, type FileCoverage } from './lib/coverage-tree.js';
|
|
4
4
|
export { createRunnerFiles } from './lib/create-runner-files.js';
|
|
5
5
|
export { comparePairs, matchArrayItemsByKey, type Diff } from './lib/diff.js';
|
|
6
|
-
export { coerceBooleanValue, isCI, isEnvVarEnabled, isVerbose, } from './lib/env.js';
|
|
6
|
+
export { coerceBooleanValue, isCI, isEnvVarEnabled, isVerbose, runnerArgsFromEnv, runnerArgsToEnv, } from './lib/env.js';
|
|
7
7
|
export { stringifyError } from './lib/errors.js';
|
|
8
8
|
export { executeProcess, ProcessError, type ProcessConfig, type ProcessObserver, type ProcessResult, } from './lib/execute-process.js';
|
|
9
9
|
export { crawlFileSystem, createReportPath, directoryExists, ensureDirectoryExists, fileExists, filePathToCliArg, findLineNumberInText, findNearestFile, importModule, logMultipleFileResults, pluginWorkDir, projectToFilename, readJsonFile, readTextFile, removeDirectoryIfExists, type CrawlFileSystemOptions, type FileResult, type MultipleFileResults, } from './lib/file-system.js';
|
package/src/index.js
CHANGED
|
@@ -3,7 +3,7 @@ export { camelCaseToKebabCase, capitalize, kebabCaseToCamelCase, lowercase, toSe
|
|
|
3
3
|
export { filesCoverageToTree } from './lib/coverage-tree.js';
|
|
4
4
|
export { createRunnerFiles } from './lib/create-runner-files.js';
|
|
5
5
|
export { comparePairs, matchArrayItemsByKey } from './lib/diff.js';
|
|
6
|
-
export { coerceBooleanValue, isCI, isEnvVarEnabled, isVerbose, } from './lib/env.js';
|
|
6
|
+
export { coerceBooleanValue, isCI, isEnvVarEnabled, isVerbose, runnerArgsFromEnv, runnerArgsToEnv, } from './lib/env.js';
|
|
7
7
|
export { stringifyError } from './lib/errors.js';
|
|
8
8
|
export { executeProcess, ProcessError, } from './lib/execute-process.js';
|
|
9
9
|
export { crawlFileSystem, createReportPath, directoryExists, ensureDirectoryExists, fileExists, filePathToCliArg, findLineNumberInText, findNearestFile, importModule, logMultipleFileResults, pluginWorkDir, projectToFilename, readJsonFile, readTextFile, removeDirectoryIfExists, } from './lib/file-system.js';
|
package/src/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EACL,oBAAoB,EACpB,UAAU,EACV,oBAAoB,EACpB,SAAS,EACT,cAAc,EACd,WAAW,EACX,SAAS,GACV,MAAM,2BAA2B,CAAC;AACnC,OAAO,EAAE,mBAAmB,EAAqB,MAAM,wBAAwB,CAAC;AAChF,OAAO,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AACjE,OAAO,EAAE,YAAY,EAAE,oBAAoB,EAAa,MAAM,eAAe,CAAC;AAC9E,OAAO,EACL,kBAAkB,EAClB,IAAI,EACJ,eAAe,EACf,SAAS,
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EACL,oBAAoB,EACpB,UAAU,EACV,oBAAoB,EACpB,SAAS,EACT,cAAc,EACd,WAAW,EACX,SAAS,GACV,MAAM,2BAA2B,CAAC;AACnC,OAAO,EAAE,mBAAmB,EAAqB,MAAM,wBAAwB,CAAC;AAChF,OAAO,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AACjE,OAAO,EAAE,YAAY,EAAE,oBAAoB,EAAa,MAAM,eAAe,CAAC;AAC9E,OAAO,EACL,kBAAkB,EAClB,IAAI,EACJ,eAAe,EACf,SAAS,EACT,iBAAiB,EACjB,eAAe,GAChB,MAAM,cAAc,CAAC;AACtB,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AACjD,OAAO,EACL,cAAc,EACd,YAAY,GAIb,MAAM,0BAA0B,CAAC;AAClC,OAAO,EACL,eAAe,EACf,gBAAgB,EAChB,eAAe,EACf,qBAAqB,EACrB,UAAU,EACV,gBAAgB,EAChB,oBAAoB,EACpB,eAAe,EACf,YAAY,EACZ,sBAAsB,EACtB,aAAa,EACb,iBAAiB,EACjB,YAAY,EACZ,YAAY,EACZ,uBAAuB,GAIxB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AACnD,OAAO,EACL,WAAW,EACX,cAAc,EACd,SAAS,EACT,cAAc,EACd,OAAO,EACP,mBAAmB,EACnB,oBAAoB,EACpB,YAAY,EACZ,aAAa,GACd,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EACL,qBAAqB,EACrB,SAAS,EACT,cAAc,EACd,eAAe,EACf,aAAa,GAEd,MAAM,mCAAmC,CAAC;AAC3C,OAAO,EACL,aAAa,EACb,UAAU,EACV,wBAAwB,EACxB,YAAY,EACZ,SAAS,GACV,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EACL,kBAAkB,EAClB,wBAAwB,EACxB,uBAAuB,GACxB,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AACnD,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC1D,OAAO,EAAE,IAAI,EAAE,EAAE,EAA2B,MAAM,kBAAkB,CAAC;AACrE,OAAO,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AACtD,OAAO,EAAE,cAAc,EAAoB,MAAM,mBAAmB,CAAC;AACrE,OAAO,EAAE,eAAe,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AACnE,OAAO,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AACnD,OAAO,EACL,kBAAkB,EAClB,wBAAwB,EACxB,aAAa,EACb,WAAW,EACX,cAAc,GACf,MAAM,4BAA4B,CAAC;AACpC,OAAO,EACL,wBAAwB,EACxB,wBAAwB,GACzB,MAAM,kCAAkC,CAAC;AAC1C,OAAO,EAAE,gBAAgB,EAAE,MAAM,qCAAqC,CAAC;AACvE,OAAO,EACL,qBAAqB,EACrB,gCAAgC,GACjC,MAAM,2CAA2C,CAAC;AACnD,OAAO,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAC1D,OAAO,EAAE,gBAAgB,EAAE,MAAM,qCAAqC,CAAC;AACvE,OAAO,EAAE,WAAW,EAAE,qBAAqB,EAAE,MAAM,0BAA0B,CAAC;AAC9E,OAAO,EAAE,UAAU,EAAE,MAAM,0BAA0B,CAAC;AAMtD,OAAO,EACL,YAAY,EACZ,oBAAoB,EACpB,iBAAiB,GAClB,MAAM,wBAAwB,CAAC;AAChC,OAAO,EAAE,QAAQ,EAAE,eAAe,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AACzE,cAAc,6BAA6B,CAAC;AAC5C,OAAO,EACL,gBAAgB,EAChB,QAAQ,EACR,QAAQ,EACR,aAAa,EACb,iBAAiB,EACjB,eAAe,EACf,eAAe,EACf,YAAY,EACZ,4BAA4B,EAC5B,OAAO,EACP,WAAW,EACX,iBAAiB,EACjB,SAAS,EACT,cAAc,EACd,UAAU,GAEX,MAAM,oBAAoB,CAAC;AAU5B,OAAO,EAAE,WAAW,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC"}
|
package/src/lib/env.d.ts
CHANGED
|
@@ -1,4 +1,10 @@
|
|
|
1
|
+
import { type RunnerArgs } from '@code-pushup/models';
|
|
1
2
|
export declare function isCI(): boolean;
|
|
2
3
|
export declare function isVerbose(): boolean;
|
|
3
4
|
export declare function isEnvVarEnabled(name: string): boolean;
|
|
4
5
|
export declare function coerceBooleanValue(value: unknown): boolean | undefined;
|
|
6
|
+
type RUNNER_ARGS_ENV_VAR = 'CP_PERSIST_OUTPUT_DIR' | 'CP_PERSIST_FILENAME' | 'CP_PERSIST_FORMAT' | 'CP_PERSIST_SKIP_REPORTS';
|
|
7
|
+
type RunnerEnv = Record<RUNNER_ARGS_ENV_VAR, string>;
|
|
8
|
+
export declare function runnerArgsToEnv(config: RunnerArgs): RunnerEnv;
|
|
9
|
+
export declare function runnerArgsFromEnv(env: Partial<RunnerEnv>): RunnerArgs;
|
|
10
|
+
export {};
|
package/src/lib/env.js
CHANGED
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import { DEFAULT_PERSIST_FILENAME, DEFAULT_PERSIST_FORMAT, DEFAULT_PERSIST_OUTPUT_DIR, DEFAULT_PERSIST_SKIP_REPORT, formatSchema, } from '@code-pushup/models';
|
|
1
2
|
import { ui } from './logging.js';
|
|
2
3
|
export function isCI() {
|
|
3
4
|
return isEnvVarEnabled('CI');
|
|
@@ -39,4 +40,27 @@ export function coerceBooleanValue(value) {
|
|
|
39
40
|
}
|
|
40
41
|
return undefined;
|
|
41
42
|
}
|
|
43
|
+
const FORMAT_SEP = ',';
|
|
44
|
+
export function runnerArgsToEnv(config) {
|
|
45
|
+
return {
|
|
46
|
+
CP_PERSIST_OUTPUT_DIR: config.persist.outputDir,
|
|
47
|
+
CP_PERSIST_FILENAME: config.persist.filename,
|
|
48
|
+
CP_PERSIST_FORMAT: config.persist.format.join(FORMAT_SEP),
|
|
49
|
+
CP_PERSIST_SKIP_REPORTS: config.persist.skipReports.toString(),
|
|
50
|
+
};
|
|
51
|
+
}
|
|
52
|
+
export function runnerArgsFromEnv(env) {
|
|
53
|
+
const formats = env.CP_PERSIST_FORMAT?.split(FORMAT_SEP)
|
|
54
|
+
.map(item => formatSchema.safeParse(item).data)
|
|
55
|
+
.filter(item => item != null);
|
|
56
|
+
const skipReports = coerceBooleanValue(env.CP_PERSIST_SKIP_REPORTS);
|
|
57
|
+
return {
|
|
58
|
+
persist: {
|
|
59
|
+
outputDir: env.CP_PERSIST_OUTPUT_DIR || DEFAULT_PERSIST_OUTPUT_DIR,
|
|
60
|
+
filename: env.CP_PERSIST_FILENAME || DEFAULT_PERSIST_FILENAME,
|
|
61
|
+
format: formats?.length ? formats : DEFAULT_PERSIST_FORMAT,
|
|
62
|
+
skipReports: skipReports ?? DEFAULT_PERSIST_SKIP_REPORT,
|
|
63
|
+
},
|
|
64
|
+
};
|
|
65
|
+
}
|
|
42
66
|
//# sourceMappingURL=env.js.map
|
package/src/lib/env.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"env.js","sourceRoot":"","sources":["../../../src/lib/env.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,EAAE,EAAE,MAAM,cAAc,CAAC;AAElC,MAAM,UAAU,IAAI;IAClB,OAAO,eAAe,CAAC,IAAI,CAAC,CAAC;AAC/B,CAAC;AAED,MAAM,UAAU,SAAS;IACvB,OAAO,eAAe,CAAC,YAAY,CAAC,CAAC;AACvC,CAAC;AAED,MAAM,UAAU,eAAe,CAAC,IAAY;IAC1C,MAAM,KAAK,GAAG,kBAAkB,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC;IAEpD,IAAI,OAAO,KAAK,KAAK,SAAS,EAAE,CAAC;QAC/B,OAAO,KAAK,CAAC;IACf,CAAC;IAED,IAAI,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;QACtB,EAAE,EAAE,CAAC,MAAM,CAAC,OAAO,CACjB,wBAAwB,IAAI,kEAAkE,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,4BAA4B,CAC5I,CAAC;IACJ,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC;AAED,MAAM,UAAU,kBAAkB,CAAC,KAAc;IAC/C,IAAI,OAAO,KAAK,KAAK,SAAS,EAAE,CAAC;QAC/B,OAAO,KAAK,CAAC;IACf,CAAC;IAED,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC9B,MAAM,iBAAiB,GAAG;YACxB,CAAC,MAAM,EAAE,OAAO,CAAC;YACjB,CAAC,IAAI,EAAE,KAAK,CAAC;YACb,CAAC,KAAK,EAAE,IAAI,CAAC;SACd,CAAC;QACF,MAAM,cAAc,GAAG,KAAK,CAAC,WAAW,EAAE,CAAC;QAC3C,yDAAyD;QACzD,KAAK,MAAM,CAAC,SAAS,EAAE,UAAU,CAAC,IAAI,iBAAiB,EAAE,CAAC;YACxD,IAAI,cAAc,KAAK,SAAS,IAAI,cAAc,KAAK,UAAU,EAAE,CAAC;gBAClE,OAAO,cAAc,KAAK,SAAS,CAAC;YACtC,CAAC;QACH,CAAC;QAED,MAAM,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;QAC5C,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC5B,OAAO,QAAQ,KAAK,CAAC,CAAC;QACxB,CAAC;IACH,CAAC;IAED,OAAO,SAAS,CAAC;AACnB,CAAC"}
|
|
1
|
+
{"version":3,"file":"env.js","sourceRoot":"","sources":["../../../src/lib/env.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,wBAAwB,EACxB,sBAAsB,EACtB,0BAA0B,EAC1B,2BAA2B,EAE3B,YAAY,GACb,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,EAAE,EAAE,MAAM,cAAc,CAAC;AAElC,MAAM,UAAU,IAAI;IAClB,OAAO,eAAe,CAAC,IAAI,CAAC,CAAC;AAC/B,CAAC;AAED,MAAM,UAAU,SAAS;IACvB,OAAO,eAAe,CAAC,YAAY,CAAC,CAAC;AACvC,CAAC;AAED,MAAM,UAAU,eAAe,CAAC,IAAY;IAC1C,MAAM,KAAK,GAAG,kBAAkB,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC;IAEpD,IAAI,OAAO,KAAK,KAAK,SAAS,EAAE,CAAC;QAC/B,OAAO,KAAK,CAAC;IACf,CAAC;IAED,IAAI,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;QACtB,EAAE,EAAE,CAAC,MAAM,CAAC,OAAO,CACjB,wBAAwB,IAAI,kEAAkE,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,4BAA4B,CAC5I,CAAC;IACJ,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC;AAED,MAAM,UAAU,kBAAkB,CAAC,KAAc;IAC/C,IAAI,OAAO,KAAK,KAAK,SAAS,EAAE,CAAC;QAC/B,OAAO,KAAK,CAAC;IACf,CAAC;IAED,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC9B,MAAM,iBAAiB,GAAG;YACxB,CAAC,MAAM,EAAE,OAAO,CAAC;YACjB,CAAC,IAAI,EAAE,KAAK,CAAC;YACb,CAAC,KAAK,EAAE,IAAI,CAAC;SACd,CAAC;QACF,MAAM,cAAc,GAAG,KAAK,CAAC,WAAW,EAAE,CAAC;QAC3C,yDAAyD;QACzD,KAAK,MAAM,CAAC,SAAS,EAAE,UAAU,CAAC,IAAI,iBAAiB,EAAE,CAAC;YACxD,IAAI,cAAc,KAAK,SAAS,IAAI,cAAc,KAAK,UAAU,EAAE,CAAC;gBAClE,OAAO,cAAc,KAAK,SAAS,CAAC;YACtC,CAAC;QACH,CAAC;QAED,MAAM,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;QAC5C,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC5B,OAAO,QAAQ,KAAK,CAAC,CAAC;QACxB,CAAC;IACH,CAAC;IAED,OAAO,SAAS,CAAC;AACnB,CAAC;AAUD,MAAM,UAAU,GAAG,GAAG,CAAC;AAEvB,MAAM,UAAU,eAAe,CAAC,MAAkB;IAChD,OAAO;QACL,qBAAqB,EAAE,MAAM,CAAC,OAAO,CAAC,SAAS;QAC/C,mBAAmB,EAAE,MAAM,CAAC,OAAO,CAAC,QAAQ;QAC5C,iBAAiB,EAAE,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC;QACzD,uBAAuB,EAAE,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,QAAQ,EAAE;KAC/D,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,iBAAiB,CAAC,GAAuB;IACvD,MAAM,OAAO,GAAG,GAAG,CAAC,iBAAiB,EAAE,KAAK,CAAC,UAAU,CAAC;SACrD,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,YAAY,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC;SAC9C,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,IAAI,IAAI,CAAC,CAAC;IAChC,MAAM,WAAW,GAAG,kBAAkB,CAAC,GAAG,CAAC,uBAAuB,CAAC,CAAC;IACpE,OAAO;QACL,OAAO,EAAE;YACP,SAAS,EAAE,GAAG,CAAC,qBAAqB,IAAI,0BAA0B;YAClE,QAAQ,EAAE,GAAG,CAAC,mBAAmB,IAAI,wBAAwB;YAC7D,MAAM,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,sBAAsB;YAC1D,WAAW,EAAE,WAAW,IAAI,2BAA2B;SACxD;KACF,CAAC;AACJ,CAAC"}
|