Merge pull request #68 from codacy/mcp-settings

feat: add guardrails settings to enable/disable analysis

Author: nedaKaighobadi

package.json

@@ -90,7 +90,7 @@
           "when": "Codacy:RepositoryManagerStateContext != NeedsAuthentication && codacy:supportsMCP",
           "icon": "$(gear)",
           "initialSize": 2
-        }        
+        }
       ]
     },
     "viewsWelcome": [
@@ -138,7 +138,7 @@
         "view": "codacy:mcp",
         "contents": "Codacy Guardrails MCP Server is enabled\n[Reset MCP Server](command:codacy.configureMCP.reset)",
         "when": "Codacy:RepositoryManagerStateContext == Loaded && codacy:supportsMCP && codacy:mcpConfigured"
-      }      
+      }
     ],
     "commands": [
       {
@@ -309,6 +309,42 @@
         "codacy.apiToken": {
           "type": "string",
           "description": "API Personal Token"
+        },
+        "codacy.guardrails.analyzeGeneratedCode": {
+          "type": "string",
+          "title": "Automatically analyze generated code with Codacy Guardrails",
+          "description": "This feature ensures that your generated code is analyzed by Codacy Guardrails.",
+          "enum": [
+            "enabled",
+            "disabled"
+          ],
+          "default": "enabled"
+        },
+        "codacy.guardrails.rulesFile": {
+          "type": "string",
+          "title": "Generate rules file for the AI Agent",
+          "description": "Allow the extension to generate Codacy specific rules for the AI Agent. Disabling this option will impact the user experience of Codacy Guardrails.",
+          "enum": [
+            "enabled",
+            "disabled"
+          ],
+          "default": "enabled"
+        },
+        "codacy.cli.cliVersion": {
+          "type": "string",
+          "description": "The version of the Codacy CLI to use",
+          "default": "1.0.0-main.251.1952e73"
+        },
+        "codacy.cli.analysisMode": {
+          "type": "string",
+          "title": "Local code analysis",
+          "description": "This feature allows you to analyze your code locally using the Codacy CLI.",
+          "enum": [
+            "enabled",
+            "only on saved files",
+            "disabled"
+          ],
+          "default": "enabled"
         }
       }
     },
@@ -339,7 +375,7 @@
     "@types/lodash": "^4.14.196",
     "@types/mocha": "^10.0.1",
     "@types/node": "20.4.7",
-    "@types/sarif": "2.1.7",    
+    "@types/sarif": "2.1.7",
     "@types/sinon": "^10.0.16",
     "@types/temp": "^0.9.1",
     "@types/vscode": "^1.81.0",

src/commands/configureMCP.ts

@@ -11,6 +11,7 @@ import Logger from '../common/logger'
 interface Rule {
   when: string
   enforce: string[]
+  scope: 'guardrails' | 'general'
 }
 
 interface RuleConfig {
@@ -19,7 +20,7 @@ interface RuleConfig {
   rules: Rule[]
 }
 
-const newRulesTemplate = (repository?: Repository): RuleConfig => {
+const newRulesTemplate = (repository?: Repository, excludedScopes?: ('guardrails' | 'general')[]): RuleConfig => {
   const repositoryRules: Rule[] = []
   if (repository) {
     const { provider, owner: organization, name } = repository
@@ -28,12 +29,14 @@ const newRulesTemplate = (repository?: Repository): RuleConfig => {
       enforce: [
         `use ${provider} for provider, ${organization} for organization and ${name} for repository, and avoid calling 'git remote -v' unless really necessary`,
       ],
+      scope: 'general',
     })
   }
 
   const commonRules: Rule[] = [
     {
       when: 'after ANY successful edit_file or reapply tool call',
+      scope: 'guardrails',
       enforce: [
         'IMMEDIATELY run codacy_cli_analyze tool for each edited file with:',
         '1. rootPath set to the workspace path',
@@ -48,6 +51,7 @@ const newRulesTemplate = (repository?: Repository): RuleConfig => {
     },
     {
       when: 'after adding new dependencies, libraries or packages',
+      scope: 'guardrails',
       enforce: [
         'IMMEDIATELY run codacy_cli_analyze tool for Trivy for:',
         '1. rootPath set to the workspace path',
@@ -58,14 +62,15 @@ const newRulesTemplate = (repository?: Repository): RuleConfig => {
     },
     {
       when: 'a call to a Codacy tool that has repository or organization as parameter returns 404 error',
+      scope: 'general',
       enforce: ['run codacy_setup_repository tool and then retry the action that failed'],
     },
   ]
 
   return {
     name: 'Codacy Rules',
     description: 'Configuration for AI behavior when interacting with Codacy',
-    rules: [...repositoryRules, ...commonRules],
+    rules: [...repositoryRules, ...commonRules].filter((rule) => !excludedScopes?.includes(rule.scope)),
   }
 }
 
@@ -132,7 +137,9 @@ const addRulesToGitignore = (rulesPath: string) => {
   }
 }
 export async function createRules(repository: Repository) {
-  const newRules = newRulesTemplate(repository)
+  const analyzeGeneratedCode = vscode.workspace.getConfiguration().get('codacy.guardrails.analyzeGeneratedCode')
+
+  const newRules = newRulesTemplate(repository, analyzeGeneratedCode === 'disabled' ? ['guardrails'] : [])
 
   try {
     const { path: rulesPath, format } = getCorrectRulesInfo()
@@ -219,6 +226,7 @@ export function isMCPConfigured(): boolean {
 }
 
 export async function configureMCP(repository: Repository) {
+  const generateRules = vscode.workspace.getConfiguration().get('codacy.guardrails.rulesFile')
   const ideConfig = getCorrectMcpConfig()
   try {
     const apiToken = Config.apiToken
@@ -267,7 +275,9 @@ export async function configureMCP(repository: Repository) {
     fs.writeFileSync(filePath, JSON.stringify(modifiedConfig, null, 2))
 
     vscode.window.showInformationMessage('Codacy MCP server added successfully. Please restart the IDE.')
-    await createRules(repository)
+    if (generateRules === 'enabled') {
+      await createRules(repository)
+    }
     await installCodacyCLI(repository)
   } catch (error: unknown) {
     const errorMessage = error instanceof Error ? error.message : 'Unknown error occurred'

src/commands/installAnalysisCLI.ts

@@ -15,10 +15,11 @@ const MAX_BUFFER_SIZE = 1024 * 1024 * 10
 
 const execAsync = (command: string) => {
   const workspacePath = vscode.workspace.workspaceFolders?.[0]?.uri.fsPath || ''
+  const cliVersion = vscode.workspace.getConfiguration().get('codacy.cli.cliVersion')
 
   return new Promise((resolve, reject) => {
     exec(
-      `CODACY_CLI_V2_VERSION=1.0.0-main.232.a6a6368 ${command}`,
+      `${cliVersion ? `CODACY_CLI_V2_VERSION=${cliVersion}` : ''} ${command}`,
       {
         cwd: workspacePath,
         maxBuffer: MAX_BUFFER_SIZE, // To solve: stdout maxBuffer exceeded

src/commands/runCodacyAnalyze.ts

@@ -18,6 +18,7 @@ export async function runCodacyAnalyze(filePath?: string) {
   try {
     // Get workspace folder (to solve: mkdir error)
     const workspaceFolders = vscode.workspace.workspaceFolders
+    const cliVersion = vscode.workspace.getConfiguration().get('codacy.cli.cliVersion')
     if (!workspaceFolders || workspaceFolders.length === 0) {
       throw new Error('No workspace folder found')
     }
@@ -27,7 +28,7 @@ export async function runCodacyAnalyze(filePath?: string) {
     const relativeFilePath = sanitizeFilePath(workspaceRoot, filePath)
 
     // Construct the command
-    const command = `CODACY_CLI_V2_VERSION=1.0.0-main.232.a6a6368 .codacy/cli.sh analyze --format sarif ${
+    const command = `${cliVersion ? `CODACY_CLI_V2_VERSION=${cliVersion}` : ''} .codacy/cli.sh analyze --format sarif ${
       relativeFilePath || ''
     }`
 

src/extension.ts

@@ -251,7 +251,8 @@ export async function activate(context: vscode.ExtensionContext) {
   )
 
   repositoryManager.onDidLoadRepository(async ({ repository }) => {
-    if (isMCPConfigured()) {
+    const generateRules = vscode.workspace.getConfiguration().get('codacy.guardrails.rulesFile')
+    if (isMCPConfigured() && generateRules === 'enabled') {
       await createRules(repository)
     }
   })

src/views/ProblemsDiagnosticCollection.ts

@@ -104,12 +104,15 @@ export class ProblemsDiagnosticCollection implements vscode.Disposable {
     })
 
     GitProvider.instance?.onDidChangeTextDocument(async (e) => {
+      const analysisMode = vscode.workspace.getConfiguration().get('codacy.cli.analysisMode')
+
       // avoid if the document is a .git file
       if (e.document.uri.fsPath.endsWith('.git')) return
 
       // update positions of remote issues in the document
       this.updateApiIssuesPositions(e.document)
 
+      if (analysisMode === 'disabled' || (analysisMode === 'only on saved files' && e.document.isDirty)) return
       // run local analysis for available tools
       await this.runAnalysisAndUpdateDiagnostics(e.document)
     })