@nerviq/cli 1.29.0 → 1.30.0

package/src/formatters/markdown.js

@@ -1,164 +1,164 @@
-/**
- * Markdown Formatter
- *
- * Converts a nerviq audit result into GitHub-flavoured markdown suitable
- * for posting as a PR comment. Structure:
- *
- *   - Header with score badge and pass/fail/skip counts
- *   - Top 5 topNextActions as a GitHub task-list checklist
- *   - Collapsible <details> block with the full failed-checks table
- *   - Footer with Nerviq link, version, timestamp
- *
- * Output is plain GitHub-flavoured markdown. The only HTML used is
- * <details>/<summary>, which GitHub renders natively.
- */
-
-'use strict';
-
-const { version: nerviqVersion } = require('../../package.json');
-const { SHALLOW_RISK_BANNER_LINES } = require('../shallow-risk');
-
-function escapeCell(value) {
-  if (value === null || value === undefined) return '';
-  return String(value)
-    .replace(/\r?\n/g, ' ')
-    .replace(/\|/g, '\\|');
-}
-
-function escapeInline(value) {
-  if (value === null || value === undefined) return '';
-  return String(value).replace(/\r?\n/g, ' ');
-}
-
-function scoreBadge(score) {
-  const s = Number.isFinite(score) ? Math.round(score) : 0;
-  let color;
-  if (s >= 80) color = 'brightgreen';
-  else if (s >= 60) color = 'yellow';
-  else color = 'red';
-  return `![score](https://img.shields.io/badge/nerviq_score-${s}%2F100-${color})`;
-}
-
-function severityFor(item) {
-  return item.severity || item.impact || 'medium';
-}
-
-function formatMarkdown(auditResult, options = {}) {
-  const platformLabel = auditResult.platformLabel || auditResult.platform || 'claude';
-  const score = auditResult.score ?? 0;
-  const passed = auditResult.passed ?? 0;
-  const failed = auditResult.failed ?? 0;
-  const skipped = auditResult.skipped ?? 0;
-  const version = auditResult.version || nerviqVersion;
-  const timestamp = auditResult.timestamp || new Date().toISOString();
-
-  const lines = [];
-
-  lines.push(`## Score: ${score}/100 ${scoreBadge(score)}`);
-  lines.push('');
-  lines.push(`**Platform:** ${platformLabel}  `);
-  lines.push(`**Checks:** ${passed} passed, ${failed} failed, ${skipped} skipped`);
-  lines.push('');
-
-  const top = Array.isArray(auditResult.topNextActions)
-    ? auditResult.topNextActions.slice(0, 5)
-    : [];
-
-  if (top.length > 0) {
-    lines.push('### Top next actions');
-    lines.push('');
-    for (const item of top) {
-      const sev = severityFor(item).toString().toUpperCase();
-      const title = escapeInline(item.name || item.title || item.key);
-      const key = escapeInline(item.key || item.id || '');
-      let loc = '';
-      if (item.file) {
-        loc = ` — \`${escapeInline(item.file)}${item.line ? ':' + item.line : ''}\``;
-      }
-      let delta = '';
-      if (Number.isFinite(item.projectedScoreDelta) && item.projectedScoreDelta > 0) {
-        delta = ` (+${item.projectedScoreDelta} pts → ${item.projectedScoreAfter}/100)`;
-      }
-      // CTO-08: include scope layer as a small suffix after the key so
-      // evaluators see which layer each next-action belongs to.
-      const layerSuffix = item.layer ? ` · _layer: ${escapeInline(item.layer)}_` : '';
-      lines.push(`- [ ] **[${sev}] ${title}** (\`${key}\`)${loc}${delta}${layerSuffix}`);
-      const hint = item.fix || item.hint || '';
-      if (hint) {
-        lines.push(`  - ${escapeInline(hint)}`);
-      }
-      if (item.snippet) {
-        lines.push('');
-        lines.push('  ```');
-        for (const snipLine of String(item.snippet).split(/\r?\n/)) {
-          lines.push(`  ${snipLine}`);
-        }
-        lines.push('  ```');
-      }
-    }
-    lines.push('');
-  }
-
-  if (Array.isArray(auditResult.shallowRiskHints)) {
-    lines.push('### Shallow Risk (experimental, opt-in)');
-    lines.push('');
-    for (const line of SHALLOW_RISK_BANNER_LINES) {
-      lines.push(`> ${line}`);
-    }
-    lines.push('');
-
-    if (auditResult.shallowRiskHints.length === 0) {
-      lines.push('_No shallow-risk hints found._');
-      lines.push('');
-    } else {
-      for (const item of auditResult.shallowRiskHints) {
-        const sev = severityFor(item).toString().toUpperCase();
-        const title = escapeInline(item.name || item.title || item.key);
-        let loc = '';
-        if (item.file) {
-          loc = ` — \`${escapeInline(item.file)}${item.line ? ':' + item.line : ''}\``;
-        }
-        lines.push(`- **[${sev}] ${title}** (\`${escapeInline(item.key || '')}\`)${loc}`);
-        if (item.fix) {
-          lines.push(`  - ${escapeInline(item.fix)}`);
-        }
-      }
-      lines.push('');
-    }
-  }
-
-  const failedResults = Array.isArray(auditResult.results)
-    ? auditResult.results.filter((r) => r.passed === false)
-    : [];
-
-  if (failedResults.length > 0) {
-    lines.push('<details>');
-    lines.push(`<summary>All failed checks (${failedResults.length})</summary>`);
-    lines.push('');
-    // CTO-08: add layer column between category and rating.
-    lines.push('| key | name | category | layer | rating | file | line |');
-    lines.push('| --- | --- | --- | --- | --- | --- | --- |');
-    for (const r of failedResults) {
-      const row = [
-        escapeCell(r.key),
-        escapeCell(r.name),
-        escapeCell(r.category),
-        escapeCell(r.layer || ''),
-        escapeCell(r.rating ?? ''),
-        escapeCell(r.file || ''),
-        escapeCell(r.line || ''),
-      ];
-      lines.push(`| ${row.join(' | ')} |`);
-    }
-    lines.push('');
-    lines.push('</details>');
-    lines.push('');
-  }
-
-  lines.push(`---`);
-  lines.push(`Generated by [Nerviq](https://nerviq.net) v${version} · ${timestamp}`);
-
-  return lines.join('\n');
-}
-
-module.exports = { formatMarkdown };
+/**
+ * Markdown Formatter
+ *
+ * Converts a nerviq audit result into GitHub-flavoured markdown suitable
+ * for posting as a PR comment. Structure:
+ *
+ *   - Header with score badge and pass/fail/skip counts
+ *   - Top 5 topNextActions as a GitHub task-list checklist
+ *   - Collapsible <details> block with the full failed-checks table
+ *   - Footer with Nerviq link, version, timestamp
+ *
+ * Output is plain GitHub-flavoured markdown. The only HTML used is
+ * <details>/<summary>, which GitHub renders natively.
+ */
+
+'use strict';
+
+const { version: nerviqVersion } = require('../../package.json');
+const { SHALLOW_RISK_BANNER_LINES } = require('../shallow-risk');
+
+function escapeCell(value) {
+  if (value === null || value === undefined) return '';
+  return String(value)
+    .replace(/\r?\n/g, ' ')
+    .replace(/\|/g, '\\|');
+}
+
+function escapeInline(value) {
+  if (value === null || value === undefined) return '';
+  return String(value).replace(/\r?\n/g, ' ');
+}
+
+function scoreBadge(score) {
+  const s = Number.isFinite(score) ? Math.round(score) : 0;
+  let color;
+  if (s >= 80) color = 'brightgreen';
+  else if (s >= 60) color = 'yellow';
+  else color = 'red';
+  return `![score](https://img.shields.io/badge/nerviq_score-${s}%2F100-${color})`;
+}
+
+function severityFor(item) {
+  return item.severity || item.impact || 'medium';
+}
+
+function formatMarkdown(auditResult, options = {}) {
+  const platformLabel = auditResult.platformLabel || auditResult.platform || 'claude';
+  const score = auditResult.score ?? 0;
+  const passed = auditResult.passed ?? 0;
+  const failed = auditResult.failed ?? 0;
+  const skipped = auditResult.skipped ?? 0;
+  const version = auditResult.version || nerviqVersion;
+  const timestamp = auditResult.timestamp || new Date().toISOString();
+
+  const lines = [];
+
+  lines.push(`## Score: ${score}/100 ${scoreBadge(score)}`);
+  lines.push('');
+  lines.push(`**Platform:** ${platformLabel}  `);
+  lines.push(`**Checks:** ${passed} passed, ${failed} failed, ${skipped} skipped`);
+  lines.push('');
+
+  const top = Array.isArray(auditResult.topNextActions)
+    ? auditResult.topNextActions.slice(0, 5)
+    : [];
+
+  if (top.length > 0) {
+    lines.push('### Top next actions');
+    lines.push('');
+    for (const item of top) {
+      const sev = severityFor(item).toString().toUpperCase();
+      const title = escapeInline(item.name || item.title || item.key);
+      const key = escapeInline(item.key || item.id || '');
+      let loc = '';
+      if (item.file) {
+        loc = ` — \`${escapeInline(item.file)}${item.line ? ':' + item.line : ''}\``;
+      }
+      let delta = '';
+      if (Number.isFinite(item.projectedScoreDelta) && item.projectedScoreDelta > 0) {
+        delta = ` (+${item.projectedScoreDelta} pts → ${item.projectedScoreAfter}/100)`;
+      }
+      // CTO-08: include scope layer as a small suffix after the key so
+      // evaluators see which layer each next-action belongs to.
+      const layerSuffix = item.layer ? ` · _layer: ${escapeInline(item.layer)}_` : '';
+      lines.push(`- [ ] **[${sev}] ${title}** (\`${key}\`)${loc}${delta}${layerSuffix}`);
+      const hint = item.fix || item.hint || '';
+      if (hint) {
+        lines.push(`  - ${escapeInline(hint)}`);
+      }
+      if (item.snippet) {
+        lines.push('');
+        lines.push('  ```');
+        for (const snipLine of String(item.snippet).split(/\r?\n/)) {
+          lines.push(`  ${snipLine}`);
+        }
+        lines.push('  ```');
+      }
+    }
+    lines.push('');
+  }
+
+  if (Array.isArray(auditResult.shallowRiskHints)) {
+    lines.push('### Shallow Risk (experimental, opt-in)');
+    lines.push('');
+    for (const line of SHALLOW_RISK_BANNER_LINES) {
+      lines.push(`> ${line}`);
+    }
+    lines.push('');
+
+    if (auditResult.shallowRiskHints.length === 0) {
+      lines.push('_No shallow-risk hints found._');
+      lines.push('');
+    } else {
+      for (const item of auditResult.shallowRiskHints) {
+        const sev = severityFor(item).toString().toUpperCase();
+        const title = escapeInline(item.name || item.title || item.key);
+        let loc = '';
+        if (item.file) {
+          loc = ` — \`${escapeInline(item.file)}${item.line ? ':' + item.line : ''}\``;
+        }
+        lines.push(`- **[${sev}] ${title}** (\`${escapeInline(item.key || '')}\`)${loc}`);
+        if (item.fix) {
+          lines.push(`  - ${escapeInline(item.fix)}`);
+        }
+      }
+      lines.push('');
+    }
+  }
+
+  const failedResults = Array.isArray(auditResult.results)
+    ? auditResult.results.filter((r) => r.passed === false)
+    : [];
+
+  if (failedResults.length > 0) {
+    lines.push('<details>');
+    lines.push(`<summary>All failed checks (${failedResults.length})</summary>`);
+    lines.push('');
+    // CTO-08: add layer column between category and rating.
+    lines.push('| key | name | category | layer | rating | file | line |');
+    lines.push('| --- | --- | --- | --- | --- | --- | --- |');
+    for (const r of failedResults) {
+      const row = [
+        escapeCell(r.key),
+        escapeCell(r.name),
+        escapeCell(r.category),
+        escapeCell(r.layer || ''),
+        escapeCell(r.rating ?? ''),
+        escapeCell(r.file || ''),
+        escapeCell(r.line || ''),
+      ];
+      lines.push(`| ${row.join(' | ')} |`);
+    }
+    lines.push('');
+    lines.push('</details>');
+    lines.push('');
+  }
+
+  lines.push(`---`);
+  lines.push(`Generated by [Nerviq](https://nerviq.net) v${version} · ${timestamp}`);
+
+  return lines.join('\n');
+}
+
+module.exports = { formatMarkdown };

package/src/formatters/otel.js

@@ -1,151 +1,151 @@
-/**
- * OpenTelemetry Metrics Formatter
- *
- * Converts a nerviq audit result into an OpenTelemetry-compatible
- * metrics export format (OTLP JSON, metrics signal).
- *
- * Metrics emitted:
- *   nerviq.audit.score          — gauge   0-100
- *   nerviq.audit.checks.passed  — gauge   count of passing checks
- *   nerviq.audit.checks.failed  — gauge   count of failing checks
- *   nerviq.audit.checks.total   — gauge   total checks evaluated
- *   nerviq.audit.duration_ms    — gauge   audit wall-clock time (if provided)
- *
- * Each metric is tagged with:
- *   platform   — e.g. "claude", "codex", "cursor"
- *   version    — nerviq package version
- *
- * Output conforms to OTLP ExportMetricsServiceRequest JSON structure
- * (opentelemetry-proto/collector/metrics/v1).
- */
-
-'use strict';
-
-const { version: nerviqVersion } = require('../../package.json');
-
-// ─── Helpers ─────────────────────────────────────────────────────────────────
-
-function unixNanoNow() {
-  // Returns current time as a bigint nanoseconds string for OTLP
-  return String(BigInt(Date.now()) * 1_000_000n);
-}
-
-function makeResource(platform) {
-  return {
-    attributes: [
-      { key: 'service.name', value: { stringValue: 'nerviq' } },
-      { key: 'service.version', value: { stringValue: nerviqVersion } },
-      { key: 'nerviq.platform', value: { stringValue: platform } },
-    ],
-    droppedAttributesCount: 0,
-  };
-}
-
-function makeGauge(name, description, unit, value, attributes = [], timeUnixNano) {
-  if (value === null || value === undefined) return null;
-  return {
-    name,
-    description,
-    unit,
-    gauge: {
-      dataPoints: [
-        {
-          attributes,
-          startTimeUnixNano: timeUnixNano,
-          timeUnixNano,
-          asDouble: Number(value),
-        },
-      ],
-    },
-  };
-}
-
-// ─── Main formatter ───────────────────────────────────────────────────────────
-
-/**
- * Convert a nerviq audit result to an OTLP-compatible metrics payload.
- *
- * @param {object} auditResult         — result from audit()
- * @param {number} [auditResult.score]
- * @param {number} [auditResult.passed]
- * @param {number} [auditResult.failed]
- * @param {number} [auditResult.total]
- * @param {string} [auditResult.platform]
- * @param {number} [auditResult.durationMs]  — optional, set by caller
- * @returns {object} OTLP ExportMetricsServiceRequest JSON
- */
-function formatOtelMetrics(auditResult) {
-  const platform = auditResult.platform || 'claude';
-  const now = unixNanoNow();
-
-  const sharedAttributes = [
-    { key: 'nerviq.platform', value: { stringValue: platform } },
-    { key: 'nerviq.version', value: { stringValue: nerviqVersion } },
-  ];
-
-  const metrics = [
-    makeGauge(
-      'nerviq.audit.score',
-      'Nerviq audit score (0-100)',
-      '1',
-      auditResult.score,
-      sharedAttributes,
-      now,
-    ),
-    makeGauge(
-      'nerviq.audit.checks.passed',
-      'Number of checks that passed',
-      '{checks}',
-      auditResult.passed,
-      sharedAttributes,
-      now,
-    ),
-    makeGauge(
-      'nerviq.audit.checks.failed',
-      'Number of checks that failed',
-      '{checks}',
-      auditResult.failed,
-      sharedAttributes,
-      now,
-    ),
-    makeGauge(
-      'nerviq.audit.checks.total',
-      'Total number of checks evaluated',
-      '{checks}',
-      auditResult.total ?? ((auditResult.passed || 0) + (auditResult.failed || 0)),
-      sharedAttributes,
-      now,
-    ),
-  ].filter(Boolean);
-
-  if (auditResult.durationMs != null) {
-    const dm = makeGauge(
-      'nerviq.audit.duration_ms',
-      'Audit wall-clock duration in milliseconds',
-      'ms',
-      auditResult.durationMs,
-      sharedAttributes,
-      now,
-    );
-    if (dm) metrics.push(dm);
-  }
-
-  return {
-    resourceMetrics: [
-      {
-        resource: makeResource(platform),
-        scopeMetrics: [
-          {
-            scope: {
-              name: 'nerviq',
-              version: nerviqVersion,
-            },
-            metrics,
-          },
-        ],
-      },
-    ],
-  };
-}
-
-module.exports = { formatOtelMetrics };
+/**
+ * OpenTelemetry Metrics Formatter
+ *
+ * Converts a nerviq audit result into an OpenTelemetry-compatible
+ * metrics export format (OTLP JSON, metrics signal).
+ *
+ * Metrics emitted:
+ *   nerviq.audit.score          — gauge   0-100
+ *   nerviq.audit.checks.passed  — gauge   count of passing checks
+ *   nerviq.audit.checks.failed  — gauge   count of failing checks
+ *   nerviq.audit.checks.total   — gauge   total checks evaluated
+ *   nerviq.audit.duration_ms    — gauge   audit wall-clock time (if provided)
+ *
+ * Each metric is tagged with:
+ *   platform   — e.g. "claude", "codex", "cursor"
+ *   version    — nerviq package version
+ *
+ * Output conforms to OTLP ExportMetricsServiceRequest JSON structure
+ * (opentelemetry-proto/collector/metrics/v1).
+ */
+
+'use strict';
+
+const { version: nerviqVersion } = require('../../package.json');
+
+// ─── Helpers ─────────────────────────────────────────────────────────────────
+
+function unixNanoNow() {
+  // Returns current time as a bigint nanoseconds string for OTLP
+  return String(BigInt(Date.now()) * 1_000_000n);
+}
+
+function makeResource(platform) {
+  return {
+    attributes: [
+      { key: 'service.name', value: { stringValue: 'nerviq' } },
+      { key: 'service.version', value: { stringValue: nerviqVersion } },
+      { key: 'nerviq.platform', value: { stringValue: platform } },
+    ],
+    droppedAttributesCount: 0,
+  };
+}
+
+function makeGauge(name, description, unit, value, attributes = [], timeUnixNano) {
+  if (value === null || value === undefined) return null;
+  return {
+    name,
+    description,
+    unit,
+    gauge: {
+      dataPoints: [
+        {
+          attributes,
+          startTimeUnixNano: timeUnixNano,
+          timeUnixNano,
+          asDouble: Number(value),
+        },
+      ],
+    },
+  };
+}
+
+// ─── Main formatter ───────────────────────────────────────────────────────────
+
+/**
+ * Convert a nerviq audit result to an OTLP-compatible metrics payload.
+ *
+ * @param {object} auditResult         — result from audit()
+ * @param {number} [auditResult.score]
+ * @param {number} [auditResult.passed]
+ * @param {number} [auditResult.failed]
+ * @param {number} [auditResult.total]
+ * @param {string} [auditResult.platform]
+ * @param {number} [auditResult.durationMs]  — optional, set by caller
+ * @returns {object} OTLP ExportMetricsServiceRequest JSON
+ */
+function formatOtelMetrics(auditResult) {
+  const platform = auditResult.platform || 'claude';
+  const now = unixNanoNow();
+
+  const sharedAttributes = [
+    { key: 'nerviq.platform', value: { stringValue: platform } },
+    { key: 'nerviq.version', value: { stringValue: nerviqVersion } },
+  ];
+
+  const metrics = [
+    makeGauge(
+      'nerviq.audit.score',
+      'Nerviq audit score (0-100)',
+      '1',
+      auditResult.score,
+      sharedAttributes,
+      now,
+    ),
+    makeGauge(
+      'nerviq.audit.checks.passed',
+      'Number of checks that passed',
+      '{checks}',
+      auditResult.passed,
+      sharedAttributes,
+      now,
+    ),
+    makeGauge(
+      'nerviq.audit.checks.failed',
+      'Number of checks that failed',
+      '{checks}',
+      auditResult.failed,
+      sharedAttributes,
+      now,
+    ),
+    makeGauge(
+      'nerviq.audit.checks.total',
+      'Total number of checks evaluated',
+      '{checks}',
+      auditResult.total ?? ((auditResult.passed || 0) + (auditResult.failed || 0)),
+      sharedAttributes,
+      now,
+    ),
+  ].filter(Boolean);
+
+  if (auditResult.durationMs != null) {
+    const dm = makeGauge(
+      'nerviq.audit.duration_ms',
+      'Audit wall-clock duration in milliseconds',
+      'ms',
+      auditResult.durationMs,
+      sharedAttributes,
+      now,
+    );
+    if (dm) metrics.push(dm);
+  }
+
+  return {
+    resourceMetrics: [
+      {
+        resource: makeResource(platform),
+        scopeMetrics: [
+          {
+            scope: {
+              name: 'nerviq',
+              version: nerviqVersion,
+            },
+            metrics,
+          },
+        ],
+      },
+    ],
+  };
+}
+
+module.exports = { formatOtelMetrics };