@jonathan0823/pi-sonarqube 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Jonathan0823
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,180 @@
+# @jonathan0823/pi-sonarqube
+
+A Pi extension to run local SonarQube analysis and browse the resulting issues — all from within Pi.
+
+## Requirements
+
+- [Pi](https://github.com/earendil-works/pi-coding-agent) installed
+- A running SonarQube server (e.g. `http://localhost:9000`)
+- `sonar-scanner` available in `$PATH`
+
+## Install
+
+```bash
+pi install npm:@jonathan0823/pi-sonarqube
+```
+
+Or add it to your `settings.json`:
+
+```json
+{
+  "packages": ["npm:@jonathan0823/pi-sonarqube"]
+}
+```
+
+Then `/reload` in Pi.
+
+## Quick start
+
+### 1. Init project config
+
+Inside a project directory, run:
+
+```
+/sonarqube init
+```
+
+For monorepos, you can add a user-defined alias and optional path:
+
+```
+/sonarqube init fe apps/web
+/sonarqube init be apps/api
+```
+
+Pi will ask you for:
+- **SonarQube server URL** (prefilled with `http://localhost:9000`)
+- **Project key** (default: derived from directory name)
+- **Token** (optional, used when your server requires auth)
+
+The config is saved to `<project>/.pi/sonarqube.json`. Alias mappings live in the repo root `.pi/sonarqube.workspaces.json`.
+
+### 2. Run analysis
+
+```
+/sonarqube analyze
+/sonarqube analyze fe
+/sonarqube analyze apps/web
+```
+
+Pi will:
+1. Run `sonar-scanner` against your server
+2. Wait for the analysis to complete
+3. Fetch the latest issues
+4. Return a concise summary
+
+### 3. Browse issues
+
+```
+/sonarqube issues
+/sonarqube issues fe
+```
+
+Use **Up/Down** to move, **Enter** to preview the affected source code, and **Esc** to close.
+
+### 4. Open a specific issue
+
+```
+/sonarqube open 3
+/sonarqube open fe 3
+```
+
+## Commands
+
+| Command | Description |
+|---------|-------------|
+| `/sonarqube init [alias] [path]` | Set up project config and optional alias |
+| `/sonarqube analyze [target]` | Run analysis for an alias or path |
+| `/sonarqube issues [target]` | Browse the latest analysis results for a target |
+| `/sonarqube open [target] <n>` | Preview source at issue #n |
+
+## Tool (for the LLM)
+
+The extension also registers a `sonarqube` tool that the LLM can call with actions:
+- `analyze` — run analysis
+- `issues` — list issues
+- `open` — open an issue with its index
+
+Targets can be an alias like `fe` or a path like `apps/web`.
+
+## Configuration sources (precedence order)
+
+1. **Environment variables** (highest)
+   - `SONARQUBE_URL` / `SONAR_HOST_URL`
+   - `SONARQUBE_TOKEN` / `SONAR_TOKEN`
+   - `SONAR_PROJECT_KEY`
+2. **Project config** — `.pi/sonarqube.json` (set via `/sonarqube init`)
+3. **Scan properties** — `sonar-project.properties`
+4. **Defaults** — `http://localhost:9000`, project key from directory slug
+
+## Publishing
+
+### Prerequisites
+
+- An [npm](https://www.npmjs.com/) account
+- The npm scope `@jonathan0823` assigned to your npm user
+
+### Publish
+
+```bash
+cd packages/pi-sonarqube
+
+# Login if needed
+npm login
+
+# Publish (builds automatically via prepack)
+npm publish
+```
+
+### Publish a new version
+
+```bash
+# Update version in package.json
+npm version patch  # or minor / major
+
+# Publish
+npm publish
+```
+
+### Test locally before publishing
+
+```bash
+cd packages/pi-sonarqube
+
+# Create a tarball
+npm pack
+
+# Install it in a test project
+cd /tmp/test-project
+npm install /path/to/pi-sonarqube-0.1.0.tgz
+```
+
+## Manual via `pi install`
+
+You can also install directly from a local path:
+
+```bash
+pi install /path/to/packages/pi-sonarqube
+```
+
+## Project structure
+
+```
+packages/pi-sonarqube/
+├── src/
+│   └── index.ts          # Extension source + init command + config
+├── dist/
+│   ├── index.js          # Compiled output
+│   ├── index.d.ts        # Type declarations
+│   └── index.js.map      # Source map
+├── fixtures/
+│   ├── issue-project/    # Test project with known issues
+│   └── clean-project/    # Test project with no issues
+├── README.md
+├── LICENSE
+├── package.json
+└── tsconfig.json
+```
+
+## License
+
+MIT

package/dist/index.d.ts

@@ -0,0 +1,50 @@
+import type { ExtensionAPI } from "@earendil-works/pi-coding-agent";
+export type SonarAction = "analyze" | "issues" | "open" | "init";
+export interface SonarIssue {
+    key: string;
+    rule: string;
+    ruleName?: string;
+    severity: string;
+    message: string;
+    filePath: string;
+    line: number | null;
+    status?: string;
+}
+export interface SonarAnalysisState {
+    version: 1;
+    analyzedAt: string;
+    baseDir: string;
+    serverUrl: string;
+    projectKey: string;
+    dashboardUrl?: string;
+    ceTaskUrl?: string;
+    analysisId?: string;
+    totalIssues: number;
+    issues: SonarIssue[];
+}
+export interface SonarProjectConfig {
+    baseDir: string;
+    serverUrl: string;
+    projectKey: string;
+    token?: string;
+    hasProperties: boolean;
+}
+export interface SonarInitConfig {
+    serverUrl: string;
+    projectKey: string;
+    token?: string;
+}
+declare function projectConfigPath(baseDir: string): string;
+declare function sonarqubeConfigDir(baseDir: string): string;
+/**
+ * Load project-local config from `.pi/sonarqube.json`.
+ * Returns undefined when the file doesn't exist or is invalid.
+ */
+declare function loadProjectConfig(baseDir: string): Promise<SonarInitConfig | undefined>;
+/**
+ * Save project-local config to `.pi/sonarqube.json`.
+ */
+declare function saveProjectConfig(baseDir: string, config: SonarInitConfig): Promise<void>;
+export { projectConfigPath, loadProjectConfig, saveProjectConfig, sonarqubeConfigDir };
+export default function sonarqube(pi: ExtensionAPI): void;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EACV,YAAY,EAIb,MAAM,iCAAiC,CAAC;AASzC,MAAM,MAAM,WAAW,GAAG,SAAS,GAAG,QAAQ,GAAG,MAAM,GAAG,MAAM,CAAC;AAEjE,MAAM,WAAW,UAAU;IACzB,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,kBAAkB;IACjC,OAAO,EAAE,CAAC,CAAC;IACX,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC;IACpB,MAAM,EAAE,UAAU,EAAE,CAAC;CACtB;AAED,MAAM,WAAW,kBAAkB;IACjC,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,aAAa,EAAE,OAAO,CAAC;CACxB;AAED,MAAM,WAAW,eAAe;IAC9B,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AA4ED,iBAAS,iBAAiB,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,CAElD;AAED,iBAAS,kBAAkB,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,CAEnD;AAED;;;GAGG;AACH,iBAAe,iBAAiB,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,GAAG,SAAS,CAAC,CAEtF;AAED;;GAEG;AACH,iBAAe,iBAAiB,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,eAAe,GAAG,OAAO,CAAC,IAAI,CAAC,CAIxF;AAsHD,OAAO,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,CAAC;AAgrBvF,MAAM,CAAC,OAAO,UAAU,SAAS,CAAC,EAAE,EAAE,YAAY,QA0MjD"}