Merge pull request #47 from codacy/install-cli

feat: add install CLI functionality

Author: nedaKaighobadi

package.json

@@ -39,6 +39,13 @@
           "icon": "resources/icons/codacy-logo.svg",
           "when": "Codacy:RepositoryManagerStateContext == NeedsAuthentication"
         },
+        {
+          "id": "codacy:cli",
+          "name": "Codacy CLI",
+          "when": "!codacy:cliInstalled && codacy:canInstallCLI",
+          "icon": "$(gear)",
+          "initialSize": 2
+        },
         {
           "id": "codacy:prSummary",
           "name": "Pull request",
@@ -82,6 +89,16 @@
         "contents": "You have not yet signed in with Codacy\n[Sign in](command:codacy.signIn)",
         "when": "Codacy:RepositoryManagerStateContext == NeedsAuthentication"
       },
+      {
+        "view": "codacy:cli",
+        "contents": "[Install Codacy CLI](command:codacy.installCLI)",
+        "when": "!codacy:cliInstalled && codacy:canInstallCLI && !codacy:cliInstalling"
+      },
+      {
+        "view": "codacy:cli",
+        "contents": "$(loading~spin) Installing Codacy CLI...",
+        "when": "!codacy:cliInstalled && codacy:canInstallCLI && codacy:cliInstalling"
+      },
       {
         "view": "codacy:statuses",
         "contents": "No repositories open.",
@@ -200,6 +217,12 @@
         "title": "Reset Codacy MCP Server",
         "category": "Codacy commands",
         "when": "Codacy:RepositoryManagerStateContext == Loaded && codacy:supportsMCP && codacy:mcpConfigured"
+      },
+      {
+        "command": "codacy.installCLI",
+        "title": "Install Codacy CLI",
+        "category": "Codacy commands",
+        "when": "!codacy:cliInstalled && codacy:canInstallCLI"
       }
     ],
     "menus": {
@@ -223,6 +246,10 @@
         {
           "command": "codacy.configureMCP.reset",
           "when": "Codacy:RepositoryManagerStateContext == Loaded && codacy:supportsMCP && codacy:mcpConfigured"
+        },
+        {
+          "command": "codacy.installCLI",
+          "when": "!codacy:cliInstalled && codacy:canInstallCLI"
         }
       ],
       "view/title": [

src/commands/configureMCP.ts

@@ -5,6 +5,7 @@ import * as os from 'os'
 import { Config } from '../common/config'
 import { get, set } from 'lodash'
 import { Repository } from '../api/client'
+import { installCodacyCLI } from './installAnalysisCLI'
 
 interface Rule {
   when: string
@@ -269,6 +270,7 @@ export async function configureMCP(repository: Repository) {
 
     vscode.window.showInformationMessage('Codacy MCP server added successfully')
     await createRules(repository)
+    await installCodacyCLI(repository)
   } catch (error: unknown) {
     const errorMessage = error instanceof Error ? error.message : 'Unknown error occurred'
     vscode.window.showErrorMessage(`Failed to configure MCP server: ${errorMessage}`)

src/commands/installAnalysisCLI.ts

@@ -0,0 +1,89 @@
+import * as os from 'os'
+import * as vscode from 'vscode'
+import * as fs from 'fs'
+import * as path from 'path'
+import { exec } from 'child_process'
+import { promisify } from 'util'
+import { Config } from '../common/config'
+import { Repository } from '../api/client'
+
+const execAsync = promisify(exec)
+
+export async function isCLIInstalled(): Promise<boolean> {
+  try {
+    await execAsync('codacy-cli --help')
+    return true
+  } catch {
+    return false
+  }
+}
+
+async function isBrewInstalled(): Promise<boolean> {
+  try {
+    await execAsync('brew --version')
+    return true
+  } catch {
+    return false
+  }
+}
+
+async function initializeCLI(repository: Repository): Promise<void> {
+  const workspacePath = vscode.workspace.workspaceFolders?.[0]?.uri.fsPath || ''
+  const codacyYamlPath = path.join(workspacePath, '.codacy', 'codacy.yaml')
+  const apiToken = Config.apiToken
+
+  const { provider, owner: organization, name: repositoryName } = repository
+
+  try {
+    if (!fs.existsSync(codacyYamlPath)) {
+      await execAsync(
+        `codacy-cli init --api-token ${apiToken} --provider ${provider} --organization ${organization} --repository ${repositoryName}`
+      )
+    }
+    await execAsync('codacy-cli install')
+  } catch (error) {
+    if (error instanceof Error) {
+      throw new Error(`Failed to initialize Codacy CLI: ${error.message}`)
+    }
+    throw error
+  }
+}
+
+export async function installCodacyCLI(repository: Repository): Promise<void> {
+  const platform = os.platform()
+
+  if (await isCLIInstalled()) {
+    await initializeCLI(repository)
+    return
+  }
+
+  try {
+    switch (platform) {
+      case 'darwin':
+        if (!(await isBrewInstalled())) {
+          throw new Error('Please install Homebrew first and then try installing the Codacy CLI again.')
+        }
+        await execAsync('brew install codacy/codacy-cli-v2/codacy-cli-v2')
+        break
+
+      case 'linux':
+        throw new Error(
+          'Codacy CLI cannot be automatically installed on Linux yet. For manual installation, please refer to the [Codacy CLI documentation](https://github.com/codacy/codacy-cli-v2).'
+        )
+        break
+
+      case 'win32':
+        throw new Error('Codacy CLI is not supported on Windows yet.')
+
+      default:
+        throw new Error(`Unsupported operating system: ${platform}`)
+    }
+
+    await initializeCLI(repository)
+  } catch (error) {
+    if (error instanceof Error) {
+      throw new Error(`Failed to install Codacy CLI: ${error.message}`)
+    }
+    throw error
+  }
+}

src/extension.ts

@@ -1,4 +1,5 @@
 import * as vscode from 'vscode'
+import * as os from 'os'
 import { CommandType, wrapCommandWithCatch } from './common/utils'
 import Logger from './common/logger'
 import { initializeApi } from './api'
@@ -18,6 +19,7 @@ import Telemetry from './common/telemetry'
 import { decorateWithCoverage } from './views/coverage'
 import { APIState, Repository as GitRepository } from './git/git'
 import { configureMCP, createRules, isMCPConfigured } from './commands/configureMCP'
+import { installCodacyCLI, isCLIInstalled } from './commands/installAnalysisCLI'
 
 /**
  * Helper function to register all extension commands
@@ -96,6 +98,8 @@ export async function activate(context: vscode.ExtensionContext) {
       (vscode.env.appName.toLowerCase().includes('code') && !!vscode.extensions.getExtension('GitHub.copilot'))
   )
 
+  await vscode.commands.executeCommand('setContext', 'codacy:canInstallCLI', os.platform() === 'darwin')
+
   Config.init(context)
 
   initializeApi()
@@ -180,6 +184,46 @@ export async function activate(context: vscode.ExtensionContext) {
     item.onClick()
   })
 
+  // Register CLI installation commands
+  const updateCLIState = async () => {
+    const isInstalled = await isCLIInstalled()
+    vscode.commands.executeCommand('setContext', 'codacy:cliInstalled', isInstalled)
+  }
+
+  await updateCLIState()
+
+  context.subscriptions.push(
+    vscode.commands.registerCommand('codacy.installCLI', async () => {
+      await vscode.commands.executeCommand('setContext', 'codacy:cliInstalling', true)
+
+      await vscode.window.withProgress(
+        {
+          location: vscode.ProgressLocation.Window,
+          title: 'Installing Codacy CLI',
+          cancellable: false,
+        },
+        async () => {
+          try {
+            const repository = repositoryManager.repository
+            if (repository) {
+              await installCodacyCLI(repository)
+              await updateCLIState()
+              vscode.window.showInformationMessage('Codacy CLI installed successfully!')
+            } else {
+              throw new Error('No repository found')
+            }
+          } catch (error) {
+            vscode.window.showErrorMessage(
+              `Failed to install Codacy CLI: ${error instanceof Error ? error.message : 'Unknown error'}`
+            )
+          } finally {
+            await vscode.commands.executeCommand('setContext', 'codacy:cliInstalling', false)
+          }
+        }
+      )
+    })
+  )
+
   // Register MCP commands
   const updateMCPState = () => {
     const isConfigured = isMCPConfigured()

src/views/ProblemsDiagnosticCollection.ts

@@ -7,6 +7,7 @@ import { BranchIssue } from '../git/IssuesManager'
 import { CommitIssue } from '../api/client'
 import { ProcessedSarifResult, runCodacyAnalyze } from '../commands/runCodacyAnalyze'
 import * as path from 'path'
+import { isCLIInstalled } from '../commands/installAnalysisCLI'
 // import * as os from 'os'
 
 const patternSeverityToDiagnosticSeverity = (severity: 'Info' | 'Warning' | 'Error'): vscode.DiagnosticSeverity => {
@@ -169,7 +170,9 @@ export class ProblemsDiagnosticCollection implements vscode.Disposable {
       const codacyConfigExists =
         (await vscode.workspace.fs.stat(vscode.Uri.file(codacyConfigPath)).then(() => true)) || false
 
-      if (!codacyConfigExists) return
+      const isCliInstalled = await isCLIInstalled()
+
+      if (!isCliInstalled || !codacyConfigExists) return
 
       let pathToFile = document.uri.fsPath