open/ktg-plugin-marketplace
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity Actions

feat(humanizer): wire humanizer into 6 remaining CLIs with --raw

Browse source 
Adds --raw flag to all 6 remaining CLIs and wires humanization into the
default rendering path. --json and --raw both bypass humanization for
v5.0.0 byte-equal output; default mode humanizes findings/diff/prose.

  token-hotspots-cli: humanizes payload.findings before stdout JSON write.
  plugin-health-scanner: humanizes finding titles in stderr brief summary;
    --json/--raw write byte-identical v5.0.0-shape result to stdout.
  drift-cli: humanizes diff.{newFindings,resolvedFindings,unchangedFindings,
    movedFindings} before formatDiffReport; --raw applies to save and list
    modes too. Baselines remain raw v5.0.0 on disk.
  fix-cli: humanizes manual-finding titles in stderr fix-plan prose; both
    --json and --raw produce identical machine-readable JSON to stdout.
  manifest, whats-active: --raw is a no-op (no findings, inventory only)
    but parsed for CLI surface consistency.

Decision on missing --output-file flag for drift-cli/fix-cli/plugin-health:
deferred. SC-6/SC-7 tests in Wave 4 will use stdout-redirect (the simpler
Alt B path) since these CLIs already write JSON to stdout in machine modes.

Test cli-humanizer.test.mjs covers all 6 CLIs. Three CLIs that read
environment state (plugin-health, manifest, whats-active) verify
mode-equivalence (--json == --raw) instead of frozen-snapshot byte-equal,
because their output reflects current marketplace state which drifts as
plugins are added since the Wave 0 capture.

Wave 3 / Step 7 of v5.1.0 humanizer.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
This commit is contained in:
Kjell Tore Guttormsen 2026-05-01 17:47:09 +02:00
commit 5eecb968d8
7 changed files with 416 additions and 25 deletions
Download patch file Download diff file Expand all files Collapse all files

27
plugins/config-audit/scanners/drift-cli.mjs
View file

@ -14,6 +14,7 @@ import { resolve } from 'node:path';
import { runAllScanners } from './scan-orchestrator.mjs';
import { diffEnvelopes, formatDiffReport } from './lib/diff-engine.mjs';
import { saveBaseline, loadBaseline, listBaselines } from './lib/baseline.mjs';
import { humanizeFindings } from './lib/humanizer.mjs';
async function main() {
const args = process.argv.slice(2);
@ -22,6 +23,7 @@ async function main() {
let save = false;
let list = false;
let jsonMode = false;
let rawMode = false;
let includeGlobal = false;
for (let i = 0; i < args.length; i++) {
@ -35,6 +37,8 @@ async function main() {
list = true;
} else if (args[i] === '--json') {
jsonMode = true;
} else if (args[i] === '--raw') {
rawMode = true;
} else if (args[i] === '--global') {
includeGlobal = true;
} else if (!args[i].startsWith('-')) {
@ -45,7 +49,7 @@ async function main() {
// --- List mode ---
if (list) {
const result = await listBaselines();
if (jsonMode) {
if (jsonMode || rawMode) {
process.stdout.write(JSON.stringify(result, null, 2) + '\n');
} else {
if (result.baselines.length === 0) {
@ -66,7 +70,7 @@ async function main() {
// --- Save mode ---
if (save) {
if (!jsonMode) {
if (!jsonMode && !rawMode) {
process.stderr.write(`Config-Audit Drift CLI v2.1.0\n`);
process.stderr.write(`Saving baseline "${baselineName}" for ${resolve(targetPath)}\n\n`);
}
@ -74,7 +78,7 @@ async function main() {
const envelope = await runAllScanners(targetPath, { includeGlobal });
const result = await saveBaseline(envelope, baselineName);
if (jsonMode) {
if (jsonMode || rawMode) {
process.stdout.write(JSON.stringify({ saved: true, name: result.name, path: result.path }, null, 2) + '\n');
} else {
process.stderr.write(`\nBaseline "${result.name}" saved to ${result.path}\n`);
@ -84,7 +88,7 @@ async function main() {
}
// --- Drift mode (default) ---
if (!jsonMode) {
if (!jsonMode && !rawMode) {
process.stderr.write(`Config-Audit Drift CLI v2.1.0\n`);
process.stderr.write(`Target: ${resolve(targetPath)}\n`);
process.stderr.write(`Baseline: ${baselineName}\n\n`);
@ -93,7 +97,7 @@ async function main() {
// Load baseline
const baseline = await loadBaseline(baselineName);
if (!baseline) {
if (jsonMode) {
if (jsonMode || rawMode) {
process.stdout.write(JSON.stringify({ error: `Baseline "${baselineName}" not found. Save one with --save.` }, null, 2) + '\n');
} else {
process.stderr.write(`Baseline "${baselineName}" not found.\n`);
@ -108,10 +112,19 @@ async function main() {
// Diff
const diff = diffEnvelopes(baseline, current);
if (jsonMode) {
if (jsonMode || rawMode) {
// --json and --raw both write the raw v5.0.0-shape diff (byte-identical).
process.stdout.write(JSON.stringify(diff, null, 2) + '\n');
} else {
const report = formatDiffReport(diff);
// Default mode: humanize finding-bearing diff fields before report rendering.
const humanizedDiff = {
...diff,
newFindings: humanizeFindings(diff.newFindings || []),
resolvedFindings: humanizeFindings(diff.resolvedFindings || []),
unchangedFindings: humanizeFindings(diff.unchangedFindings || []),
movedFindings: humanizeFindings(diff.movedFindings || []),
};
const report = formatDiffReport(humanizedDiff);
process.stderr.write('\n' + report + '\n');
}

40
plugins/config-audit/scanners/fix-cli.mjs
View file

@ -12,12 +12,14 @@ import { resolve } from 'node:path';
import { runAllScanners } from './scan-orchestrator.mjs';
import { planFixes, applyFixes, verifyFixes } from './fix-engine.mjs';
import { createBackup } from './lib/backup.mjs';
import { humanizeFinding } from './lib/humanizer.mjs';
async function main() {
const args = process.argv.slice(2);
let targetPath = '.';
let apply = false;
let jsonMode = false;
let rawMode = false;
let includeGlobal = false;
for (let i = 0; i < args.length; i++) {
@ -25,6 +27,8 @@ async function main() {
apply = true;
} else if (args[i] === '--json') {
jsonMode = true;
} else if (args[i] === '--raw') {
rawMode = true;
} else if (args[i] === '--global') {
includeGlobal = true;
} else if (!args[i].startsWith('-')) {
@ -32,9 +36,12 @@ async function main() {
}
}
// Whether to suppress prose stderr (true for both --json and --raw machine paths).
const machineMode = jsonMode || rawMode;
const resolvedPath = resolve(targetPath);
if (!jsonMode) {
if (!machineMode) {
process.stderr.write(`Config-Audit Fix CLI v2.1.0\n`);
process.stderr.write(`Target: ${resolvedPath}\n`);
process.stderr.write(`Mode: ${apply ? 'APPLY' : 'DRY-RUN'}\n\n`);
@ -47,7 +54,7 @@ async function main() {
// 2. Plan fixes
const { fixes, skipped, manual } = planFixes(envelope);
if (!jsonMode) {
if (!machineMode) {
process.stderr.write(`\n`);
process.stderr.write(`━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━\n`);
process.stderr.write(` Config-Audit Fix Plan\n`);
@ -63,9 +70,20 @@ async function main() {
}
if (manual.length > 0) {
// Default mode humanizes the manual-finding titles for the prose render.
// The JSON `manual` array (later in this function) keeps v5.0.0 verbatim.
process.stderr.write(`\n Manual (${manual.length}):\n`);
for (let i = 0; i < manual.length; i++) {
process.stderr.write(` ${fixes.length + i + 1}. [${manual[i].findingId}] ${manual[i].title}\n`);
const m = manual[i];
const title = humanizeFinding({
id: m.findingId,
scanner: typeof m.findingId === 'string' ? m.findingId.split('-')[1] || '' : '',
severity: m.severity || 'info',
title: m.title,
description: m.description || '',
recommendation: m.recommendation || '',
}).title;
process.stderr.write(` ${fixes.length + i + 1}. [${m.findingId}] ${title}\n`);
}
}
@ -84,7 +102,7 @@ async function main() {
let backupId = null;
if (fixes.length === 0) {
if (jsonMode) {
if (machineMode) {
const output = { planned: [], applied: [], failed: [], verified: [], regressions: [], manual, backupId: null };
process.stdout.write(JSON.stringify(output, null, 2) + '\n');
}
@ -97,7 +115,7 @@ async function main() {
const backup = createBackup(filesToBackup);
backupId = backup.backupId;
if (!jsonMode) {
if (!machineMode) {
process.stderr.write(`\n Backup created: ${backup.backupPath}\n`);
process.stderr.write(` Applying ${fixes.length} fixes...\n\n`);
}
@ -106,7 +124,7 @@ async function main() {
applied = result.applied;
failed = result.failed;
if (!jsonMode) {
if (!machineMode) {
process.stderr.write(` Results: ${applied.length} applied, ${failed.length} failed\n`);
if (failed.length > 0) {
for (const f of failed) {
@ -117,7 +135,7 @@ async function main() {
// 4. Verify
if (applied.length > 0) {
if (!jsonMode) {
if (!machineMode) {
process.stderr.write(`\n Verifying...\n`);
}
@ -125,7 +143,7 @@ async function main() {
verified = verification.verified;
regressions = verification.regressions;
if (!jsonMode) {
if (!machineMode) {
process.stderr.write(` Verified: ${verified.length}/${applied.length}\n`);
if (regressions.length > 0) {
process.stderr.write(` Regressions: ${regressions.join(', ')}\n`);
@ -138,13 +156,13 @@ async function main() {
const result = await applyFixes(fixes, { dryRun: true });
applied = result.applied;
if (!jsonMode) {
if (!machineMode) {
process.stderr.write(`\n Dry-run complete. Pass --apply to execute.\n`);
}
}
// JSON output
if (jsonMode) {
// JSON output (both --json and --raw write byte-equal v5.0.0-shape stdout)
if (machineMode) {
const output = {
planned: fixes.map(f => ({
findingId: f.findingId,

6
plugins/config-audit/scanners/manifest.mjs
View file

@ -103,9 +103,13 @@ async function main() {
let targetPath = '.';
let outputFile = null;
let jsonMode = false;
// --raw is accepted for CLI surface consistency but is a no-op here:
// manifest produces a token-source inventory, not findings.
let rawMode = false;
for (let i = 0; i < args.length; i++) {
if (args[i] === '--json') jsonMode = true;
else if (args[i] === '--raw') rawMode = true;
else if (args[i] === '--output-file' && args[i + 1]) outputFile = args[++i];
else if (!args[i].startsWith('-')) targetPath = args[i];
}
@ -143,7 +147,7 @@ async function main() {
await writeFile(outputFile, json, 'utf-8');
}
if (jsonMode || !outputFile) {
if (jsonMode || rawMode || !outputFile) {
process.stdout.write(json + '\n');
}
}

14
plugins/config-audit/scanners/plugin-health-scanner.mjs
View file

@ -13,6 +13,7 @@ import { join, basename, resolve } from 'node:path';
import { finding, scannerResult, resetCounter } from './lib/output.mjs';
import { SEVERITY } from './lib/severity.mjs';
import { parseFrontmatter } from './lib/yaml-parser.mjs';
import { humanizeFindings } from './lib/humanizer.mjs';
const SCANNER = 'PLH';
@ -420,10 +421,13 @@ async function main() {
const args = process.argv.slice(2);
let targetPath = '.';
let jsonMode = false;
let rawMode = false;
for (let i = 0; i < args.length; i++) {
if (args[i] === '--json') {
jsonMode = true;
} else if (args[i] === '--raw') {
rawMode = true;
} else if (!args[i].startsWith('-')) {
targetPath = args[i];
}
@ -434,13 +438,15 @@ async function main() {
const result = await scan(targetPath);
if (jsonMode) {
if (jsonMode || rawMode) {
// --json and --raw both write the v5.0.0-shape result (byte-identical).
process.stdout.write(JSON.stringify(result, null, 2) + '\n');
} else {
// Brief summary
const count = result.findings.length;
// Default mode humanizes finding titles before writing the brief summary.
const findings = humanizeFindings(result.findings);
const count = findings.length;
process.stderr.write(`Findings: ${count}\n`);
for (const f of result.findings) {
for (const f of findings) {
process.stderr.write(` [${f.severity}] ${f.title}\n`);
}
}

11
plugins/config-audit/scanners/token-hotspots-cli.mjs
View file

@ -19,6 +19,7 @@ import { discoverConfigFiles } from './lib/file-discovery.mjs';
import { resetCounter } from './lib/output.mjs';
import { scan } from './token-hotspots.mjs';
import * as tokenizerApi from './lib/tokenizer-api.mjs';
import { humanizeFindings } from './lib/humanizer.mjs';
const __dirname = dirname(fileURLToPath(import.meta.url));
const TELEMETRY_RECIPE_PATH = resolve(__dirname, '..', 'knowledge', 'cache-telemetry-recipe.md');
@ -51,12 +52,14 @@ async function main() {
let targetPath = '.';
let outputFile = null;
let jsonMode = false;
let rawMode = false;
let includeGlobal = false;
let withTelemetryRecipe = false;
let accurateTokens = false;
for (let i = 0; i < args.length; i++) {
if (args[i] === '--json') jsonMode = true;
else if (args[i] === '--raw') rawMode = true;
else if (args[i] === '--global') includeGlobal = true;
else if (args[i] === '--with-telemetry-recipe') withTelemetryRecipe = true;
else if (args[i] === '--accurate-tokens') accurateTokens = true;
@ -111,13 +114,19 @@ async function main() {
}
}
// Default mode humanizes payload.findings (NOT result.findings).
// --json and --raw bypass for v5.0.0 byte-equal output.
if (!jsonMode && !rawMode) {
payload.findings = humanizeFindings(payload.findings);
}
const json = JSON.stringify(payload, null, 2);
if (outputFile) {
await writeFile(outputFile, json, 'utf-8');
}
if (jsonMode || !outputFile) {
if (jsonMode || rawMode || !outputFile) {
process.stdout.write(json + '\n');
}
}

6
plugins/config-audit/scanners/whats-active.mjs
View file

@ -21,11 +21,15 @@ async function main() {
let targetPath = '.';
let outputFile = null;
let jsonMode = false;
// --raw is accepted for CLI surface consistency but is a no-op here:
// whats-active produces an inventory snapshot, not findings.
let rawMode = false;
let verbose = false;
let suggestDisables = false;
for (let i = 0; i < args.length; i++) {
if (args[i] === '--json') jsonMode = true;
else if (args[i] === '--raw') rawMode = true;
else if (args[i] === '--verbose') verbose = true;
else if (args[i] === '--suggest-disables') suggestDisables = true;
else if (args[i] === '--output-file' && args[i + 1]) outputFile = args[++i];
@ -51,7 +55,7 @@ async function main() {
await writeFile(outputFile, json, 'utf-8');
}
if (jsonMode || !outputFile) {
if (jsonMode || rawMode || !outputFile) {
process.stdout.write(json + '\n');
}
}