sonar-autofix 0.0.5

package/.idea/workspace.xml

@@ -0,0 +1,191 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="AutoImportSettings">
+    <option name="autoReloadType" value="SELECTIVE" />
+  </component>
+  <component name="ChangeListManager">
+    <list default="true" id="2b435513-27c8-4fc6-b596-5368f46599ce" name="Changes" comment="package publishing changes">
+      <change beforePath="$PROJECT_DIR$/packages/cli/index.js" beforeDir="false" afterPath="$PROJECT_DIR$/packages/cli/index.js" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/packages/cli/package.json" beforeDir="false" afterPath="$PROJECT_DIR$/packages/cli/package.json" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/packages/core/index.js" beforeDir="false" afterPath="$PROJECT_DIR$/packages/core/index.js" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/packages/core/package.json" beforeDir="false" afterPath="$PROJECT_DIR$/packages/core/package.json" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/packages/git-client/package.json" beforeDir="false" afterPath="$PROJECT_DIR$/packages/git-client/package.json" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/packages/github-action/action.yml" beforeDir="false" afterPath="$PROJECT_DIR$/packages/github-action/action.yml" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/packages/github-action/index.js" beforeDir="false" afterPath="$PROJECT_DIR$/packages/github-action/index.js" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/packages/github-action/package.json" beforeDir="false" afterPath="$PROJECT_DIR$/packages/github-action/package.json" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/packages/llm-client/package.json" beforeDir="false" afterPath="$PROJECT_DIR$/packages/llm-client/package.json" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/packages/sonar-client/package.json" beforeDir="false" afterPath="$PROJECT_DIR$/packages/sonar-client/package.json" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/packages/validator/package.json" beforeDir="false" afterPath="$PROJECT_DIR$/packages/validator/package.json" afterDir="false" />
+    </list>
+    <option name="SHOW_DIALOG" value="false" />
+    <option name="HIGHLIGHT_CONFLICTS" value="true" />
+    <option name="HIGHLIGHT_NON_ACTIVE_CHANGELIST" value="false" />
+    <option name="LAST_RESOLUTION" value="IGNORE" />
+  </component>
+  <component name="EmbeddingIndexingInfo">
+    <option name="fileBasedEmbeddingIndicesEnabled" value="true" />
+  </component>
+  <component name="Git.Settings">
+    <option name="RECENT_GIT_ROOT_PATH" value="$PROJECT_DIR$" />
+  </component>
+  <component name="GithubDefaultAccount">
+    <option name="defaultAccountId" value="6dade5ab-73e2-43de-8589-5680489ff109" />
+  </component>
+  <component name="McpProjectServerCommands">
+    <commands />
+    <urls />
+  </component>
+  <component name="NextEditCompletionFeaturesState">
+    <decayedCancelled>
+      <entry key="MS100" value="1.6744833171325262" />
+      <entry key="MS500" value="2.58172093612023" />
+      <entry key="S2" value="2.8844669777281875" />
+      <entry key="S5" value="2.952829092826303" />
+      <entry key="S10" value="2.9775799052902783" />
+      <entry key="S30" value="3.2207563904736163" />
+      <entry key="S60" value="4.125034379367315" />
+      <entry key="M2" value="6.484005379877605" />
+      <entry key="M5" value="16.623270843638018" />
+      <entry key="M10" value="29.496886119445264" />
+      <entry key="M15" value="38.53321653752027" />
+      <entry key="M30" value="70.6509361650961" />
+      <entry key="H1" value="145.50802139516395" />
+      <entry key="H2" value="245.85094452197504" />
+      <entry key="H4" value="356.03484955949796" />
+      <entry key="D1" value="698.1026936159626" />
+      <entry key="W1" value="847.6316849660216" />
+    </decayedCancelled>
+    <decayedSelected>
+      <entry key="MS100" value="0.0" />
+      <entry key="MS500" value="0.0" />
+      <entry key="S2" value="8.004104522733288E-98" />
+      <entry key="S5" value="1.7659974950749445E-39" />
+      <entry key="S10" value="5.606983364968166E-20" />
+      <entry key="S30" value="6.007864112985362E-7" />
+      <entry key="S60" value="0.0011366291571186739" />
+      <entry key="M2" value="0.053374018625082606" />
+      <entry key="M5" value="0.5796786411829966" />
+      <entry key="M10" value="1.3138956828306059" />
+      <entry key="M15" value="1.7608935390999911" />
+      <entry key="M30" value="2.67969488017297" />
+      <entry key="H1" value="4.088046159387631" />
+      <entry key="H2" value="5.749963416540233" />
+      <entry key="H4" value="7.4206497976591725" />
+      <entry key="D1" value="11.833666975867306" />
+      <entry key="W1" value="13.637653890653624" />
+    </decayedSelected>
+    <decayedShown>
+      <entry key="MS100" value="1.5755714284839712" />
+      <entry key="MS500" value="2.55267875896726" />
+      <entry key="S2" value="2.8764410362323525" />
+      <entry key="S5" value="2.9495496407514823" />
+      <entry key="S10" value="2.975927565551862" />
+      <entry key="S30" value="3.220162936681101" />
+      <entry key="S60" value="4.1257516017012605" />
+      <entry key="M2" value="6.5362002384950975" />
+      <entry key="M5" value="17.19949398327749" />
+      <entry key="M10" value="30.807204946579795" />
+      <entry key="M15" value="40.29098126195295" />
+      <entry key="M30" value="73.32822699520365" />
+      <entry key="H1" value="149.59415118159862" />
+      <entry key="H2" value="251.59949415755062" />
+      <entry key="H4" value="363.45450004438277" />
+      <entry key="D1" value="709.9360002138405" />
+      <entry key="W1" value="861.2692745399029" />
+    </decayedShown>
+  </component>
+  <component name="ProjectColorInfo">{
+  &quot;associatedIndex&quot;: 0,
+  &quot;fromUser&quot;: false
+}</component>
+  <component name="ProjectId" id="3HYLMP5y2Kv5j83bVaucxd9Nu7S" />
+  <component name="ProjectViewState">
+    <option name="hideEmptyMiddlePackages" value="true" />
+    <option name="showLibraryContents" value="true" />
+  </component>
+  <component name="PropertiesComponent"><![CDATA[{
+  "keyToString": {
+    "ModuleVcsDetector.initialDetectionPerformed": "true",
+    "RunOnceActivity.MCP Project settings loaded": "true",
+    "RunOnceActivity.ShowReadmeOnStart": "true",
+    "RunOnceActivity.git.unshallow": "true",
+    "RunOnceActivity.typescript.service.memoryLimit.init": "true",
+    "SONARLINT_PRECOMMIT_ANALYSIS": "true",
+    "codeWithMe.voiceChat.enabledByDefault": "false",
+    "com.intellij.ml.llm.matterhorn.ej.ui.settings.DefaultModelSelectionForGA.v1": "true",
+    "git-widget-placeholder": "master",
+    "javascript.nodejs.core.library.configured.version": "24.18.0",
+    "javascript.nodejs.core.library.typings.version": "24.13.3",
+    "javascript.preferred.runtime.type.id": "node",
+    "junie.onboarding.icon.badge.shown": "true",
+    "last_opened_file_path": "/Users/divyaaditya/projects/sonar-autofix",
+    "node.js.detected.package.eslint": "true",
+    "node.js.detected.package.jshint": "true",
+    "node.js.detected.package.tslint": "true",
+    "node.js.selected.package.eslint": "(autodetect)",
+    "node.js.selected.package.jshint": "",
+    "node.js.selected.package.tslint": "(autodetect)",
+    "nodejs_interpreter_path": "node",
+    "nodejs_package_manager_path": "npm",
+    "settings.editor.selected.configurable": "project.propVCSSupport.DirectoryMappings",
+    "to.speed.mode.migration.done": "true",
+    "ts.external.directory.path": "/Applications/WebStorm.app/Contents/plugins/javascript-plugin/jsLanguageServicesImpl/external"
+  }
+}]]></component>
+  <component name="RecentsManager">
+    <key name="CopyFile.RECENT_KEYS">
+      <recent name="$PROJECT_DIR$" />
+    </key>
+  </component>
+  <component name="SharedIndexes">
+    <attachedChunks>
+      <set>
+        <option value="bundled-js-predefined-d6986cc7102b-4abd2a77f808-JavaScript-WS-262.9437.145" />
+      </set>
+    </attachedChunks>
+  </component>
+  <component name="TaskManager">
+    <task active="true" id="Default" summary="Default task">
+      <changelist id="2b435513-27c8-4fc6-b596-5368f46599ce" name="Changes" comment="" />
+      <created>1786040006836</created>
+      <option name="number" value="Default" />
+      <option name="presentableId" value="Default" />
+      <updated>1786040006836</updated>
+      <workItem from="1786040007924" duration="6453000" />
+      <workItem from="1786046840005" duration="601000" />
+      <workItem from="1786830049128" duration="109000" />
+      <workItem from="1786830198912" duration="598000" />
+      <workItem from="1787769103566" duration="9226000" />
+      <workItem from="1787817536391" duration="61000" />
+      <workItem from="1787859060707" duration="1282000" />
+      <workItem from="1787860367363" duration="674000" />
+      <workItem from="1788016099431" duration="1199000" />
+      <workItem from="1788165341480" duration="4495000" />
+      <workItem from="1788169983174" duration="1684000" />
+      <workItem from="1788171725187" duration="4774000" />
+      <workItem from="1788177896634" duration="4501000" />
+      <workItem from="1788182750659" duration="236000" />
+    </task>
+    <task id="LOCAL-00001" summary="package publishing changes">
+      <option name="closed" value="true" />
+      <created>1788181949023</created>
+      <option name="number" value="00001" />
+      <option name="presentableId" value="LOCAL-00001" />
+      <option name="project" value="LOCAL" />
+      <updated>1788181949023</updated>
+    </task>
+    <option name="localTasksCounter" value="2" />
+    <servers />
+  </component>
+  <component name="TypeScriptGeneratedFilesManager">
+    <option name="version" value="3" />
+  </component>
+  <component name="VcsManagerConfiguration">
+    <option name="CHECK_CODE_SMELLS_BEFORE_PROJECT_COMMIT" value="false" />
+    <ignored-roots>
+      <path value="$PROJECT_DIR$" />
+    </ignored-roots>
+    <MESSAGE value="package publishing changes" />
+    <option name="LAST_COMMIT_MESSAGE" value="package publishing changes" />
+  </component>
+</project>

package/PUBLISHING_INSTRUCTIONS.md

@@ -0,0 +1,136 @@
+# Publishing Instructions for sonar-autofix Monorepo
+
+This document outlines how to publish all packages in this monorepo to npm.
+
+## Overview
+The project is a monorepo containing 7 packages under the `@sonar-autofix` scope:
+1. @sonar-autofix/cli
+2. @sonar-autofix/core  
+3. @sonar-autofix/git-client
+4. @sonar-autofix/github-action
+5. @sonar-autofix/llm-client
+6. @sonar-autofix/sonar-client
+7. @sonar-autofix/validator
+
+## Prerequisites
+1. You must have npm account with publish permissions
+2. You need to be logged into npm: `npm login`
+3. All packages must have unique versions (they currently all have version 0.0.1)
+
+## Publishing Steps
+
+### Option 1: Manual Publishing (Simplest)
+```bash
+# Navigate to each package and publish individually
+cd packages/cli && npm publish
+cd ../core && npm publish
+cd ../git-client && npm publish
+cd ../github-action && npm publish
+cd ../llm-client && npm publish
+cd ../sonar-client && npm publish
+cd ../validator && npm publish
+```
+
+### Option 2: Using Changesets (Recommended for Version Management)
+1. Install changesets:
+```bash
+npm install @changesets/cli --save-dev
+```
+
+2. Initialize changesets:
+```bash
+npx changeset init
+```
+
+3. Create a changeset for each package:
+```bash
+npx changeset add
+```
+
+4. Generate version updates and publish:
+```bash
+npx changeset version
+npm publish
+```
+
+### Option 3: Using Lerna (Alternative)
+1. Install lerna:
+```bash
+npm install lerna --save-dev
+```
+
+2. Configure lerna in root package.json:
+```json
+{
+  "name": "sonar-autofix",
+  "version": "0.0.1",
+  "lerna": {
+    "packages": [
+      "packages/*"
+    ],
+    "version": "independent"
+  }
+}
+```
+
+3. Publish packages:
+```bash
+npx lerna publish --scope @sonar-autofix/*
+```
+
+## Package Structure
+Each package contains:
+- `index.js` - Main implementation file
+- `package.json` - Package configuration (already properly set up)
+- Some packages also contain additional files:
+  - `github-action` contains `action.yml`
+  - All packages have proper main entry points
+
+## Configuration Notes
+1. All package.json files already correctly specify:
+   - Scoped names: `@sonar-autofix/*`
+   - Proper main entry points
+   - Version numbers (currently 0.0.1 for all)
+
+2. The root package.json includes:
+   - `workspaces` configuration
+   - Dependencies
+
+3. Files to ensure are included in published packages:
+   - All JavaScript files (index.js)
+   - action.yml (for github-action package)
+   - All necessary source code files
+
+## Publishing Considerations
+1. **Version Management**: All packages currently have version 0.0.1 - you should update these to appropriate versions
+2. **Scope**: All packages are correctly scoped under `@sonar-autofix`
+3. **Dependencies**: Packages depend on each other (e.g., CLI depends on core, which depends on other packages)
+4. **Publish Access**: Make sure you have permissions to publish to the `@sonar-autofix` scope
+
+## Troubleshooting
+1. If publishing fails due to version conflicts:
+   - Update version numbers in each package.json
+   - Ensure versions are unique and follow semantic versioning
+
+2. If files appear to be missing:
+   - Check .npmignore files in each package directory
+   - Ensure no files are being excluded
+
+3. If you get 404 errors:
+   - Make sure you're using the correct scope name
+   - Verify that your npm account has proper permissions
+
+## Best Practices
+1. Use semantic versioning (v0.1.0, v0.2.0, etc.)
+2. Consider using changesets or lerna for consistent versioning across packages
+3. Document breaking changes in changelogs
+4. Test package installations in clean environments before publishing
+
+## Testing After Publishing
+After publishing, test installation:
+```bash
+# In a new project
+npm install @sonar-autofix/cli
+```
+
+Check that all expected files and functionality are present.

package/README.md

@@ -0,0 +1,86 @@
+# sonar-autofix
+
+This is a monorepo for the GitHub Sonar Autofix project, which automatically fixes code issues found by SonarQube/SonarCloud using LLMs.
+
+## Project Structure
+
+```text
+sonar-autofix/
+├── packages/
+│   ├── core/
+│   ├── github-action/
+│   ├── cli/
+│   ├── sonar-client/
+│   ├── llm-client/
+│   ├── git-client/
+│   └── validator/
+├── prompts/
+├── examples/
+├── docs/
+├── tests/
+└── README.md
+```
+
+## Goal
+
+Build a reusable GitHub Action and CLI that automatically:
+1. Runs SonarQube/SonarCloud analysis
+2. Fetches open issues
+3. Uses an OpenAI-compatible LLM (LM Studio by default) to fix issues
+4. Validates changes (build, lint, tests)
+5. Re-runs Sonar
+6. Repeats until no more fixable issues remain (or retry limit reached)
+7. Commits changes
+8. Pushes a branch
+9. Creates a Pull Request
+
+## Packages
+
+### core
+Responsible only for orchestration.
+
+### sonar-client
+- Run sonar-scanner
+- Wait for Quality Gate
+- Fetch issues
+- Fetch hotspots
+- Download source metadata
+- Read metrics
+
+### llm-client
+Provider abstraction for various LLM providers:
+- LM Studio
+- OpenAI
+- Azure OpenAI
+- Anthropic
+- Ollama
+- OpenRouter
+
+### git-client
+- Create branch
+- Checkout
+- Commit
+- Push
+- Restore file
+- Reset
+- Create Pull Request (GitHub CLI)
+
+### validator
+Runs configurable commands:
+- npm run build
+- npm run lint
+- npm test
+
+### github-action
+Thin wrapper that reads action inputs and invokes core.run()
+
+### cli
+Exposes `npx sonar-autofix` using the same core package
+
+## Usage on Existing Projects
+
+See [USAGE.md](USAGE.md) for detailed instructions on how to use this tool with your existing projects.
+
+## Documentation
+
+For more details, see [PROJECT.md](PROJECT.md)

package/config.example.json

@@ -0,0 +1,30 @@
+{
+  "sonar": {
+    "host": "http://localhost:9000",
+    "project": "fundrest_core",
+    "token": "squ_31cadad2716678bde9ba02e7da4ce1b4c43c4944"
+  },
+  "llm": {
+    "provider": "lmstudio",
+    "endpoint": "http://localhost:1234/v1",
+    "model": "qwen3-coder-30b"
+  },
+  "validation": {
+    "build": [
+      "npm run build"
+    ],
+    "lint": [
+      "npm run lint"
+    ],
+    "tests": [
+      "npm test"
+    ]
+  },
+  "git": {
+    "branch": "sonar-autofix"
+  },
+  "retry": {
+    "maxIterations": 5
+  },
+  "prompt": {}
+}

package/package.json

@@ -0,0 +1,17 @@
+{
+  "name": "sonar-autofix",
+  "version": "0.0.5",
+  "scripts": {
+    "test": "node tests/core.test.js",
+    "test:structure": "node test-project.js"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "workspaces": [
+    "packages/*"
+  ],
+  "dependencies": {
+    "axios": "^1.19.0"
+  }
+}

package/packages/cli/index.js

@@ -0,0 +1,132 @@
+#!/usr/bin/env node
+// CLI entry point for Sonar Autofix
+const CoreOrchestrator = require('@sonar-autofix/core');
+const fs = require('fs');
+const path = require('path');
+
+/**
+ * CLI interface for the Sonar Autofix tool
+ * Supports configuration via JSON file and/or environment variables.
+ */
+async function main() {
+  console.log('Sonar Autofix CLI');
+  console.log('=========================');
+
+  // Parse command line arguments
+  const args = process.argv.slice(2);
+
+  // Handle help
+  if (args.length === 0 || args.includes('--help') || args.includes('-h')) {
+    console.log('');
+    console.log('This tool automatically fixes Sonar issues using LLMs.');
+    console.log('');
+    console.log('Usage:');
+    console.log('  npx sonar-autofix --config <path>  [options]');
+    console.log('');
+    console.log('Options:');
+    console.log('  --help, -h       Show this help message');
+    console.log('  --version, -v    Show version information');
+    console.log('  --config <path>  Path to configuration JSON file');
+    console.log('  --dry-run        Run without making changes');
+    console.log('');
+    console.log('Environment Variables:');
+    console.log('  SONAR_HOST       SonarQube/SonarCloud host URL');
+    console.log('  SONAR_PROJECT    Sonar project key');
+    console.log('  SONAR_TOKEN      Sonar authentication token');
+    console.log('  LLM_PROVIDER     LLM provider (lmstudio, openai, azure, anthropic, ollama, openrouter)');
+    console.log('  LLM_ENDPOINT     LLM API endpoint URL');
+    console.log('  LLM_MODEL        LLM model name');
+    console.log('  LLM_API_KEY      LLM API key');
+    console.log('  GIT_BRANCH       Branch name for autofix commits (default: sonar-autofix)');
+    console.log('');
+    console.log('Environment variables override config file values.');
+    return;
+  }
+
+  // Handle version
+  if (args.includes('--version') || args.includes('-v')) {
+    console.log('sonar-autofix v0.0.1');
+    return;
+  }
+
+  // Handle dry-run flag
+  const dryRun = args.includes('--dry-run');
+
+  // Load configuration from file
+  let config = {};
+  const configIndex = args.indexOf('--config');
+  if (configIndex !== -1 && configIndex + 1 < args.length) {
+    const configPath = args[configIndex + 1];
+    try {
+      const configFileContent = fs.readFileSync(path.resolve(configPath), 'utf8');
+      config = JSON.parse(configFileContent);
+    } catch (error) {
+      console.error('❌ Failed to read configuration file:', error.message);
+      process.exit(1);
+    }
+  }
+
+  // Apply environment variable overrides
+  if (process.env.SONAR_HOST || process.env.SONAR_PROJECT || process.env.SONAR_TOKEN) {
+    config.sonar = config.sonar || {};
+    if (process.env.SONAR_HOST) config.sonar.host = process.env.SONAR_HOST;
+    if (process.env.SONAR_PROJECT) config.sonar.project = process.env.SONAR_PROJECT;
+    if (process.env.SONAR_TOKEN) config.sonar.token = process.env.SONAR_TOKEN;
+  }
+
+  if (process.env.LLM_PROVIDER || process.env.LLM_ENDPOINT || process.env.LLM_MODEL || process.env.LLM_API_KEY) {
+    config.llm = config.llm || {};
+    if (process.env.LLM_PROVIDER) config.llm.provider = process.env.LLM_PROVIDER;
+    if (process.env.LLM_ENDPOINT) config.llm.endpoint = process.env.LLM_ENDPOINT;
+    if (process.env.LLM_MODEL) config.llm.model = process.env.LLM_MODEL;
+    if (process.env.LLM_API_KEY) config.llm.apiKey = process.env.LLM_API_KEY;
+  }
+
+  if (process.env.GIT_BRANCH) {
+    config.git = config.git || {};
+    config.git.branch = process.env.GIT_BRANCH;
+  }
+
+  // Apply dry-run
+  if (dryRun) {
+    config.dryRun = true;
+  }
+
+  // Validate required configuration
+  if (!config.sonar?.project) {
+    console.error('❌ Missing required configuration: sonar.project (or SONAR_PROJECT env var)');
+    process.exit(1);
+  }
+  if (!config.sonar?.token) {
+    console.error('❌ Missing required configuration: sonar.token (or SONAR_TOKEN env var)');
+    process.exit(1);
+  }
+  if (!config.llm?.provider) {
+    console.error('❌ Missing required configuration: llm.provider (or LLM_PROVIDER env var)');
+    process.exit(1);
+  }
+
+  // Run the core orchestrator
+  try {
+    const orchestrator = new CoreOrchestrator(config);
+
+    console.log('🚀 Starting Sonar Autofix...');
+    if (dryRun) {
+      console.log('   (dry-run mode — no changes will be made)');
+    }
+    const summary = await orchestrator.run();
+
+    console.log('✅ Done!');
+    return summary;
+  } catch (error) {
+    console.error('❌ Error:', error.message);
+    process.exit(1);
+  }
+}
+
+// Run the CLI if this file is executed directly
+if (require.main === module) {
+  main();
+}
+
+module.exports = { main };

package/packages/cli/package.json

@@ -0,0 +1,23 @@
+{
+  "name": "@sonar-autofix/cli",
+  "version": "0.0.1",
+  "description": "CLI tool for the Sonar Autofix tool",
+  "main": "index.js",
+  "bin": {
+    "sonar-autofix": "./index.js"
+  },
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [
+    "sonar",
+    "autofix",
+    "github",
+    "cli"
+  ],
+  "author": "Sonar Autofix Team",
+  "license": "MIT",
+  "dependencies": {
+    "@sonar-autofix/core": "^0.0.1"
+  }
+}