pkgwise 0.1.0-alpha.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/CHANGELOG.md +7 -0
- package/LICENSE +21 -0
- package/README.md +17 -0
- package/dist/bin/pkgwise.d.ts +3 -0
- package/dist/bin/pkgwise.d.ts.map +1 -0
- package/dist/bin/pkgwise.js +16 -0
- package/dist/bin/pkgwise.js.map +1 -0
- package/dist/commands/CommandContext.d.ts +9 -0
- package/dist/commands/CommandContext.d.ts.map +1 -0
- package/dist/commands/CommandContext.js +2 -0
- package/dist/commands/CommandContext.js.map +1 -0
- package/dist/commands/createCacheCommand.d.ts +4 -0
- package/dist/commands/createCacheCommand.d.ts.map +1 -0
- package/dist/commands/createCacheCommand.js +58 -0
- package/dist/commands/createCacheCommand.js.map +1 -0
- package/dist/commands/createCompareCommand.d.ts +4 -0
- package/dist/commands/createCompareCommand.d.ts.map +1 -0
- package/dist/commands/createCompareCommand.js +38 -0
- package/dist/commands/createCompareCommand.js.map +1 -0
- package/dist/commands/createDoctorCommand.d.ts +4 -0
- package/dist/commands/createDoctorCommand.d.ts.map +1 -0
- package/dist/commands/createDoctorCommand.js +26 -0
- package/dist/commands/createDoctorCommand.js.map +1 -0
- package/dist/commands/createExplainCommand.d.ts +4 -0
- package/dist/commands/createExplainCommand.d.ts.map +1 -0
- package/dist/commands/createExplainCommand.js +27 -0
- package/dist/commands/createExplainCommand.js.map +1 -0
- package/dist/commands/createInspectCommand.d.ts +4 -0
- package/dist/commands/createInspectCommand.d.ts.map +1 -0
- package/dist/commands/createInspectCommand.js +39 -0
- package/dist/commands/createInspectCommand.js.map +1 -0
- package/dist/commands/createScanCommand.d.ts +4 -0
- package/dist/commands/createScanCommand.d.ts.map +1 -0
- package/dist/commands/createScanCommand.js +65 -0
- package/dist/commands/createScanCommand.js.map +1 -0
- package/dist/createCli.d.ts +12 -0
- package/dist/createCli.d.ts.map +1 -0
- package/dist/createCli.js +41 -0
- package/dist/createCli.js.map +1 -0
- package/dist/exit/mapErrorToExitCode.d.ts +2 -0
- package/dist/exit/mapErrorToExitCode.d.ts.map +1 -0
- package/dist/exit/mapErrorToExitCode.js +31 -0
- package/dist/exit/mapErrorToExitCode.js.map +1 -0
- package/dist/exit/mapPolicyToExitCode.d.ts +3 -0
- package/dist/exit/mapPolicyToExitCode.d.ts.map +1 -0
- package/dist/exit/mapPolicyToExitCode.js +4 -0
- package/dist/exit/mapPolicyToExitCode.js.map +1 -0
- package/dist/index.d.ts +3 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +3 -0
- package/dist/index.js.map +1 -0
- package/dist/io/CliIo.d.ts +10 -0
- package/dist/io/CliIo.d.ts.map +1 -0
- package/dist/io/CliIo.js +5 -0
- package/dist/io/CliIo.js.map +1 -0
- package/dist/options/GlobalOptions.d.ts +19 -0
- package/dist/options/GlobalOptions.d.ts.map +1 -0
- package/dist/options/GlobalOptions.js +2 -0
- package/dist/options/GlobalOptions.js.map +1 -0
- package/dist/options/createGlobalOptions.d.ts +3 -0
- package/dist/options/createGlobalOptions.d.ts.map +1 -0
- package/dist/options/createGlobalOptions.js +23 -0
- package/dist/options/createGlobalOptions.js.map +1 -0
- package/dist/options/parseConcurrency.d.ts +2 -0
- package/dist/options/parseConcurrency.d.ts.map +1 -0
- package/dist/options/parseConcurrency.js +12 -0
- package/dist/options/parseConcurrency.js.map +1 -0
- package/dist/options/parseDuration.d.ts +2 -0
- package/dist/options/parseDuration.d.ts.map +1 -0
- package/dist/options/parseDuration.js +17 -0
- package/dist/options/parseDuration.js.map +1 -0
- package/dist/options/parseFindingFilters.d.ts +5 -0
- package/dist/options/parseFindingFilters.d.ts.map +1 -0
- package/dist/options/parseFindingFilters.js +29 -0
- package/dist/options/parseFindingFilters.js.map +1 -0
- package/dist/options/parseOutputFormat.d.ts +3 -0
- package/dist/options/parseOutputFormat.d.ts.map +1 -0
- package/dist/options/parseOutputFormat.js +9 -0
- package/dist/options/parseOutputFormat.js.map +1 -0
- package/dist/options/readGlobalOptions.d.ts +4 -0
- package/dist/options/readGlobalOptions.d.ts.map +1 -0
- package/dist/options/readGlobalOptions.js +9 -0
- package/dist/options/readGlobalOptions.js.map +1 -0
- package/dist/output/renderAnalysisReport.d.ts +8 -0
- package/dist/output/renderAnalysisReport.d.ts.map +1 -0
- package/dist/output/renderAnalysisReport.js +47 -0
- package/dist/output/renderAnalysisReport.js.map +1 -0
- package/dist/output/renderCliError.d.ts +12 -0
- package/dist/output/renderCliError.d.ts.map +1 -0
- package/dist/output/renderCliError.js +22 -0
- package/dist/output/renderCliError.js.map +1 -0
- package/dist/output/renderDoctorReport.d.ts +3 -0
- package/dist/output/renderDoctorReport.d.ts.map +1 -0
- package/dist/output/renderDoctorReport.js +13 -0
- package/dist/output/renderDoctorReport.js.map +1 -0
- package/dist/output/renderFindingExplanation.d.ts +3 -0
- package/dist/output/renderFindingExplanation.d.ts.map +1 -0
- package/dist/output/renderFindingExplanation.js +39 -0
- package/dist/output/renderFindingExplanation.js.map +1 -0
- package/dist/output/renderMarkdownReport.d.ts +4 -0
- package/dist/output/renderMarkdownReport.d.ts.map +1 -0
- package/dist/output/renderMarkdownReport.js +113 -0
- package/dist/output/renderMarkdownReport.js.map +1 -0
- package/dist/output/renderPackageComparison.d.ts +3 -0
- package/dist/output/renderPackageComparison.d.ts.map +1 -0
- package/dist/output/renderPackageComparison.js +41 -0
- package/dist/output/renderPackageComparison.js.map +1 -0
- package/dist/output/renderPackageInspection.d.ts +3 -0
- package/dist/output/renderPackageInspection.d.ts.map +1 -0
- package/dist/output/renderPackageInspection.js +58 -0
- package/dist/output/renderPackageInspection.js.map +1 -0
- package/dist/output/renderSarifReport.d.ts +3 -0
- package/dist/output/renderSarifReport.d.ts.map +1 -0
- package/dist/output/renderSarifReport.js +145 -0
- package/dist/output/renderSarifReport.js.map +1 -0
- package/dist/output/renderStructuredResult.d.ts +3 -0
- package/dist/output/renderStructuredResult.d.ts.map +1 -0
- package/dist/output/renderStructuredResult.js +20 -0
- package/dist/output/renderStructuredResult.js.map +1 -0
- package/dist/output/writeTextOutput.d.ts +3 -0
- package/dist/output/writeTextOutput.d.ts.map +1 -0
- package/dist/output/writeTextOutput.js +22 -0
- package/dist/output/writeTextOutput.js.map +1 -0
- package/dist/runCli.d.ts +11 -0
- package/dist/runCli.d.ts.map +1 -0
- package/dist/runCli.js +60 -0
- package/dist/runCli.js.map +1 -0
- package/package.json +57 -0
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
export function renderPackageComparison(comparison) {
|
|
2
|
+
const lines = [
|
|
3
|
+
`PkgWise compare · ${comparison.selectors[0]} ↔ ${comparison.selectors[1]}`,
|
|
4
|
+
`${comparison.report.project.manager} · ${comparison.report.project.lockfile ?? 'no lockfile'}`,
|
|
5
|
+
];
|
|
6
|
+
comparison.candidates.forEach((candidate, index) => {
|
|
7
|
+
lines.push('', `Candidate ${index === 0 ? 'A' : 'B'}: ${candidate.selector}`);
|
|
8
|
+
for (const item of candidate.packages) {
|
|
9
|
+
lines.push(` ${item.name}${item.version === undefined ? '' : `@${item.version}`}`, ` direct ${item.direct ? 'yes' : 'no'} · depth ${item.minimumDepth} · immediate dependencies ${item.resolvedDependencyCount}`, ` scopes ${item.directScopes.join(', ') || 'none'} · locator ${item.id}`);
|
|
10
|
+
}
|
|
11
|
+
lines.push(` Related findings: ${candidate.findings.length}`);
|
|
12
|
+
});
|
|
13
|
+
lines.push('', 'Metric comparison:');
|
|
14
|
+
for (const metric of comparison.metrics) {
|
|
15
|
+
lines.push(` ${metric.status === 'equal' ? '=' : '≠'} ${metric.name}: ${formatValue(metric.candidateA)} | ${formatValue(metric.candidateB)}`, ` ${metric.summary}`);
|
|
16
|
+
}
|
|
17
|
+
lines.push('', `Conclusion: ${comparison.conclusion.summary}`);
|
|
18
|
+
if (comparison.recommendation !== undefined) {
|
|
19
|
+
lines.push(`Recommendation: ${comparison.recommendation.summary}`);
|
|
20
|
+
for (const action of comparison.recommendation.actions)
|
|
21
|
+
lines.push(` - ${action}`);
|
|
22
|
+
}
|
|
23
|
+
if (comparison.context.unavailableData.length > 0) {
|
|
24
|
+
lines.push('', 'Unavailable data:');
|
|
25
|
+
for (const item of comparison.context.unavailableData)
|
|
26
|
+
lines.push(` - ${item}`);
|
|
27
|
+
}
|
|
28
|
+
lines.push('', `Analysis status: ${comparison.report.status}`);
|
|
29
|
+
for (const diagnostic of comparison.report.diagnostics) {
|
|
30
|
+
lines.push(`${diagnostic.level.toUpperCase()}: ${diagnostic.message}`);
|
|
31
|
+
}
|
|
32
|
+
return `${lines.join('\n')}\n`;
|
|
33
|
+
}
|
|
34
|
+
function formatValue(value) {
|
|
35
|
+
if (value === undefined)
|
|
36
|
+
return 'unavailable';
|
|
37
|
+
if (Array.isArray(value))
|
|
38
|
+
return value.join(', ') || 'none';
|
|
39
|
+
return String(value);
|
|
40
|
+
}
|
|
41
|
+
//# sourceMappingURL=renderPackageComparison.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"renderPackageComparison.js","sourceRoot":"","sources":["../../src/output/renderPackageComparison.ts"],"names":[],"mappings":"AAEA,MAAM,UAAU,uBAAuB,CAAC,UAA6B;IACnE,MAAM,KAAK,GAAG;QACZ,qBAAqB,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE;QAC3E,GAAG,UAAU,CAAC,MAAM,CAAC,OAAO,CAAC,OAAO,MAAM,UAAU,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ,IAAI,aAAa,EAAE;KAChG,CAAC;IAEF,UAAU,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,KAAK,EAAE,EAAE;QACjD,KAAK,CAAC,IAAI,CAAC,EAAE,EAAE,aAAa,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,KAAK,SAAS,CAAC,QAAQ,EAAE,CAAC,CAAC;QAC9E,KAAK,MAAM,IAAI,IAAI,SAAS,CAAC,QAAQ,EAAE,CAAC;YACtC,KAAK,CAAC,IAAI,CACR,KAAK,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,OAAO,EAAE,EAAE,EACvE,cAAc,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,YAAY,IAAI,CAAC,YAAY,6BAA6B,IAAI,CAAC,uBAAuB,EAAE,EAChI,cAAc,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,MAAM,cAAc,IAAI,CAAC,EAAE,EAAE,CAC5E,CAAC;QACJ,CAAC;QACD,KAAK,CAAC,IAAI,CAAC,uBAAuB,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;IACjE,CAAC,CAAC,CAAC;IAEH,KAAK,CAAC,IAAI,CAAC,EAAE,EAAE,oBAAoB,CAAC,CAAC;IACrC,KAAK,MAAM,MAAM,IAAI,UAAU,CAAC,OAAO,EAAE,CAAC;QACxC,KAAK,CAAC,IAAI,CACR,KAAK,MAAM,CAAC,MAAM,KAAK,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,IAAI,MAAM,CAAC,IAAI,KAAK,WAAW,CAAC,MAAM,CAAC,UAAU,CAAC,MAAM,WAAW,CAAC,MAAM,CAAC,UAAU,CAAC,EAAE,EAClI,OAAO,MAAM,CAAC,OAAO,EAAE,CACxB,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,EAAE,EAAE,eAAe,UAAU,CAAC,UAAU,CAAC,OAAO,EAAE,CAAC,CAAC;IAC/D,IAAI,UAAU,CAAC,cAAc,KAAK,SAAS,EAAE,CAAC;QAC5C,KAAK,CAAC,IAAI,CAAC,mBAAmB,UAAU,CAAC,cAAc,CAAC,OAAO,EAAE,CAAC,CAAC;QACnE,KAAK,MAAM,MAAM,IAAI,UAAU,CAAC,cAAc,CAAC,OAAO;YAAE,KAAK,CAAC,IAAI,CAAC,OAAO,MAAM,EAAE,CAAC,CAAC;IACtF,CAAC;IACD,IAAI,UAAU,CAAC,OAAO,CAAC,eAAe,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAClD,KAAK,CAAC,IAAI,CAAC,EAAE,EAAE,mBAAmB,CAAC,CAAC;QACpC,KAAK,MAAM,IAAI,IAAI,UAAU,CAAC,OAAO,CAAC,eAAe;YAAE,KAAK,CAAC,IAAI,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC;IACnF,CAAC;IACD,KAAK,CAAC,IAAI,CAAC,EAAE,EAAE,oBAAoB,UAAU,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC;IAC/D,KAAK,MAAM,UAAU,IAAI,UAAU,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC;QACvD,KAAK,CAAC,IAAI,CAAC,GAAG,UAAU,CAAC,KAAK,CAAC,WAAW,EAAE,KAAK,UAAU,CAAC,OAAO,EAAE,CAAC,CAAC;IACzE,CAAC;IACD,OAAO,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;AACjC,CAAC;AAED,SAAS,WAAW,CAAC,KAAgE;IACnF,IAAI,KAAK,KAAK,SAAS;QAAE,OAAO,aAAa,CAAC;IAC9C,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;QAAE,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,MAAM,CAAC;IAC5D,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC;AACvB,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"renderPackageInspection.d.ts","sourceRoot":"","sources":["../../src/output/renderPackageInspection.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAEhE,wBAAgB,uBAAuB,CAAC,UAAU,EAAE,iBAAiB,GAAG,MAAM,CAqE7E"}
|
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
export function renderPackageInspection(inspection) {
|
|
2
|
+
const lines = [
|
|
3
|
+
`PkgWise inspect · ${inspection.selector}`,
|
|
4
|
+
`${inspection.report.project.manager} · ${inspection.report.project.lockfile ?? 'no lockfile'}`,
|
|
5
|
+
formatAvailableVersions(inspection.availableVersions),
|
|
6
|
+
];
|
|
7
|
+
for (const item of inspection.packages) {
|
|
8
|
+
lines.push('', `${item.name}${item.version === undefined ? '' : `@${item.version}`}`, ` Locator ID: ${item.id}`, ` Direct: ${item.direct ? 'yes' : 'no'}${item.directScopes.length === 0 ? '' : ` · scopes ${item.directScopes.join(', ')}`}`, ` Minimum depth: ${item.minimumDepth}`, ' Dependency paths:');
|
|
9
|
+
if (item.dependencyPaths.length === 0) {
|
|
10
|
+
lines.push(' Paths were not requested or are unavailable.');
|
|
11
|
+
}
|
|
12
|
+
else {
|
|
13
|
+
for (const path of item.dependencyPaths) {
|
|
14
|
+
lines.push(` project -> ${path.packages
|
|
15
|
+
.map((step) => `${step.name}${step.version === undefined ? '' : `@${step.version}`}`)
|
|
16
|
+
.join(' -> ')}`);
|
|
17
|
+
}
|
|
18
|
+
}
|
|
19
|
+
}
|
|
20
|
+
if (inspection.remote !== undefined) {
|
|
21
|
+
lines.push('', `npm Registry: ${inspection.remote.status} · cache ${inspection.remote.source.cache}`);
|
|
22
|
+
if (inspection.remote.status === 'available') {
|
|
23
|
+
lines.push(` Selected: ${inspection.remote.name}${inspection.remote.selectedVersion === undefined ? '' : `@${inspection.remote.selectedVersion}`}`, ` License: ${inspection.remote.license ?? 'unknown'}`, ` Node engines: ${inspection.remote.engines?.node ?? 'unknown'}`);
|
|
24
|
+
if (inspection.remote.description !== undefined) {
|
|
25
|
+
lines.push(` ${inspection.remote.description}`);
|
|
26
|
+
}
|
|
27
|
+
if (inspection.remote.deprecated !== undefined) {
|
|
28
|
+
lines.push(` DEPRECATED: ${inspection.remote.deprecated}`);
|
|
29
|
+
}
|
|
30
|
+
}
|
|
31
|
+
}
|
|
32
|
+
lines.push('', `Security advisories: ${inspection.advisories.length}`);
|
|
33
|
+
for (const advisory of [...inspection.advisories].sort(compareAdvisories)) {
|
|
34
|
+
lines.push(` ${advisory.severity.toUpperCase()} ${advisory.id}${advisory.active ? '' : ' · withdrawn'}`, ...(advisory.summary === undefined ? [] : [` ${advisory.summary}`]));
|
|
35
|
+
}
|
|
36
|
+
lines.push('', `Related findings: ${inspection.findings.length}`);
|
|
37
|
+
for (const finding of inspection.findings) {
|
|
38
|
+
lines.push(` ${finding.severity.toUpperCase()} [${finding.ruleId}] ${finding.title}`, ` ${finding.fingerprint}`);
|
|
39
|
+
}
|
|
40
|
+
lines.push('', `Analysis status: ${inspection.report.status}`);
|
|
41
|
+
for (const diagnostic of inspection.report.diagnostics) {
|
|
42
|
+
lines.push(`${diagnostic.level.toUpperCase()}: ${diagnostic.message}`);
|
|
43
|
+
}
|
|
44
|
+
return `${lines.join('\n')}\n`;
|
|
45
|
+
}
|
|
46
|
+
function formatAvailableVersions(versions) {
|
|
47
|
+
if (versions.length === 0)
|
|
48
|
+
return 'Available versions: unknown';
|
|
49
|
+
if (versions.length <= 12)
|
|
50
|
+
return `Available versions: ${versions.join(', ')}`;
|
|
51
|
+
return `Available versions (${versions.length}): …, ${versions.slice(-10).join(', ')}`;
|
|
52
|
+
}
|
|
53
|
+
function compareAdvisories(left, right) {
|
|
54
|
+
const severity = ['critical', 'high', 'medium', 'low', 'info', 'unknown'];
|
|
55
|
+
return (severity.indexOf(left.severity) - severity.indexOf(right.severity) ||
|
|
56
|
+
left.id.localeCompare(right.id));
|
|
57
|
+
}
|
|
58
|
+
//# sourceMappingURL=renderPackageInspection.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"renderPackageInspection.js","sourceRoot":"","sources":["../../src/output/renderPackageInspection.ts"],"names":[],"mappings":"AAEA,MAAM,UAAU,uBAAuB,CAAC,UAA6B;IACnE,MAAM,KAAK,GAAG;QACZ,qBAAqB,UAAU,CAAC,QAAQ,EAAE;QAC1C,GAAG,UAAU,CAAC,MAAM,CAAC,OAAO,CAAC,OAAO,MAAM,UAAU,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ,IAAI,aAAa,EAAE;QAC/F,uBAAuB,CAAC,UAAU,CAAC,iBAAiB,CAAC;KACtD,CAAC;IAEF,KAAK,MAAM,IAAI,IAAI,UAAU,CAAC,QAAQ,EAAE,CAAC;QACvC,KAAK,CAAC,IAAI,CACR,EAAE,EACF,GAAG,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,OAAO,EAAE,EAAE,EACrE,iBAAiB,IAAI,CAAC,EAAE,EAAE,EAC1B,aAAa,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,GAAG,IAAI,CAAC,YAAY,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,aAAa,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,EAC7H,oBAAoB,IAAI,CAAC,YAAY,EAAE,EACvC,qBAAqB,CACtB,CAAC;QACF,IAAI,IAAI,CAAC,eAAe,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACtC,KAAK,CAAC,IAAI,CAAC,kDAAkD,CAAC,CAAC;QACjE,CAAC;aAAM,CAAC;YACN,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,eAAe,EAAE,CAAC;gBACxC,KAAK,CAAC,IAAI,CACR,kBAAkB,IAAI,CAAC,QAAQ;qBAC5B,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,GAAG,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,OAAO,EAAE,EAAE,CAAC;qBACpF,IAAI,CAAC,MAAM,CAAC,EAAE,CAClB,CAAC;YACJ,CAAC;QACH,CAAC;IACH,CAAC;IAED,IAAI,UAAU,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;QACpC,KAAK,CAAC,IAAI,CACR,EAAE,EACF,iBAAiB,UAAU,CAAC,MAAM,CAAC,MAAM,YAAY,UAAU,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,CACtF,CAAC;QACF,IAAI,UAAU,CAAC,MAAM,CAAC,MAAM,KAAK,WAAW,EAAE,CAAC;YAC7C,KAAK,CAAC,IAAI,CACR,eAAe,UAAU,CAAC,MAAM,CAAC,IAAI,GAAG,UAAU,CAAC,MAAM,CAAC,eAAe,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,UAAU,CAAC,MAAM,CAAC,eAAe,EAAE,EAAE,EACxI,cAAc,UAAU,CAAC,MAAM,CAAC,OAAO,IAAI,SAAS,EAAE,EACtD,mBAAmB,UAAU,CAAC,MAAM,CAAC,OAAO,EAAE,IAAI,IAAI,SAAS,EAAE,CAClE,CAAC;YACF,IAAI,UAAU,CAAC,MAAM,CAAC,WAAW,KAAK,SAAS,EAAE,CAAC;gBAChD,KAAK,CAAC,IAAI,CAAC,KAAK,UAAU,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC,CAAC;YACnD,CAAC;YACD,IAAI,UAAU,CAAC,MAAM,CAAC,UAAU,KAAK,SAAS,EAAE,CAAC;gBAC/C,KAAK,CAAC,IAAI,CAAC,iBAAiB,UAAU,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC,CAAC;YAC9D,CAAC;QACH,CAAC;IACH,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,EAAE,EAAE,wBAAwB,UAAU,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC,CAAC;IACvE,KAAK,MAAM,QAAQ,IAAI,CAAC,GAAG,UAAU,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,iBAAiB,CAAC,EAAE,CAAC;QAC1E,KAAK,CAAC,IAAI,CACR,KAAK,QAAQ,CAAC,QAAQ,CAAC,WAAW,EAAE,IAAI,QAAQ,CAAC,EAAE,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,cAAc,EAAE,EAC7F,GAAG,CAAC,QAAQ,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,OAAO,QAAQ,CAAC,OAAO,EAAE,CAAC,CAAC,CACvE,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,EAAE,EAAE,qBAAqB,UAAU,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;IAClE,KAAK,MAAM,OAAO,IAAI,UAAU,CAAC,QAAQ,EAAE,CAAC;QAC1C,KAAK,CAAC,IAAI,CACR,KAAK,OAAO,CAAC,QAAQ,CAAC,WAAW,EAAE,KAAK,OAAO,CAAC,MAAM,KAAK,OAAO,CAAC,KAAK,EAAE,EAC1E,OAAO,OAAO,CAAC,WAAW,EAAE,CAC7B,CAAC;IACJ,CAAC;IACD,KAAK,CAAC,IAAI,CAAC,EAAE,EAAE,oBAAoB,UAAU,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC;IAC/D,KAAK,MAAM,UAAU,IAAI,UAAU,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC;QACvD,KAAK,CAAC,IAAI,CAAC,GAAG,UAAU,CAAC,KAAK,CAAC,WAAW,EAAE,KAAK,UAAU,CAAC,OAAO,EAAE,CAAC,CAAC;IACzE,CAAC;IACD,OAAO,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;AACjC,CAAC;AAED,SAAS,uBAAuB,CAAC,QAA2B;IAC1D,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,6BAA6B,CAAC;IAChE,IAAI,QAAQ,CAAC,MAAM,IAAI,EAAE;QAAE,OAAO,uBAAuB,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;IAC/E,OAAO,uBAAuB,QAAQ,CAAC,MAAM,SAAS,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;AACzF,CAAC;AAED,SAAS,iBAAiB,CACxB,IAA6C,EAC7C,KAA8C;IAE9C,MAAM,QAAQ,GAAG,CAAC,UAAU,EAAE,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,MAAM,EAAE,SAAS,CAAC,CAAC;IAC1E,OAAO,CACL,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,QAAQ,CAAC,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC;QAClE,IAAI,CAAC,EAAE,CAAC,aAAa,CAAC,KAAK,CAAC,EAAE,CAAC,CAChC,CAAC;AACJ,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"renderSarifReport.d.ts","sourceRoot":"","sources":["../../src/output/renderSarifReport.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAA4B,MAAM,wBAAwB,CAAC;AAEvF,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,cAAc,GAAG,MAAM,CAgDhE"}
|
|
@@ -0,0 +1,145 @@
|
|
|
1
|
+
export function renderSarifReport(report) {
|
|
2
|
+
const ruleIds = [...new Set(report.findings.map((finding) => finding.ruleId))].sort();
|
|
3
|
+
const ruleIndexes = new Map(ruleIds.map((id, index) => [id, index]));
|
|
4
|
+
const artifactUri = report.project.lockfile ?? 'package.json';
|
|
5
|
+
const sarif = {
|
|
6
|
+
$schema: 'https://json.schemastore.org/sarif-2.1.0.json',
|
|
7
|
+
version: '2.1.0',
|
|
8
|
+
runs: [
|
|
9
|
+
{
|
|
10
|
+
tool: {
|
|
11
|
+
driver: {
|
|
12
|
+
name: 'PkgWise',
|
|
13
|
+
version: report.tool.version,
|
|
14
|
+
...(isSemanticVersion(report.tool.version)
|
|
15
|
+
? { semanticVersion: report.tool.version }
|
|
16
|
+
: {}),
|
|
17
|
+
informationUri: 'docs/spec/README.md',
|
|
18
|
+
rules: ruleIds.map((ruleId) => createRuleDescriptor(ruleId, report.findings)),
|
|
19
|
+
},
|
|
20
|
+
},
|
|
21
|
+
artifacts: [{ location: { uri: artifactUri } }],
|
|
22
|
+
invocations: [
|
|
23
|
+
{
|
|
24
|
+
executionSuccessful: true,
|
|
25
|
+
toolExecutionNotifications: report.diagnostics.map((diagnostic) => ({
|
|
26
|
+
descriptor: { id: diagnostic.code },
|
|
27
|
+
level: diagnostic.level === 'warning' ? 'warning' : 'note',
|
|
28
|
+
message: { text: diagnostic.message },
|
|
29
|
+
})),
|
|
30
|
+
properties: {
|
|
31
|
+
analysisStatus: report.status,
|
|
32
|
+
coverage: report.coverage.overall,
|
|
33
|
+
policyStatus: report.policy.status,
|
|
34
|
+
},
|
|
35
|
+
},
|
|
36
|
+
],
|
|
37
|
+
results: report.findings.map((finding) => createResult(finding, ruleIndexes.get(finding.ruleId), artifactUri)),
|
|
38
|
+
properties: {
|
|
39
|
+
schemaVersion: report.schemaVersion,
|
|
40
|
+
packageManager: report.project.manager,
|
|
41
|
+
packageCount: report.graph.packageCount,
|
|
42
|
+
},
|
|
43
|
+
},
|
|
44
|
+
],
|
|
45
|
+
};
|
|
46
|
+
return `${JSON.stringify(sarif, null, 2)}\n`;
|
|
47
|
+
}
|
|
48
|
+
function createRuleDescriptor(ruleId, findings) {
|
|
49
|
+
const representative = findings.find((finding) => finding.ruleId === ruleId);
|
|
50
|
+
return {
|
|
51
|
+
id: ruleId,
|
|
52
|
+
name: ruleId.replaceAll(/[^a-zA-Z0-9]+/g, '_'),
|
|
53
|
+
shortDescription: { text: ruleTitle(ruleId) },
|
|
54
|
+
fullDescription: { text: ruleDescription(ruleId) },
|
|
55
|
+
help: {
|
|
56
|
+
text: representative.recommendation.summary,
|
|
57
|
+
markdown: representative.recommendation.summary,
|
|
58
|
+
},
|
|
59
|
+
defaultConfiguration: { level: defaultRuleLevel(ruleId) },
|
|
60
|
+
properties: {
|
|
61
|
+
ruleVersion: representative.ruleVersion,
|
|
62
|
+
category: representative.category,
|
|
63
|
+
evidenceKind: representative.evidence[0]?.kind ?? 'unknown',
|
|
64
|
+
},
|
|
65
|
+
};
|
|
66
|
+
}
|
|
67
|
+
function createResult(finding, ruleIndex, artifactUri) {
|
|
68
|
+
const resolvedPaths = finding.dependencyPaths.filter((path) => path.packages.length > 0);
|
|
69
|
+
return {
|
|
70
|
+
ruleId: finding.ruleId,
|
|
71
|
+
ruleIndex,
|
|
72
|
+
level: sarifLevel(finding.severity),
|
|
73
|
+
message: {
|
|
74
|
+
text: `${finding.title}: ${finding.summary} Recommendation: ${finding.recommendation.summary}`,
|
|
75
|
+
},
|
|
76
|
+
partialFingerprints: {
|
|
77
|
+
'pkgwiseFindingFingerprint/v1': finding.fingerprint,
|
|
78
|
+
},
|
|
79
|
+
locations: [{ physicalLocation: { artifactLocation: { uri: artifactUri } } }],
|
|
80
|
+
...(resolvedPaths.length === 0
|
|
81
|
+
? {}
|
|
82
|
+
: {
|
|
83
|
+
codeFlows: resolvedPaths.map((path) => ({
|
|
84
|
+
threadFlows: [
|
|
85
|
+
{
|
|
86
|
+
locations: path.packages.map((item) => ({
|
|
87
|
+
location: {
|
|
88
|
+
logicalLocations: [
|
|
89
|
+
{
|
|
90
|
+
name: item.name,
|
|
91
|
+
fullyQualifiedName: `${item.name}${item.version === undefined ? '' : `@${item.version}`}`,
|
|
92
|
+
kind: 'package',
|
|
93
|
+
},
|
|
94
|
+
],
|
|
95
|
+
},
|
|
96
|
+
})),
|
|
97
|
+
},
|
|
98
|
+
],
|
|
99
|
+
})),
|
|
100
|
+
}),
|
|
101
|
+
properties: {
|
|
102
|
+
priority: finding.priority,
|
|
103
|
+
confidence: finding.confidence,
|
|
104
|
+
category: finding.category,
|
|
105
|
+
evidenceKind: finding.evidence[0]?.kind ?? 'unknown',
|
|
106
|
+
packageIds: finding.subject.packageIds,
|
|
107
|
+
pathsTruncated: finding.pathsTruncated,
|
|
108
|
+
},
|
|
109
|
+
};
|
|
110
|
+
}
|
|
111
|
+
function defaultRuleLevel(ruleId) {
|
|
112
|
+
return ruleId === 'compatibility/unresolved-dependency' ? 'warning' : 'note';
|
|
113
|
+
}
|
|
114
|
+
function isSemanticVersion(value) {
|
|
115
|
+
return /^(?:0|[1-9]\d*)\.(?:0|[1-9]\d*)\.(?:0|[1-9]\d*)(?:-[0-9A-Za-z-]+(?:\.[0-9A-Za-z-]+)*)?(?:\+[0-9A-Za-z-]+(?:\.[0-9A-Za-z-]+)*)?$/.test(value);
|
|
116
|
+
}
|
|
117
|
+
function sarifLevel(severity) {
|
|
118
|
+
if (severity === 'critical' || severity === 'high')
|
|
119
|
+
return 'error';
|
|
120
|
+
if (severity === 'medium')
|
|
121
|
+
return 'warning';
|
|
122
|
+
return 'note';
|
|
123
|
+
}
|
|
124
|
+
function ruleTitle(ruleId) {
|
|
125
|
+
if (ruleId === 'reliability/version-fragmentation')
|
|
126
|
+
return 'Multiple package versions';
|
|
127
|
+
if (ruleId === 'reliability/dependency-cycle')
|
|
128
|
+
return 'Dependency cycle';
|
|
129
|
+
if (ruleId === 'compatibility/unresolved-dependency')
|
|
130
|
+
return 'Unresolved dependency';
|
|
131
|
+
return ruleId;
|
|
132
|
+
}
|
|
133
|
+
function ruleDescription(ruleId) {
|
|
134
|
+
if (ruleId === 'reliability/version-fragmentation') {
|
|
135
|
+
return 'Reports multiple exact versions of the same package in the reachable dependency graph.';
|
|
136
|
+
}
|
|
137
|
+
if (ruleId === 'reliability/dependency-cycle') {
|
|
138
|
+
return 'Reports strongly connected components in the resolved dependency graph.';
|
|
139
|
+
}
|
|
140
|
+
if (ruleId === 'compatibility/unresolved-dependency') {
|
|
141
|
+
return 'Reports required dependency relations without a matching lockfile locator.';
|
|
142
|
+
}
|
|
143
|
+
return 'PkgWise dependency analysis rule.';
|
|
144
|
+
}
|
|
145
|
+
//# sourceMappingURL=renderSarifReport.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"renderSarifReport.js","sourceRoot":"","sources":["../../src/output/renderSarifReport.ts"],"names":[],"mappings":"AAEA,MAAM,UAAU,iBAAiB,CAAC,MAAsB;IACtD,MAAM,OAAO,GAAG,CAAC,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;IACtF,MAAM,WAAW,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC,EAAE,EAAE,KAAK,CAAU,CAAC,CAAC,CAAC;IAC9E,MAAM,WAAW,GAAG,MAAM,CAAC,OAAO,CAAC,QAAQ,IAAI,cAAc,CAAC;IAC9D,MAAM,KAAK,GAAG;QACZ,OAAO,EAAE,+CAA+C;QACxD,OAAO,EAAE,OAAO;QAChB,IAAI,EAAE;YACJ;gBACE,IAAI,EAAE;oBACJ,MAAM,EAAE;wBACN,IAAI,EAAE,SAAS;wBACf,OAAO,EAAE,MAAM,CAAC,IAAI,CAAC,OAAO;wBAC5B,GAAG,CAAC,iBAAiB,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC;4BACxC,CAAC,CAAC,EAAE,eAAe,EAAE,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE;4BAC1C,CAAC,CAAC,EAAE,CAAC;wBACP,cAAc,EAAE,qBAAqB;wBACrC,KAAK,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,oBAAoB,CAAC,MAAM,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAC;qBAC9E;iBACF;gBACD,SAAS,EAAE,CAAC,EAAE,QAAQ,EAAE,EAAE,GAAG,EAAE,WAAW,EAAE,EAAE,CAAC;gBAC/C,WAAW,EAAE;oBACX;wBACE,mBAAmB,EAAE,IAAI;wBACzB,0BAA0B,EAAE,MAAM,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC;4BAClE,UAAU,EAAE,EAAE,EAAE,EAAE,UAAU,CAAC,IAAI,EAAE;4BACnC,KAAK,EAAE,UAAU,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM;4BAC1D,OAAO,EAAE,EAAE,IAAI,EAAE,UAAU,CAAC,OAAO,EAAE;yBACtC,CAAC,CAAC;wBACH,UAAU,EAAE;4BACV,cAAc,EAAE,MAAM,CAAC,MAAM;4BAC7B,QAAQ,EAAE,MAAM,CAAC,QAAQ,CAAC,OAAO;4BACjC,YAAY,EAAE,MAAM,CAAC,MAAM,CAAC,MAAM;yBACnC;qBACF;iBACF;gBACD,OAAO,EAAE,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CACvC,YAAY,CAAC,OAAO,EAAE,WAAW,CAAC,GAAG,CAAC,OAAO,CAAC,MAAM,CAAW,EAAE,WAAW,CAAC,CAC9E;gBACD,UAAU,EAAE;oBACV,aAAa,EAAE,MAAM,CAAC,aAAa;oBACnC,cAAc,EAAE,MAAM,CAAC,OAAO,CAAC,OAAO;oBACtC,YAAY,EAAE,MAAM,CAAC,KAAK,CAAC,YAAY;iBACxC;aACF;SACF;KACF,CAAC;IACF,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC;AAC/C,CAAC;AAED,SAAS,oBAAoB,CAAC,MAAc,EAAE,QAA4B;IACxE,MAAM,cAAc,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,MAAM,KAAK,MAAM,CAAY,CAAC;IACxF,OAAO;QACL,EAAE,EAAE,MAAM;QACV,IAAI,EAAE,MAAM,CAAC,UAAU,CAAC,gBAAgB,EAAE,GAAG,CAAC;QAC9C,gBAAgB,EAAE,EAAE,IAAI,EAAE,SAAS,CAAC,MAAM,CAAC,EAAE;QAC7C,eAAe,EAAE,EAAE,IAAI,EAAE,eAAe,CAAC,MAAM,CAAC,EAAE;QAClD,IAAI,EAAE;YACJ,IAAI,EAAE,cAAc,CAAC,cAAc,CAAC,OAAO;YAC3C,QAAQ,EAAE,cAAc,CAAC,cAAc,CAAC,OAAO;SAChD;QACD,oBAAoB,EAAE,EAAE,KAAK,EAAE,gBAAgB,CAAC,MAAM,CAAC,EAAE;QACzD,UAAU,EAAE;YACV,WAAW,EAAE,cAAc,CAAC,WAAW;YACvC,QAAQ,EAAE,cAAc,CAAC,QAAQ;YACjC,YAAY,EAAE,cAAc,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,IAAI,IAAI,SAAS;SAC5D;KACF,CAAC;AACJ,CAAC;AAED,SAAS,YAAY,CAAC,OAAgB,EAAE,SAAiB,EAAE,WAAmB;IAC5E,MAAM,aAAa,GAAG,OAAO,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IACzF,OAAO;QACL,MAAM,EAAE,OAAO,CAAC,MAAM;QACtB,SAAS;QACT,KAAK,EAAE,UAAU,CAAC,OAAO,CAAC,QAAQ,CAAC;QACnC,OAAO,EAAE;YACP,IAAI,EAAE,GAAG,OAAO,CAAC,KAAK,KAAK,OAAO,CAAC,OAAO,oBAAoB,OAAO,CAAC,cAAc,CAAC,OAAO,EAAE;SAC/F;QACD,mBAAmB,EAAE;YACnB,8BAA8B,EAAE,OAAO,CAAC,WAAW;SACpD;QACD,SAAS,EAAE,CAAC,EAAE,gBAAgB,EAAE,EAAE,gBAAgB,EAAE,EAAE,GAAG,EAAE,WAAW,EAAE,EAAE,EAAE,CAAC;QAC7E,GAAG,CAAC,aAAa,CAAC,MAAM,KAAK,CAAC;YAC5B,CAAC,CAAC,EAAE;YACJ,CAAC,CAAC;gBACE,SAAS,EAAE,aAAa,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;oBACtC,WAAW,EAAE;wBACX;4BACE,SAAS,EAAE,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;gCACtC,QAAQ,EAAE;oCACR,gBAAgB,EAAE;wCAChB;4CACE,IAAI,EAAE,IAAI,CAAC,IAAI;4CACf,kBAAkB,EAAE,GAAG,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,OAAO,EAAE,EAAE;4CACzF,IAAI,EAAE,SAAS;yCAChB;qCACF;iCACF;6BACF,CAAC,CAAC;yBACJ;qBACF;iBACF,CAAC,CAAC;aACJ,CAAC;QACN,UAAU,EAAE;YACV,QAAQ,EAAE,OAAO,CAAC,QAAQ;YAC1B,UAAU,EAAE,OAAO,CAAC,UAAU;YAC9B,QAAQ,EAAE,OAAO,CAAC,QAAQ;YAC1B,YAAY,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,IAAI,IAAI,SAAS;YACpD,UAAU,EAAE,OAAO,CAAC,OAAO,CAAC,UAAU;YACtC,cAAc,EAAE,OAAO,CAAC,cAAc;SACvC;KACF,CAAC;AACJ,CAAC;AAED,SAAS,gBAAgB,CAAC,MAAc;IACtC,OAAO,MAAM,KAAK,qCAAqC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC;AAC/E,CAAC;AAED,SAAS,iBAAiB,CAAC,KAAa;IACtC,OAAO,iIAAiI,CAAC,IAAI,CAC3I,KAAK,CACN,CAAC;AACJ,CAAC;AAED,SAAS,UAAU,CAAC,QAAyB;IAC3C,IAAI,QAAQ,KAAK,UAAU,IAAI,QAAQ,KAAK,MAAM;QAAE,OAAO,OAAO,CAAC;IACnE,IAAI,QAAQ,KAAK,QAAQ;QAAE,OAAO,SAAS,CAAC;IAC5C,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,SAAS,SAAS,CAAC,MAAc;IAC/B,IAAI,MAAM,KAAK,mCAAmC;QAAE,OAAO,2BAA2B,CAAC;IACvF,IAAI,MAAM,KAAK,8BAA8B;QAAE,OAAO,kBAAkB,CAAC;IACzE,IAAI,MAAM,KAAK,qCAAqC;QAAE,OAAO,uBAAuB,CAAC;IACrF,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,SAAS,eAAe,CAAC,MAAc;IACrC,IAAI,MAAM,KAAK,mCAAmC,EAAE,CAAC;QACnD,OAAO,wFAAwF,CAAC;IAClG,CAAC;IACD,IAAI,MAAM,KAAK,8BAA8B,EAAE,CAAC;QAC9C,OAAO,yEAAyE,CAAC;IACnF,CAAC;IACD,IAAI,MAAM,KAAK,qCAAqC,EAAE,CAAC;QACrD,OAAO,4EAA4E,CAAC;IACtF,CAAC;IACD,OAAO,mCAAmC,CAAC;AAC7C,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"renderStructuredResult.d.ts","sourceRoot":"","sources":["../../src/output/renderStructuredResult.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAC;AAGhE,wBAAgB,sBAAsB,CAAC,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,YAAY,GAAG,MAAM,CAmBnF"}
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
import { PkgWiseError } from '@lovlydev/pkgwise-core';
|
|
2
|
+
import { renderGenericMarkdown } from './renderMarkdownReport.js';
|
|
3
|
+
export function renderStructuredResult(value, format) {
|
|
4
|
+
if (format === 'json') {
|
|
5
|
+
return `${JSON.stringify(value, null, 2)}\n`;
|
|
6
|
+
}
|
|
7
|
+
if (format === 'terminal') {
|
|
8
|
+
return `${JSON.stringify(value, null, 2)}\n`;
|
|
9
|
+
}
|
|
10
|
+
if (format === 'markdown') {
|
|
11
|
+
return renderGenericMarkdown(value);
|
|
12
|
+
}
|
|
13
|
+
throw new PkgWiseError({
|
|
14
|
+
code: 'PW_FEATURE_NOT_IMPLEMENTED',
|
|
15
|
+
userMessage: `${format.toUpperCase()} reporting is not implemented in this development build yet.`,
|
|
16
|
+
recoverable: false,
|
|
17
|
+
details: { format },
|
|
18
|
+
});
|
|
19
|
+
}
|
|
20
|
+
//# sourceMappingURL=renderStructuredResult.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"renderStructuredResult.js","sourceRoot":"","sources":["../../src/output/renderStructuredResult.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AAEtD,OAAO,EAAE,qBAAqB,EAAE,MAAM,2BAA2B,CAAC;AAElE,MAAM,UAAU,sBAAsB,CAAC,KAAc,EAAE,MAAoB;IACzE,IAAI,MAAM,KAAK,MAAM,EAAE,CAAC;QACtB,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC;IAC/C,CAAC;IAED,IAAI,MAAM,KAAK,UAAU,EAAE,CAAC;QAC1B,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC;IAC/C,CAAC;IAED,IAAI,MAAM,KAAK,UAAU,EAAE,CAAC;QAC1B,OAAO,qBAAqB,CAAC,KAAK,CAAC,CAAC;IACtC,CAAC;IAED,MAAM,IAAI,YAAY,CAAC;QACrB,IAAI,EAAE,4BAA4B;QAClC,WAAW,EAAE,GAAG,MAAM,CAAC,WAAW,EAAE,8DAA8D;QAClG,WAAW,EAAE,KAAK;QAClB,OAAO,EAAE,EAAE,MAAM,EAAE;KACpB,CAAC,CAAC;AACL,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"writeTextOutput.d.ts","sourceRoot":"","sources":["../../src/output/writeTextOutput.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,gBAAgB,CAAC;AAE5C,wBAAsB,eAAe,CACnC,OAAO,EAAE,MAAM,EACf,UAAU,EAAE,MAAM,GAAG,SAAS,EAC9B,EAAE,EAAE,KAAK,GACR,OAAO,CAAC,IAAI,CAAC,CAkBf"}
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
import { mkdir, rename, rm, writeFile } from 'node:fs/promises';
|
|
2
|
+
import { dirname, resolve } from 'node:path';
|
|
3
|
+
import { randomUUID } from 'node:crypto';
|
|
4
|
+
export async function writeTextOutput(content, outputPath, io) {
|
|
5
|
+
if (outputPath === undefined) {
|
|
6
|
+
io.stdout.write(content);
|
|
7
|
+
return;
|
|
8
|
+
}
|
|
9
|
+
const target = resolve(outputPath);
|
|
10
|
+
const parent = dirname(target);
|
|
11
|
+
const temporary = `${target}.${randomUUID()}.tmp`;
|
|
12
|
+
await mkdir(parent, { recursive: true });
|
|
13
|
+
try {
|
|
14
|
+
await writeFile(temporary, content, { encoding: 'utf8', flag: 'wx' });
|
|
15
|
+
await rename(temporary, target);
|
|
16
|
+
}
|
|
17
|
+
catch (error) {
|
|
18
|
+
await rm(temporary, { force: true });
|
|
19
|
+
throw error;
|
|
20
|
+
}
|
|
21
|
+
}
|
|
22
|
+
//# sourceMappingURL=writeTextOutput.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"writeTextOutput.js","sourceRoot":"","sources":["../../src/output/writeTextOutput.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAChE,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAC7C,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAGzC,MAAM,CAAC,KAAK,UAAU,eAAe,CACnC,OAAe,EACf,UAA8B,EAC9B,EAAS;IAET,IAAI,UAAU,KAAK,SAAS,EAAE,CAAC;QAC7B,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QACzB,OAAO;IACT,CAAC;IAED,MAAM,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;IACnC,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAC/B,MAAM,SAAS,GAAG,GAAG,MAAM,IAAI,UAAU,EAAE,MAAM,CAAC;IAClD,MAAM,KAAK,CAAC,MAAM,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IAEzC,IAAI,CAAC;QACH,MAAM,SAAS,CAAC,SAAS,EAAE,OAAO,EAAE,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;QACtE,MAAM,MAAM,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;IAClC,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,EAAE,CAAC,SAAS,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;QACrC,MAAM,KAAK,CAAC;IACd,CAAC;AACH,CAAC"}
|
package/dist/runCli.d.ts
ADDED
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import { PkgWiseError, type PkgWiseClient } from '@lovlydev/pkgwise-core';
|
|
2
|
+
import type { CliIo } from './io/CliIo.js';
|
|
3
|
+
export interface RunCliOptions {
|
|
4
|
+
readonly client?: PkgWiseClient;
|
|
5
|
+
readonly io?: CliIo;
|
|
6
|
+
readonly signal?: AbortSignal;
|
|
7
|
+
readonly version?: string;
|
|
8
|
+
}
|
|
9
|
+
export declare function runCli(argv: readonly string[], options?: RunCliOptions): Promise<number>;
|
|
10
|
+
export declare function createCancelledError(): PkgWiseError;
|
|
11
|
+
//# sourceMappingURL=runCli.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"runCli.d.ts","sourceRoot":"","sources":["../src/runCli.ts"],"names":[],"mappings":"AAAA,OAAO,EAAiB,YAAY,EAAE,KAAK,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAIzF,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,eAAe,CAAC;AAI3C,MAAM,WAAW,aAAa;IAC5B,QAAQ,CAAC,MAAM,CAAC,EAAE,aAAa,CAAC;IAChC,QAAQ,CAAC,EAAE,CAAC,EAAE,KAAK,CAAC;IACpB,QAAQ,CAAC,MAAM,CAAC,EAAE,WAAW,CAAC;IAC9B,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED,wBAAsB,MAAM,CAC1B,IAAI,EAAE,SAAS,MAAM,EAAE,EACvB,OAAO,GAAE,aAAkB,GAC1B,OAAO,CAAC,MAAM,CAAC,CAwCjB;AAYD,wBAAgB,oBAAoB,IAAI,YAAY,CAMnD"}
|
package/dist/runCli.js
ADDED
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
import { createPkgWise, PkgWiseError } from '@lovlydev/pkgwise-core';
|
|
2
|
+
import { CommanderError } from 'commander';
|
|
3
|
+
import { createCli } from './createCli.js';
|
|
4
|
+
import { mapErrorToExitCode } from './exit/mapErrorToExitCode.js';
|
|
5
|
+
import { processCliIo } from './io/CliIo.js';
|
|
6
|
+
import { renderCliError } from './output/renderCliError.js';
|
|
7
|
+
export async function runCli(argv, options = {}) {
|
|
8
|
+
const io = options.io ?? processCliIo;
|
|
9
|
+
const client = options.client ?? createPkgWise();
|
|
10
|
+
const signal = options.signal ?? new AbortController().signal;
|
|
11
|
+
let exitCode = 0;
|
|
12
|
+
const program = createCli({
|
|
13
|
+
client,
|
|
14
|
+
io,
|
|
15
|
+
signal,
|
|
16
|
+
version: options.version ?? '0.1.0-alpha.0',
|
|
17
|
+
setExitCode(code) {
|
|
18
|
+
exitCode = code;
|
|
19
|
+
},
|
|
20
|
+
});
|
|
21
|
+
try {
|
|
22
|
+
await program.parseAsync([...argv], { from: 'user' });
|
|
23
|
+
return exitCode;
|
|
24
|
+
}
|
|
25
|
+
catch (error) {
|
|
26
|
+
if (error instanceof CommanderError) {
|
|
27
|
+
return error.exitCode === 0 ? 0 : 2;
|
|
28
|
+
}
|
|
29
|
+
const mappedCode = mapErrorToExitCode(error);
|
|
30
|
+
const format = readRequestedFormat(argv);
|
|
31
|
+
const debug = argv.includes('--debug');
|
|
32
|
+
const envelope = renderCliError(error, debug);
|
|
33
|
+
if (format === 'json' || format === 'sarif') {
|
|
34
|
+
io.stdout.write(`${JSON.stringify(envelope, null, 2)}\n`);
|
|
35
|
+
}
|
|
36
|
+
else {
|
|
37
|
+
io.stderr.write(`Error [${envelope.error.code}]: ${envelope.error.message}\n`);
|
|
38
|
+
if (debug && error instanceof Error && error.stack !== undefined) {
|
|
39
|
+
io.stderr.write(`${error.stack}\n`);
|
|
40
|
+
}
|
|
41
|
+
}
|
|
42
|
+
return mappedCode;
|
|
43
|
+
}
|
|
44
|
+
}
|
|
45
|
+
function readRequestedFormat(argv) {
|
|
46
|
+
const assignment = argv.find((argument) => argument.startsWith('--format='));
|
|
47
|
+
if (assignment !== undefined) {
|
|
48
|
+
return assignment.slice('--format='.length);
|
|
49
|
+
}
|
|
50
|
+
const index = argv.indexOf('--format');
|
|
51
|
+
return index === -1 ? undefined : argv[index + 1];
|
|
52
|
+
}
|
|
53
|
+
export function createCancelledError() {
|
|
54
|
+
return new PkgWiseError({
|
|
55
|
+
code: 'PW_CANCELLED',
|
|
56
|
+
userMessage: 'The operation was cancelled.',
|
|
57
|
+
recoverable: true,
|
|
58
|
+
});
|
|
59
|
+
}
|
|
60
|
+
//# sourceMappingURL=runCli.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"runCli.js","sourceRoot":"","sources":["../src/runCli.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,YAAY,EAAsB,MAAM,wBAAwB,CAAC;AACzF,OAAO,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAC3C,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC3C,OAAO,EAAE,kBAAkB,EAAE,MAAM,8BAA8B,CAAC;AAElE,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAC7C,OAAO,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAS5D,MAAM,CAAC,KAAK,UAAU,MAAM,CAC1B,IAAuB,EACvB,UAAyB,EAAE;IAE3B,MAAM,EAAE,GAAG,OAAO,CAAC,EAAE,IAAI,YAAY,CAAC;IACtC,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,IAAI,aAAa,EAAE,CAAC;IACjD,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,IAAI,IAAI,eAAe,EAAE,CAAC,MAAM,CAAC;IAC9D,IAAI,QAAQ,GAAG,CAAC,CAAC;IAEjB,MAAM,OAAO,GAAG,SAAS,CAAC;QACxB,MAAM;QACN,EAAE;QACF,MAAM;QACN,OAAO,EAAE,OAAO,CAAC,OAAO,IAAI,eAAe;QAC3C,WAAW,CAAC,IAAI;YACd,QAAQ,GAAG,IAAI,CAAC;QAClB,CAAC;KACF,CAAC,CAAC;IAEH,IAAI,CAAC;QACH,MAAM,OAAO,CAAC,UAAU,CAAC,CAAC,GAAG,IAAI,CAAC,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC;QACtD,OAAO,QAAQ,CAAC;IAClB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,KAAK,YAAY,cAAc,EAAE,CAAC;YACpC,OAAO,KAAK,CAAC,QAAQ,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QACtC,CAAC;QAED,MAAM,UAAU,GAAG,kBAAkB,CAAC,KAAK,CAAC,CAAC;QAC7C,MAAM,MAAM,GAAG,mBAAmB,CAAC,IAAI,CAAC,CAAC;QACzC,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;QACvC,MAAM,QAAQ,GAAG,cAAc,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;QAE9C,IAAI,MAAM,KAAK,MAAM,IAAI,MAAM,KAAK,OAAO,EAAE,CAAC;YAC5C,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC;QAC5D,CAAC;aAAM,CAAC;YACN,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,UAAU,QAAQ,CAAC,KAAK,CAAC,IAAI,MAAM,QAAQ,CAAC,KAAK,CAAC,OAAO,IAAI,CAAC,CAAC;YAC/E,IAAI,KAAK,IAAI,KAAK,YAAY,KAAK,IAAI,KAAK,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;gBACjE,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,KAAK,CAAC,KAAK,IAAI,CAAC,CAAC;YACtC,CAAC;QACH,CAAC;QAED,OAAO,UAAU,CAAC;IACpB,CAAC;AACH,CAAC;AAED,SAAS,mBAAmB,CAAC,IAAuB;IAClD,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC,CAAC;IAC7E,IAAI,UAAU,KAAK,SAAS,EAAE,CAAC;QAC7B,OAAO,UAAU,CAAC,KAAK,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;IAC9C,CAAC;IAED,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;IACvC,OAAO,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC;AACpD,CAAC;AAED,MAAM,UAAU,oBAAoB;IAClC,OAAO,IAAI,YAAY,CAAC;QACtB,IAAI,EAAE,cAAc;QACpB,WAAW,EAAE,8BAA8B;QAC3C,WAAW,EAAE,IAAI;KAClB,CAAC,CAAC;AACL,CAAC"}
|
package/package.json
ADDED
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "pkgwise",
|
|
3
|
+
"version": "0.1.0-alpha.0",
|
|
4
|
+
"description": "Explainable dependency analysis for JavaScript and TypeScript projects",
|
|
5
|
+
"keywords": [
|
|
6
|
+
"dependencies",
|
|
7
|
+
"security",
|
|
8
|
+
"npm",
|
|
9
|
+
"osv",
|
|
10
|
+
"audit",
|
|
11
|
+
"cli"
|
|
12
|
+
],
|
|
13
|
+
"type": "module",
|
|
14
|
+
"sideEffects": false,
|
|
15
|
+
"license": "MIT",
|
|
16
|
+
"author": "LovlyDev",
|
|
17
|
+
"repository": {
|
|
18
|
+
"type": "git",
|
|
19
|
+
"url": "git+https://github.com/lovlyDev/pkgWise.git",
|
|
20
|
+
"directory": "packages/cli"
|
|
21
|
+
},
|
|
22
|
+
"homepage": "https://github.com/lovlyDev/pkgWise#readme",
|
|
23
|
+
"bugs": {
|
|
24
|
+
"url": "https://github.com/lovlyDev/pkgWise/issues"
|
|
25
|
+
},
|
|
26
|
+
"publishConfig": {
|
|
27
|
+
"access": "public",
|
|
28
|
+
"provenance": true
|
|
29
|
+
},
|
|
30
|
+
"files": [
|
|
31
|
+
"dist",
|
|
32
|
+
"README.md",
|
|
33
|
+
"CHANGELOG.md",
|
|
34
|
+
"LICENSE"
|
|
35
|
+
],
|
|
36
|
+
"bin": {
|
|
37
|
+
"pkgwise": "./dist/bin/pkgwise.js"
|
|
38
|
+
},
|
|
39
|
+
"exports": {
|
|
40
|
+
".": {
|
|
41
|
+
"types": "./dist/index.d.ts",
|
|
42
|
+
"import": "./dist/index.js"
|
|
43
|
+
}
|
|
44
|
+
},
|
|
45
|
+
"dependencies": {
|
|
46
|
+
"commander": "^14.0.0",
|
|
47
|
+
"@lovlydev/pkgwise-core": "0.1.0-alpha.0"
|
|
48
|
+
},
|
|
49
|
+
"engines": {
|
|
50
|
+
"node": ">=22.0.0"
|
|
51
|
+
},
|
|
52
|
+
"scripts": {
|
|
53
|
+
"build": "node ../../node_modules/typescript/bin/tsc -p tsconfig.build.json",
|
|
54
|
+
"typecheck": "node ../../node_modules/typescript/bin/tsc -p tsconfig.json --noEmit",
|
|
55
|
+
"test": "node ../../node_modules/typescript/bin/tsc -p tsconfig.test.json && node --test .test-dist/test/**/*.test.js"
|
|
56
|
+
}
|
|
57
|
+
}
|