opencode-sonarqube 0.2.10 → 0.3.0

package/README.md

@@ -381,6 +381,80 @@ The plugin provides 12 API modules for SonarQube interaction:
 | `MetricsAPI` | Get detailed metrics with period comparison |
 | `ComponentsAPI` | Get files/directories with issue counts |
 
+## First Time Setup
+
+When you use the plugin in a new project for the first time, you need to initialize it:
+
+### Option 1: Let the AI do it
+Simply tell the AI: "Set up SonarQube for this project" or "Initialize SonarQube"
+
+### Option 2: Use the tool directly
+```typescript
+sonarqube({ action: "setup" })
+```
+
+This will:
+1. Create a new project on your SonarQube server
+2. Generate an authentication token
+3. Create `.sonarqube/project.json` with the project configuration
+4. Add `.sonarqube/` to your `.gitignore`
+
+**Note:** The `.sonarqube/` directory contains sensitive tokens - never commit it!
+
+## FAQ
+
+### Where is the configuration stored?
+
+| What | Location |
+|------|----------|
+| **Server credentials** | Environment variables (`SONAR_HOST_URL`, `SONAR_USER`, `SONAR_PASSWORD`) |
+| **Plugin settings** | `.sonarqube/config.json` in your project (optional) |
+| **Project state/tokens** | `.sonarqube/project.json` (auto-generated, don't commit!) |
+| **OpenCode plugin list** | `opencode.json` |
+
+### How do I enable debug logging?
+
+Set the environment variable before starting OpenCode:
+```bash
+export SONARQUBE_DEBUG=true
+```
+
+Logs are written to `/tmp/sonarqube-plugin-debug.log`
+
+### The plugin uses the wrong project directory
+
+This can happen when multiple projects are open in OpenCode Desktop. The plugin uses `import.meta.url` to determine which project's `node_modules` it was loaded from. Make sure each project has its own installation:
+
+```bash
+cd /path/to/your/project
+bun add opencode-sonarqube
+```
+
+### The quality gate shows issues but I just started
+
+Run the setup first:
+```typescript
+sonarqube({ action: "setup" })
+```
+
+Then run an analysis:
+```typescript
+sonarqube({ action: "analyze" })
+```
+
+### How do I use this with multiple SonarQube servers?
+
+Currently, the plugin uses global environment variables. For different servers per project, you'd need to set the environment variables differently per terminal session.
+
+### Can I use this without OpenCode?
+
+Yes! Use the CLI:
+```bash
+bun run src/index.ts --setup
+bun run src/index.ts --analyze
+bun run src/index.ts --status
+```
+
 ## Requirements
 
 - SonarQube server 9.9+ (tested with 26.1)

package/dist/index.js

@@ -4212,29 +4212,38 @@ ${entry}
   await Bun.write(gitignorePath, newContent);
   logger4.info("Added SonarQube exclusion to .gitignore");
 }
-var LOG_FILE2 = "/tmp/sonarqube-plugin-debug.log", logger4, STATE_DIR = ".sonarqube", STATE_FILE = "project.json";
+var DEBUG2, LOG_FILE2 = "/tmp/sonarqube-plugin-debug.log", logger4, STATE_DIR = ".sonarqube", STATE_FILE = "project.json";
 var init_state = __esm(() => {
   init_types2();
+  DEBUG2 = process.env["SONARQUBE_DEBUG"] === "true";
   logger4 = {
     info: (msg, extra) => {
+      if (!DEBUG2)
+        return;
       try {
         appendFileSync2(LOG_FILE2, `${new Date().toISOString()} [STATE] ${msg} ${extra ? JSON.stringify(extra) : ""}
 `);
       } catch {}
     },
     warn: (msg, extra) => {
+      if (!DEBUG2)
+        return;
       try {
         appendFileSync2(LOG_FILE2, `${new Date().toISOString()} [STATE-WARN] ${msg} ${extra ? JSON.stringify(extra) : ""}
 `);
       } catch {}
     },
     error: (msg, extra) => {
+      if (!DEBUG2)
+        return;
       try {
         appendFileSync2(LOG_FILE2, `${new Date().toISOString()} [STATE-ERROR] ${msg} ${extra ? JSON.stringify(extra) : ""}
 `);
       } catch {}
     },
     debug: (msg, extra) => {
+      if (!DEBUG2)
+        return;
       try {
         appendFileSync2(LOG_FILE2, `${new Date().toISOString()} [STATE-DEBUG] ${msg} ${extra ? JSON.stringify(extra) : ""}
 `);
@@ -16566,21 +16575,28 @@ tool.schema = exports_external;
 // src/utils/config.ts
 init_types2();
 import { appendFileSync } from "node:fs";
+var DEBUG = process.env["SONARQUBE_DEBUG"] === "true";
 var LOG_FILE = "/tmp/sonarqube-plugin-debug.log";
 var configLogger = {
   info: (msg, extra) => {
+    if (!DEBUG)
+      return;
     try {
       appendFileSync(LOG_FILE, `${new Date().toISOString()} [CONFIG] ${msg} ${extra ? JSON.stringify(extra) : ""}
 `);
     } catch {}
   },
   warn: (msg, extra) => {
+    if (!DEBUG)
+      return;
     try {
       appendFileSync(LOG_FILE, `${new Date().toISOString()} [CONFIG-WARN] ${msg} ${extra ? JSON.stringify(extra) : ""}
 `);
     } catch {}
   },
   error: (msg, extra) => {
+    if (!DEBUG)
+      return;
     try {
       appendFileSync(LOG_FILE, `${new Date().toISOString()} [CONFIG-ERROR] ${msg} ${extra ? JSON.stringify(extra) : ""}
 `);
@@ -17106,11 +17122,13 @@ class SonarQubeClient {
     if (requestBody) {
       headers["Content-Type"] = "application/x-www-form-urlencoded";
     }
-    try {
-      const { appendFileSync: appendFileSync2 } = await import("node:fs");
-      appendFileSync2("/tmp/sonarqube-plugin-debug.log", `${new Date().toISOString()} [API] >>> ${method} ${endpoint} ${JSON.stringify({ url: url2, params, hasBody: !!body, bodyKeys: body ? Object.keys(body) : [] })}
+    if (process.env["SONARQUBE_DEBUG"] === "true") {
+      try {
+        const { appendFileSync: appendFileSync2 } = await import("node:fs");
+        appendFileSync2("/tmp/sonarqube-plugin-debug.log", `${new Date().toISOString()} [API] >>> ${method} ${endpoint} ${JSON.stringify({ url: url2, params, hasBody: !!body, bodyKeys: body ? Object.keys(body) : [] })}
 `);
-    } catch {}
+      } catch {}
+    }
     try {
       const response = await fetch(url2, {
         method,
@@ -19403,12 +19421,14 @@ function formatActionPrompt(result, config2) {
 }
 function createIdleHook(getConfig, getDirectory) {
   return async function handleSessionIdle() {
-    try {
-      const { appendFileSync: appendFileSync4 } = await import("node:fs");
-      const dir = getDirectory();
-      appendFileSync4("/tmp/sonarqube-plugin-debug.log", `${new Date().toISOString()} [IDLE-HOOK] getDirectory()=${dir}
+    if (process.env["SONARQUBE_DEBUG"] === "true") {
+      try {
+        const { appendFileSync: appendFileSync4 } = await import("node:fs");
+        const dir = getDirectory();
+        appendFileSync4("/tmp/sonarqube-plugin-debug.log", `${new Date().toISOString()} [IDLE-HOOK] getDirectory()=${dir}
 `);
-    } catch {}
+      } catch {}
+    }
     const rawConfig = getConfig()?.["sonarqube"];
     const config2 = loadConfig(rawConfig);
     if (!isAnalysisEnabled(config2)) {
@@ -20094,15 +20114,21 @@ function getSeveritiesFromLevel(level) {
 
 // src/index.ts
 import { appendFileSync as appendFileSync4 } from "node:fs";
-try {
-  const moduleLoadId = Math.random().toString(36).substring(7);
-  appendFileSync4("/tmp/sonarqube-plugin-debug.log", `${new Date().toISOString()} [LOAD] Module loaded! id=${moduleLoadId} cwd=${process.cwd()} import.meta.url=${import.meta.url}
+var DEBUG3 = process.env["SONARQUBE_DEBUG"] === "true";
+var LOG_FILE4 = "/tmp/sonarqube-plugin-debug.log";
+if (DEBUG3) {
+  try {
+    const moduleLoadId = Math.random().toString(36).substring(7);
+    appendFileSync4(LOG_FILE4, `${new Date().toISOString()} [LOAD] Module loaded! id=${moduleLoadId} cwd=${process.cwd()} import.meta.url=${import.meta.url}
 `);
-} catch {}
+  } catch {}
+}
 var SHARED_STATE_FILE = "/tmp/sonarqube-plugin-shared-state.json";
 var globalSafeLog = (msg) => {
+  if (!DEBUG3)
+    return;
   try {
-    appendFileSync4("/tmp/sonarqube-plugin-debug.log", `${new Date().toISOString()} [GLOBAL] ${msg}
+    appendFileSync4(LOG_FILE4, `${new Date().toISOString()} [GLOBAL] ${msg}
 `);
   } catch {}
 };
@@ -20157,8 +20183,10 @@ function shouldIgnoreFile2(filePath) {
 }
 var SonarQubePlugin = async ({ client, directory, worktree }) => {
   const safeLog = (msg) => {
+    if (!DEBUG3)
+      return;
     try {
-      appendFileSync4("/tmp/sonarqube-plugin-debug.log", `${new Date().toISOString()} [PLUGIN] ${msg}
+      appendFileSync4(LOG_FILE4, `${new Date().toISOString()} [PLUGIN] ${msg}
 `);
     } catch {}
   };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "opencode-sonarqube",
-  "version": "0.2.10",
+  "version": "0.3.0",
   "description": "OpenCode Plugin for SonarQube integration - Enterprise-level code quality from the start",
   "type": "module",
   "main": "dist/index.js",
@@ -38,7 +38,7 @@
   "homepage": "https://github.com/mguttmann/opencode-sonarqube#readme",
   "dependencies": {
     "@opencode-ai/plugin": "^1.1.34",
-    "opencode-sonarqube": "0.2.9",
+    "opencode-sonarqube": "0.2.10",
     "zod": "^3.24.0"
   },
   "devDependencies": {