@jonathan0823/pi-sonarqube 0.1.4 → 0.3.1

package/src/index.ts

@@ -10,6 +10,8 @@ import type {
   SonarIssueFetchOptions,
   SonarInitConfig,
   InitCommandOptions,
+  FileDuplication,
+  SonarProjectConfig,
 } from "./types.js";
 import {
   slugify,
@@ -29,8 +31,15 @@ import {
   waitForAnalysis,
   normalizeIssueFilters,
   fetchIssues,
+  fetchDuplicationMeasures,
+  fetchIssueSeverityCounts,
+  fetchIssueQualityCounts,
+  fetchFileDuplications,
+  fetchFileDuplicationBlocks,
   createAnalysisState,
   issueFilterLabel,
+  fetchCleanCodeMode,
+  assertFiltersNotAmbiguous,
 } from "./api.js";
 import {
   STATE_TYPE,
@@ -40,6 +49,9 @@ import {
   mergeAutocompleteSuggestions,
   formatIssue,
   formatSummary,
+  formatMetricsOutput,
+  formatDuplicationsList,
+  formatDuplicationBlockDetail,
   formatReport,
   helpText,
   targetLabel,
@@ -52,10 +64,11 @@ import {
   buildIssuePreview,
   openIssuePreview,
   resolveTargetState,
+  showDuplicationBrowser,
 } from "./ui.js";
 
 const SonarToolParams = Type.Object({
-  action: StringEnum(["analyze", "issues", "open"] as const),
+  action: StringEnum(["analyze", "issues", "open", "metrics", "duplications"] as const),
   path: Type.Optional(Type.String({ description: "Target alias or project directory to analyze or inspect" })),
   issueIndex: Type.Optional(Type.Number({ description: "1-based issue index to open" })),
   severities: Type.Optional(
@@ -66,6 +79,12 @@ const SonarToolParams = Type.Object({
   ),
   types: Type.Optional(Type.Array(Type.String({ description: "Issue type to fetch (e.g. BUG)" }))),
   rules: Type.Optional(Type.Array(Type.String({ description: "Rule keys to fetch" }))),
+  softwareQualities: Type.Optional(
+    Type.Array(Type.String({ description: "Software quality to fetch (e.g. MAINTAINABILITY)" })),
+  ),
+  impactSeverities: Type.Optional(
+    Type.Array(Type.String({ description: "Impact severity to fetch (e.g. HIGH)" })),
+  ),
 });
 
 // ── State restoration ───────────────────────────────────────────────────────
@@ -126,11 +145,24 @@ async function analyzeProject(
       normalizedFilters,
     );
 
+    analysisUi.setPhase("Fetching metrics...");
+    const measures = await fetchDuplicationMeasures(
+      config.serverUrl,
+      config.token,
+      config.projectKey,
+      ctx.signal,
+    );
+
+    analysisUi.setPhase("Detecting mode...");
+    const cleanCodeMode = await fetchCleanCodeMode(config.serverUrl, config.token, ctx.signal);
+
     const state = createAnalysisState(config, issues, {
       dashboardUrl,
       ceTaskUrl,
       analysisId,
       filters: normalizedFilters,
+      measures,
+      cleanCodeMode,
     });
 
     pi.appendEntry(STATE_TYPE, state);
@@ -249,12 +281,25 @@ function renderIssueListResult(
   theme: Theme,
 ): Text {
   const summary = formatSummary(state);
-  if (state.issues.length === 0) {
+  if (state.issues.length === 0 && !state.measures) {
     return new Text(theme.fg("success", summary), 0, 0);
   }
 
+  const lines: string[] = [];
+  lines.push(theme.fg("accent", summary));
+  if (state.measures) {
+    const density = state.measures.duplicatedLinesDensity.toFixed(1);
+    const detail = state.measures.duplicatedBlocks > 0
+      ? `Duplication: ${density}%  lines=${state.measures.duplicatedLines}  blocks=${state.measures.duplicatedBlocks}  files=${state.measures.duplicatedFiles}`
+      : `Duplication: ${density}%  (no duplications detected)`;
+    lines.push(theme.fg("dim", detail));
+  }
+
+  if (state.issues.length === 0) {
+    return new Text(lines.join("\n"), 0, 0);
+  }
+
   const visible = expanded ? state.issues : state.issues.slice(0, 5);
-  const lines: string[] = [theme.fg("accent", summary)];
   for (const [i, issue] of visible.entries()) {
     lines.push(theme.fg("muted", formatIssue(issue, i + 1)));
   }
@@ -292,7 +337,7 @@ export default function sonarqube(pi: ExtensionAPI) {
 
           const argumentText = match[1] ?? "";
           const { current: currentToken } = splitSonarArgumentContext(argumentText);
-          const extraItems = sonarArgumentCompletions(argumentText, latestState?.issues) ?? [];
+          const extraItems = sonarArgumentCompletions(argumentText, latestState?.issues, latestState?.cleanCodeMode) ?? [];
           const currentSuggestions = await current.getSuggestions(lines, cursorLine, cursorCol, options);
           const merged = mergeAutocompleteSuggestions(currentToken, currentSuggestions, extraItems);
           return merged ?? currentSuggestions;
@@ -320,7 +365,7 @@ export default function sonarqube(pi: ExtensionAPI) {
     promptSnippet: "Run local SonarQube analysis or inspect issue results",
     promptGuidelines: [
       "Use sonarqube when the user asks to run a local SonarQube scan, inspect issues, or open an issue's source location.",
-      "Use the optional severity, status, type, and rule filters to fetch only the most relevant issues.",
+      "Use the optional severity, status, type, rule, quality, and impact severity filters to fetch only the most relevant issues.",
     ],
     parameters: SonarToolParams,
 
@@ -331,7 +376,10 @@ export default function sonarqube(pi: ExtensionAPI) {
           statuses: params.statuses,
           types: params.types,
           rules: params.rules,
+          softwareQualities: params.softwareQualities,
+          impactSeverities: params.impactSeverities,
         });
+        assertFiltersNotAmbiguous(filters);
 
         if (params.action === "analyze") {
           const state = await analyzeProject(pi, ctx, params.path, filters);
@@ -339,6 +387,9 @@ export default function sonarqube(pi: ExtensionAPI) {
           return { content: [{ type: "text", text: formatReport(state) }], details: state };
         }
 
+        if (params.action === "duplications") return toolDuplications(ctx, params.path);
+        if (params.action === "metrics") return toolMetrics(ctx, params.path);
+
         const targetState = await resolveTargetState(ctx, statesByBaseDir, params.path, filters);
         if (!targetState) {
           return {
@@ -379,6 +430,8 @@ export default function sonarqube(pi: ExtensionAPI) {
         statuses: args.statuses,
         types: args.types,
         rules: args.rules,
+        softwareQualities: args.softwareQualities,
+        impactSeverities: args.impactSeverities,
       });
       const filterText = filters ? ` ${theme.fg("muted", issueFilterLabel(filters))}` : "";
       return new Text(
@@ -422,7 +475,7 @@ export default function sonarqube(pi: ExtensionAPI) {
 
   pi.registerCommand("sonarqube", {
     description: "Run a local SonarQube analysis, browse the latest issues, or init project config",
-    getArgumentCompletions: (argumentPrefix) => sonarArgumentCompletions(argumentPrefix, latestState?.issues),
+    getArgumentCompletions: (argumentPrefix) => sonarArgumentCompletions(argumentPrefix, latestState?.issues, latestState?.cleanCodeMode),
     handler: async (args, ctx) => {
       try {
         const parsed = parseCommandArgs(args);
@@ -437,6 +490,12 @@ export default function sonarqube(pi: ExtensionAPI) {
             await commandAnalyze(pi, ctx, parsed.targetInput, parsed.filters, rememberState);
             return;
           }
+          case "metrics":
+            await commandMetrics(ctx, parsed.targetInput);
+            return;
+          case "duplications":
+            await commandDuplications(pi, ctx, parsed.targetInput, parsed.issueIndex);
+            return;
           default:
             await commandIssuesOrOpen(pi, ctx, statesByBaseDir, parsed, rememberState);
         }
@@ -469,6 +528,96 @@ async function commandAnalyze(
   }
 }
 
+async function commandMetrics(
+  ctx: ExtensionCommandContext,
+  targetInput?: string,
+): Promise<void> {
+  const config = await resolveConfig(ctx, targetInput);
+  const [measures, issueCounts, qualityCounts] = await Promise.all([
+    fetchDuplicationMeasures(config.serverUrl, config.token, config.projectKey, ctx.signal),
+    fetchIssueSeverityCounts(config.serverUrl, config.token, config.projectKey, ctx.signal),
+    fetchIssueQualityCounts(config.serverUrl, config.token, config.projectKey, ctx.signal),
+  ]);
+  if (!measures && !issueCounts && !qualityCounts) {
+    if (ctx.hasUI) {
+      ctx.ui.notify(`Project "${config.projectKey}" has not been analyzed yet. Run /sonarqube analyze first.`, "warning");
+    }
+    return;
+  }
+  const text = formatMetricsOutput({ projectKey: config.projectKey, measures, issueCounts, issueQualityCounts: qualityCounts });
+  if (ctx.hasUI) {
+    ctx.ui.notify(text, "info");
+  }
+}
+
+async function commandDuplications(
+  pi: ExtensionAPI,
+  ctx: ExtensionCommandContext,
+  targetInput?: string,
+  fileIndex?: number,
+): Promise<void> {
+  const config = await resolveConfig(ctx, targetInput);
+  let files: FileDuplication[];
+  try {
+    files = await fetchFileDuplications(config.serverUrl, config.token, config.projectKey, ctx.signal);
+  } catch (error) {
+    const msg = sonarErrorMessage(error);
+    if (msg.includes("403") || msg.includes("Insufficient privileges")) {
+      if (ctx.hasUI) {
+        ctx.ui.notify("SonarQube token needs 'See Source Code' permission to list duplicated files. Update the token permissions in SonarQube and run /sonarqube init to update the token.", "warning");
+      }
+      return;
+    }
+    throw error;
+  }
+  if (files.length === 0) {
+    if (ctx.hasUI) ctx.ui.notify("No duplications found.", "info");
+    return;
+  }
+
+  if (fileIndex !== undefined) {
+    await showDuplicationDrillDown(ctx, config, files, fileIndex);
+    return;
+  }
+  await showDuplicationListOrBrowser(ctx, config, files);
+}
+
+async function showDuplicationDrillDown(
+  ctx: ExtensionCommandContext,
+  config: SonarProjectConfig,
+  files: FileDuplication[],
+  fileIndex: number,
+): Promise<void> {
+  const file = files[fileIndex - 1];
+  if (!file) {
+    if (ctx.hasUI) ctx.ui.notify(`File #${fileIndex} not found.`, "error");
+    return;
+  }
+  const groups = await fetchFileDuplicationBlocks(config.serverUrl, config.token, file.fileKey, config.projectKey, ctx.signal);
+  const text = formatDuplicationBlockDetail(file.filePath, groups);
+  if (ctx.mode === "tui") {
+    await ctx.ui.editor(`Duplications in ${file.filePath}`, text);
+  } else if (ctx.hasUI) {
+    ctx.ui.notify(text, "info");
+  }
+}
+
+async function showDuplicationListOrBrowser(
+  ctx: ExtensionCommandContext,
+  config: SonarProjectConfig,
+  files: FileDuplication[],
+): Promise<void> {
+  if (ctx.mode !== "tui") {
+    ctx.ui.notify(formatDuplicationsList(files), "info");
+    return;
+  }
+  const choice = await showDuplicationBrowser(ctx, files);
+  if (choice == null) return;
+  const file = files[choice];
+  const groups = await fetchFileDuplicationBlocks(config.serverUrl, config.token, file.fileKey, config.projectKey, ctx.signal);
+  await ctx.ui.editor(`Duplications in ${file.filePath}`, formatDuplicationBlockDetail(file.filePath, groups));
+}
+
 async function commandIssuesOrOpen(
   pi: ExtensionAPI,
   ctx: ExtensionCommandContext,
@@ -518,6 +667,69 @@ async function commandShowIssues(
   }
 }
 
+// ── Tool helper functions ────────────────────────────────────────────────────
+
+async function toolDuplications(ctx: any, path: string | undefined): Promise<{ content: Array<{ type: "text"; text: string }>; details: Record<string, unknown> }> {
+  let config;
+  try {
+    config = await resolveConfig(ctx, path);
+  } catch {
+    return {
+      content: [{ type: "text", text: "Project not configured. Run /sonarqube init first." }],
+      details: { error: "Project not configured." },
+    };
+  }
+  let files: FileDuplication[];
+  try {
+    files = await fetchFileDuplications(config.serverUrl, config.token, config.projectKey, ctx.signal);
+  } catch (error) {
+    const msg = sonarErrorMessage(error);
+    if (msg.includes("403") || msg.includes("Insufficient privileges")) {
+      return {
+        content: [{ type: "text", text: "SonarQube token needs 'See Source Code' permission to list duplicated files. Grant it in SonarQube project permissions, then update the token via /sonarqube init." }],
+        details: { error: "Token missing 'See Source Code' permission." },
+      };
+    }
+    return {
+      content: [{ type: "text", text: msg }],
+      details: { error: msg },
+    };
+  }
+  if (files.length === 0) {
+    return {
+      content: [{ type: "text", text: `No duplications found for ${config.projectKey}.` }],
+      details: { error: `No duplications found for ${config.projectKey}.` },
+    };
+  }
+  const text = formatDuplicationsList(files);
+  return { content: [{ type: "text", text }], details: { projectKey: config.projectKey, files } };
+}
+
+async function toolMetrics(ctx: any, path: string | undefined): Promise<{ content: Array<{ type: "text"; text: string }>; details: Record<string, unknown> }> {
+  let config;
+  try {
+    config = await resolveConfig(ctx, path);
+  } catch {
+    return {
+      content: [{ type: "text", text: "Project not configured. Run /sonarqube init first." }],
+      details: { error: "Project not configured." },
+    };
+  }
+  const [measures, issueCounts, qualityCounts] = await Promise.all([
+    fetchDuplicationMeasures(config.serverUrl, config.token, config.projectKey, ctx.signal),
+    fetchIssueSeverityCounts(config.serverUrl, config.token, config.projectKey, ctx.signal),
+    fetchIssueQualityCounts(config.serverUrl, config.token, config.projectKey, ctx.signal),
+  ]);
+  if (!measures && !issueCounts && !qualityCounts) {
+    return {
+      content: [{ type: "text", text: `Project "${config.projectKey}" has not been analyzed yet. Run /sonarqube analyze first.` }],
+      details: { error: `Project "${config.projectKey}" has not been analyzed yet. Run /sonarqube analyze first.` },
+    };
+  }
+  const text = formatMetricsOutput({ projectKey: config.projectKey, measures, issueCounts, issueQualityCounts: qualityCounts });
+  return { content: [{ type: "text", text }], details: { projectKey: config.projectKey, measures, issueCounts, issueQualityCounts: qualityCounts } };
+}
+
 // ── Re-exports for public API ───────────────────────────────────────────────
 
 export type {
@@ -527,6 +739,7 @@ export type {
   SonarProjectConfig,
   SonarIssueFetchOptions,
   SonarInitConfig,
+  IssueQualityCounts,
 } from "./types.js";
 
 export { projectConfigPath, loadProjectConfig, saveProjectConfig } from "./config.js";

package/src/types.ts

@@ -13,6 +13,44 @@ export interface SonarIssue {
   status?: string;
 }
 
+export interface SonarDuplicationMeasures {
+  duplicatedLinesDensity: number;
+  duplicatedLines: number;
+  duplicatedBlocks: number;
+  duplicatedFiles: number;
+}
+
+export interface IssueSeverityCounts {
+  blocker: number;
+  critical: number;
+  major: number;
+  minor: number;
+  info: number;
+}
+
+export interface IssueQualityCounts {
+  maintainability: number;
+  reliability: number;
+  security: number;
+}
+
+export interface FileDuplication {
+  filePath: string;
+  fileKey: string;
+  duplicatedLines: number;
+  duplicatedBlocks: number;
+}
+
+export interface DuplicationBlock {
+  from: number;
+  size: number;
+  filePath: string;
+}
+
+export interface DuplicationBlockGroup {
+  blocks: DuplicationBlock[];
+}
+
 export interface SonarAnalysisState {
   version: 1;
   analyzedAt: string;
@@ -23,8 +61,10 @@ export interface SonarAnalysisState {
   ceTaskUrl?: string;
   analysisId?: string;
   filters?: SonarIssueFetchOptions;
+  measures?: SonarDuplicationMeasures;
   totalIssues: number;
   issues: SonarIssue[];
+  cleanCodeMode?: "STANDARD" | "MQR";
 }
 
 export interface SonarProjectConfig {
@@ -40,6 +80,8 @@ export interface SonarIssueFetchOptions {
   statuses?: string[];
   types?: string[];
   rules?: string[];
+  softwareQualities?: string[];
+  impactSeverities?: string[];
 }
 
 export interface SonarInitConfig {
@@ -77,3 +119,5 @@ export interface InitCommandOptions {
 export const SONAR_SEVERITIES = ["BLOCKER", "CRITICAL", "MAJOR", "MINOR", "INFO"] as const;
 export const SONAR_STATUSES = ["OPEN", "CONFIRMED", "REOPENED", "RESOLVED", "CLOSED"] as const;
 export const SONAR_TYPES = ["BUG", "VULNERABILITY", "CODE_SMELL"] as const;
+export const SONAR_SOFTWARE_QUALITIES = ["MAINTAINABILITY", "RELIABILITY", "SECURITY"] as const;
+export const SONAR_IMPACT_SEVERITIES = ["BLOCKER", "HIGH", "MEDIUM", "LOW", "INFO"] as const;

package/src/ui.ts

@@ -2,8 +2,8 @@ import type { Theme, ExtensionContext, ExtensionCommandContext } from "@earendil
 import { Key, matchesKey, truncateToWidth } from "@earendil-works/pi-tui";
 import { readFile } from "node:fs/promises";
 import { resolve } from "node:path";
-import type { SonarIssue, SonarAnalysisState, SonarIssueFetchOptions } from "./types.js";
-import { issueFilterLabel, fetchIssues, createAnalysisState, normalizeIssueFilters } from "./api.js";
+import type { SonarIssue, SonarAnalysisState, SonarIssueFetchOptions, FileDuplication } from "./types.js";
+import { issueFilterLabel, fetchIssues, createAnalysisState, normalizeIssueFilters, fetchCleanCodeMode } from "./api.js";
 import { resolveConfig, resolveTarget } from "./config.js";
 
 // ── Issue preview ───────────────────────────────────────────────────────────
@@ -71,8 +71,6 @@ export function startAnalysisUi(ctx: ExtensionContext, projectKey: string): Anal
 
 export class IssueBrowser {
   private selected = 0;
-  private cachedWidth: number | undefined;
-  private cachedLines: string[] | undefined;
 
   constructor(
     private readonly state: SonarAnalysisState,
@@ -80,10 +78,7 @@ export class IssueBrowser {
     private readonly done: (result: number | null) => void,
   ) {}
 
-  invalidate(): void {
-    this.cachedWidth = undefined;
-    this.cachedLines = undefined;
-  }
+  invalidate(): void {} // NOSONAR - required by TUI interface
 
   handleInput(data: string): void {
     if (matchesKey(data, Key.escape) || matchesKey(data, "ctrl+c")) {
@@ -92,12 +87,10 @@ export class IssueBrowser {
     }
     if (matchesKey(data, Key.up)) {
       this.selected = Math.max(0, this.selected - 1);
-      this.invalidate();
       return;
     }
     if (matchesKey(data, Key.down)) {
       this.selected = Math.min(this.state.issues.length - 1, this.selected + 1);
-      this.invalidate();
       return;
     }
     if (matchesKey(data, Key.enter)) {
@@ -106,10 +99,6 @@ export class IssueBrowser {
   }
 
   render(width: number): string[] {
-    if (this.cachedLines && this.cachedWidth === width) {
-      return this.cachedLines;
-    }
-
     const lines: string[] = [];
     const title = this.theme.fg("accent", this.theme.bold(" SonarQube Issues "));
     const filterSuffix = this.state.filters ? ` • ${issueFilterLabel(this.state.filters)}` : "";
@@ -131,8 +120,15 @@ export class IssueBrowser {
     const visibleIssues = this.state.issues.slice(start, end);
 
     if (visibleIssues.length === 0) {
-      lines.push(truncateToWidth(this.theme.fg("success", "No open issues found."), width));
-      return finalize(lines, width, this.theme, this.cachedWidth, this.cachedLines);
+      lines.push(
+        truncateToWidth(this.theme.fg("success", "No open issues found."), width),
+        "",
+        truncateToWidth(
+          this.theme.fg("dim", "Up/Down to move, Enter to preview, Esc to close"),
+          width,
+        ),
+      );
+      return lines;
     }
 
     if (start > 0) {
@@ -173,27 +169,10 @@ export class IssueBrowser {
       ),
     );
 
-    this.cachedWidth = width;
-    this.cachedLines = lines;
     return lines;
   }
 }
 
-function finalize(
-  lines: string[],
-  width: number,
-  theme: Theme,
-  cachedWidth: number | undefined,
-  cachedLines: string[] | undefined,
-): string[] {
-  lines.push(
-    "",
-    truncateToWidth(theme.fg("dim", "Up/Down to move, Enter to preview, Esc to close"), width),
-  );
-  const result = cachedLines ?? lines;
-  return result;
-}
-
 // ── Severity colors ─────────────────────────────────────────────────────────
 
 function severityColor(theme: Theme, severity: string): string {
@@ -210,6 +189,76 @@ function severityColor(theme: Theme, severity: string): string {
   }
 }
 
+// ── Duplication browser (used by index.ts) ─────────────────────────────────
+
+export class DuplicationBrowser {
+  private selected = 0;
+
+  constructor(
+    private readonly files: FileDuplication[],
+    private readonly theme: Theme,
+    private readonly done: (result: number | null) => void,
+  ) {}
+
+  invalidate(): void {} // NOSONAR - required by TUI interface
+
+  handleInput(data: string): void {
+    if (matchesKey(data, Key.escape) || matchesKey(data, "ctrl+c")) {
+      this.done(null);
+      return;
+    }
+    if (matchesKey(data, Key.up)) {
+      this.selected = Math.max(0, this.selected - 1);
+      return;
+    }
+    if (matchesKey(data, Key.down)) {
+      this.selected = Math.min(this.files.length - 1, this.selected + 1);
+      return;
+    }
+    if (matchesKey(data, Key.enter)) {
+      this.done(this.selected);
+    }
+  }
+
+  render(width: number): string[] {
+    const lines: string[] = [
+      this.theme.fg("accent", this.theme.bold(" SonarQube Duplications ")),
+      this.theme.fg("dim", `${this.files.length} file(s) with duplicate code`),
+      "",
+    ];
+
+    const pageSize = Math.min(15, this.files.length);
+    const halfWindow = Math.floor(pageSize / 2);
+    const maxStart = Math.max(0, this.files.length - pageSize);
+    const start = Math.max(0, Math.min(this.selected - halfWindow, maxStart));
+    const end = Math.min(this.files.length, start + pageSize);
+    const visible = this.files.slice(start, end);
+
+    for (const [offset, file] of visible.entries()) {
+      const index = start + offset;
+      const isSelected = index === this.selected;
+      const marker = isSelected ? this.theme.fg("accent", ">") : this.theme.fg("dim", " ");
+      const detail = `blocks=${file.duplicatedBlocks}  lines=${file.duplicatedLines}`;
+      const line = `${marker} ${String(index + 1).padStart(2, " ")}. ${this.theme.fg("accent", file.filePath)}  ${this.theme.fg("dim", detail)}`;
+      lines.push(truncateToWidth(line, width));
+    }
+
+    lines.push(
+      "",
+      this.theme.fg("dim", "Up/Down to move, Enter for details, Esc to close"),
+    );
+    return lines;
+  }
+}
+
+export async function showDuplicationBrowser(
+  ctx: ExtensionCommandContext,
+  files: FileDuplication[],
+): Promise<number | null> {
+  if (ctx.mode !== "tui" || files.length === 0) return null;
+  return await ctx.ui.custom<number | null>((_tui, theme, _kb, done) => new DuplicationBrowser(files, theme, done));
+}
+
 // ── Issue browser / preview helpers (used by index.ts) ──────────────────────
 
 export async function showIssueBrowser(
@@ -251,7 +300,8 @@ export async function loadProjectIssuesFromApi(
     ctx.signal,
     normalizedFilters,
   );
-  return createAnalysisState(config, issues, { filters: normalizedFilters });
+  const cleanCodeMode = await fetchCleanCodeMode(config.serverUrl, config.token, ctx.signal);
+  return createAnalysisState(config, issues, { filters: normalizedFilters, cleanCodeMode });
 }
 
 export async function resolveTargetState(