Merge pull request #145 from codacy/enable-local-dev

feat: add dev mode setting CF-1890

Author: nedaKaighobadi

package.json

@@ -203,6 +203,11 @@
         "contents": "$(check) Codacy CLI is installed. [Go to settings](command:workbench.action.openSettings?%22@ext:codacy-app.codacy%20cli%22).",
         "when": "codacy:canInstallCLI && codacy:cliInstalled"
       },
+      {
+        "view": "codacy:mcp",
+        "contents": "$(warning) Development mode is enabled. [Reinstall dependencies](command:codacy.installCLIDependencies).",
+        "when": "codacy:canInstallCLI && codacy:cliInstalled && codacy:devMode"
+      },
       {
         "view": "codacy:mcp",
         "contents": "$(warning) Codacy CLI not found. [Install CLI](command:codacy.installCLI)",
@@ -439,6 +444,12 @@
             "disabled"
           ],
           "default": "enabled"
+        },
+        "codacy.cli.devMode": {
+          "type": "boolean",
+          "title": "Enable development mode",
+          "description": "When enabled, the extension will no longer initialize the Codacy CLI automatically. Enabling this option may result in a degraded user experience.",
+          "default": false
         }
       }
     },

src/cli/MacCodacyCli.ts

@@ -6,6 +6,7 @@ import { CodacyError } from '../common/utils'
 import { CODACY_FOLDER_NAME, CodacyCli } from './CodacyCli'
 import Logger from '../common/logger'
 import { ProcessedSarifResult, processSarifResults } from '.'
+import { Config } from '../common/config'
 
 export class MacCodacyCli extends CodacyCli {
   constructor(rootPath: string, provider?: string, organization?: string, repository?: string) {
@@ -113,6 +114,8 @@ export class MacCodacyCli extends CodacyCli {
     const cliConfigFilePath = path.join(this.rootPath, CODACY_FOLDER_NAME, 'cli-config.yaml')
     const toolsFolderPath = path.join(this.rootPath, CODACY_FOLDER_NAME, 'tools-configs')
 
+    const devMode = Config.devMode
+
     const initFilesOk =
       fs.existsSync(configFilePath) && fs.existsSync(cliConfigFilePath) && fs.existsSync(toolsFolderPath)
     let needsInitialization = !initFilesOk
@@ -121,11 +124,20 @@ export class MacCodacyCli extends CodacyCli {
       // Check if the mode matches the current properties
       const cliConfig = fs.readFileSync(path.join(this.rootPath, CODACY_FOLDER_NAME, 'cli-config.yaml'), 'utf-8')
 
-      if ((cliConfig === 'mode: local' && this.repository) || (cliConfig === 'mode: remote' && !this.repository)) {
+      if (
+        ((cliConfig === 'mode: local' && this.repository) || (cliConfig === 'mode: remote' && !this.repository)) &&
+        !devMode
+      ) {
         needsInitialization = true
       }
     }
 
+    if (!needsInitialization && devMode) {
+      // install dependencies
+      await this.installDependencies()
+      Logger.debug('Dev mode enabled. Skipping initialization.')
+    }
+
     if (needsInitialization) {
       const initParams = (
         this._accountToken && this.repository && this.provider && this.organization

src/common/config.ts

@@ -5,6 +5,7 @@ export class Config {
   private _wsConfig: vscode.WorkspaceConfiguration | undefined
   private _apiToken: string | undefined
   private _onboardingSkipped: boolean | undefined
+  private _devMode: boolean | undefined
 
   private static _instance: Config | undefined
 
@@ -21,9 +22,15 @@ export class Config {
     const res = await Config._instance?._secretStorage.get('codacy.apiToken')
     Config._instance._apiToken = res
 
+    // Initialize dev mode from workspace configuration
+    Config._instance._devMode = Config._instance._wsConfig?.get('cli.devMode') === true
+
     if (Config._instance._apiToken) Logger.appendLine('Codacy API token found')
     if (Config._instance._onboardingSkipped) Logger.appendLine('No information about onboarding on Codacy found')
 
+    // Set dev mode context for views
+    await vscode.commands.executeCommand('setContext', 'codacy:devMode', Config._instance._devMode)
+
     this._onDidConfigChange.fire(Config._instance)
     return Config._instance
   }
@@ -65,4 +72,24 @@ export class Config {
   public static get apiToken(): string | undefined {
     return Config._instance?._apiToken
   }
+
+  public static get devMode(): boolean {
+    return Config._instance?._devMode === true
+  }
+
+  public static async updateDevMode() {
+    if (!Config._instance) return
+
+    Config._instance._wsConfig = vscode.workspace.getConfiguration('codacy')
+    const currentDevMode = Config._instance._wsConfig?.get('cli.devMode') === true
+    const hasChanged = Config._instance._devMode !== currentDevMode
+
+    Config._instance._devMode = currentDevMode
+
+    if (hasChanged) {
+      Logger.appendLine(`Dev mode ${currentDevMode ? 'enabled' : 'disabled'}`)
+      await vscode.commands.executeCommand('setContext', 'codacy:devMode', currentDevMode)
+      this._onDidConfigChange.fire(Config._instance)
+    }
+  }
 }

src/extension.ts

@@ -50,6 +50,9 @@ const registerCommands = async (context: vscode.ExtensionContext, codacyCloud: C
     'codacy.installCLI': async () => {
       await codacyCloud.cli?.install()
     },
+    'codacy.installCLIDependencies': async () => {
+      await codacyCloud.cli?.installDependencies()
+    },
     'codacy.configureMCP': async () => {
       await configureMCP(codacyCloud.params)
     },
@@ -217,6 +220,15 @@ export async function activate(context: vscode.ExtensionContext) {
       })
     )
 
+    // listen for workspace configuration changes to handle dev mode changes
+    context.subscriptions.push(
+      vscode.workspace.onDidChangeConfiguration((e) => {
+        if (e.affectsConfiguration('codacy.cli.devMode')) {
+          Config.updateDevMode()
+        }
+      })
+    )
+
     // check for open repository
     if (gitProvider.state === 'initialized' && gitProvider.repositories.length > 0) {
       Logger.debug(`Found ${gitProvider.repositories.length} repositories, opening first one`)