opencode-sonarqube 0.2.1 → 0.2.2

package/README.md

@@ -85,36 +85,46 @@ Add these to your `~/.zshrc` or `~/.bashrc` to make them permanent.
 
 ## Configuration
 
-### Using the Configuration Script
+### Environment Variables (Required)
+
+Add these to your `~/.zshrc` or `~/.bashrc`:
 
 ```bash
-./scripts/configure.sh
+export SONAR_HOST_URL="https://your-sonarqube-server.com"
+export SONAR_USER="admin"
+export SONAR_PASSWORD="your-password"
 ```
 
-This interactive script allows you to:
-- Update SonarQube URL
-- Change credentials
-- Test connection
-- Reset project state
-
-### Environment Variables (Required)
-
-| Variable | Description |
-|----------|-------------|
-| `SONAR_HOST_URL` | SonarQube server URL (e.g., `https://sonarqube.example.com`) |
-| `SONAR_USER` | Username for authentication |
-| `SONAR_PASSWORD` | Password for authentication |
+### Plugin Configuration (Optional)
 
-### Default Behavior
+Create `.sonarqube/config.json` in your project root:
 
-The plugin uses these defaults (configurable in future versions):
+```json
+{
+  "level": "enterprise",
+  "autoAnalyze": true,
+  "autoFix": false,
+  "sources": "src",
+  "tests": "tests",
+  "exclusions": "**/node_modules/**,**/dist/**",
+  "newCodeDefinition": "previous_version"
+}
+```
 
-| Setting | Default | Description |
-|---------|---------|-------------|
-| Level | `enterprise` | Strictest quality requirements |
-| Auto-Analyze | `true` | Analyze when AI becomes idle |
-| Auto-Fix | `false` | Don't auto-fix issues |
-| Sources | `src` | Source directory |
+### All Configuration Options
+
+| Option | Type | Default | Description |
+|--------|------|---------|-------------|
+| `level` | `"enterprise"` \| `"standard"` \| `"relaxed"` \| `"off"` | `"enterprise"` | Analysis strictness level |
+| `autoAnalyze` | `boolean` | `true` | Auto-analyze when AI becomes idle |
+| `autoFix` | `boolean` | `false` | Automatically attempt to fix issues |
+| `projectKey` | `string` | auto | SonarQube project key (auto-generated from package.json or directory) |
+| `projectName` | `string` | auto | Display name on SonarQube |
+| `qualityGate` | `string` | `"Sonar way"` | Quality gate to use |
+| `newCodeDefinition` | `"previous_version"` \| `"number_of_days"` \| `"reference_branch"` \| `"specific_analysis"` | `"previous_version"` | How to define 'new code' |
+| `sources` | `string` | `"src"` | Source directories (comma-separated) |
+| `tests` | `string` | - | Test directories (comma-separated) |
+| `exclusions` | `string` | - | File exclusion patterns (glob) |
 
 ### Strictness Levels
 
@@ -125,6 +135,34 @@ The plugin uses these defaults (configurable in future versions):
 | `relaxed` | Only blocker/critical, blocks on blocker |
 | `off` | Plugin disabled |
 
+### Example Configurations
+
+**Enterprise (strictest)**:
+```json
+{
+  "level": "enterprise",
+  "autoAnalyze": true,
+  "autoFix": false
+}
+```
+
+**Standard (balanced)**:
+```json
+{
+  "level": "standard",
+  "autoAnalyze": true,
+  "sources": "src,lib"
+}
+```
+
+**Relaxed (lenient)**:
+```json
+{
+  "level": "relaxed",
+  "autoAnalyze": false
+}
+```
+
 ## Tool Actions (15 total)
 
 The plugin adds a `sonarqube` tool with these actions:
@@ -296,51 +334,23 @@ bun run src/index.ts --status --project-key=my-project
 bun run src/index.ts --setup --force
 ```
 
-## Programmatic API
+## Project State
 
-```typescript
-import { 
-  createSonarQubeAPI, 
-  loadConfig, 
-  getProjectState,
-  runAnalysis,
-  bootstrap 
-} from "opencode-sonarqube";
-
-// Create API client
-const config = loadConfig();
-const state = await getProjectState("./");
-const api = createSonarQubeAPI(config, state);
-
-// Health check
-const health = await api.healthCheck();
-console.log("Healthy:", health.healthy);
-
-// Get issues
-const issues = await api.issues.getFormattedIssues({
-  projectKey: "my-project",
-  severities: ["BLOCKER", "CRITICAL"],
-});
-
-// Get quality gate status
-const status = await api.qualityGate.getStatus("my-project");
-console.log("Status:", status.projectStatus.status);
-
-// Get new code issues only
-const newIssues = await api.issues.search({
-  projectKey: "my-project",
-  inNewCode: true,
-});
-
-// Get worst files for refactoring
-const worstFiles = await api.components.getWorstFiles("my-project", 10);
-
-// Run full analysis
-const result = await runAnalysis(config, state, { projectKey: "my-project" }, "./");
-console.log("Quality Gate:", result.qualityGateStatus);
+The plugin stores project state in `.sonarqube/project.json`:
+
+```json
+{
+  "projectKey": "my-project",
+  "projectToken": "sqp_xxx...",
+  "tokenName": "opencode-my-project-...",
+  "initializedAt": "2024-01-01T00:00:00.000Z",
+  "languages": ["typescript", "javascript"],
+  "qualityGate": "Sonar way",
+  "setupComplete": true
+}
 ```
 
-See [API Documentation](./docs/API.md) for complete reference.
+**Important:** Add `.sonarqube/` to your `.gitignore` - it contains authentication tokens!
 
 ## Documentation
 
@@ -383,16 +393,16 @@ This project maintains enterprise-level quality:
 
 | Metric | Value |
 |--------|-------|
-| Test Coverage | 100% |
+| Test Coverage | 87.9% |
 | Tests | 626 |
 | Bugs | 0 |
 | Vulnerabilities | 0 |
 | Code Smells | 0 |
 | Duplications | 0% |
-| Quality Gate | Passed |
 | Reliability Rating | A |
 | Security Rating | A |
 | Maintainability Rating | A |
+| Lines of Code | ~6,000 |
 
 ## License
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "opencode-sonarqube",
-  "version": "0.2.1",
+  "version": "0.2.2",
   "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.1",
+    "opencode-sonarqube": "0.2.2",
     "zod": "^3.24.0"
   },
   "devDependencies": {