Added a new setting platformio-ide.activateProjectOnTextEditorChange to enable automatic project activation depending on an active opened text editor // Resolve platformio#2410

Author: ivankravets

CHANGELOG.md

@@ -3,6 +3,7 @@
 ## 2.3.1 (2021-??-??)
 
 - Added a new setting ``platformio-ide.autoOpenPlatformIOIniFile`` to control an automatic opening of the `platformio.ini` file from a project when no other editors are opened (issue [#2419](https://github.com/platformio/platformio-vscode-ide/issues/2419))
+- Added a new setting ``platformio-ide.activateProjectOnTextEditorChange`` to enable automatic project activation depending on an active opened text editor (issue [#2410](https://github.com/platformio/platformio-vscode-ide/issues/2410))
 - Automatically activate project environment opened via "PIO Home > New Project / Open Project" (issue [#2414](https://github.com/platformio/platformio-vscode-ide/issues/2414))
 - Do not show "Default" environment when a project does not have any build environments (issue [#2450](https://github.com/platformio/platformio-vscode-ide/issues/2450))
 

package.json

@@ -517,6 +517,11 @@
           "default": false,
           "description": "Activate the PlatformIO extension only when a PlatformIO-based project (with `platformio.ini`) is opened in the workspace"
         },
+        "platformio-ide.activateProjectOnTextEditorChange": {
+          "type": "boolean",
+          "default": false,
+          "description": "Automatically activate project depending on an active opened text editor"
+        },
         "platformio-ide.autoOpenPlatformIOIniFile": {
           "type": "boolean",
           "default": true,

src/home.js

@@ -99,7 +99,7 @@ export default class PIOHome {
         if (command === 'open_project') {
           if (extension.projectObservable) {
             extension.projectObservable.saveProjectStateItem(
-              vscode.Uri.file(params).path,
+              vscode.Uri.file(params).fsPath,
               'activeEnv',
               undefined
             );

src/project/observable.js

@@ -66,7 +66,15 @@ export default class ProjectObservable {
 
     this.subscriptions = [
       this._pool,
-      // vscode.window.onDidChangeActiveTextEditor(() => this.switchToProject()),
+      vscode.window.onDidChangeActiveTextEditor(() => {
+        if (!extension.getSetting('activateProjectOnTextEditorChange')) {
+          return;
+        }
+        const projectDir = this.getActiveEditorProjectDir();
+        if (projectDir) {
+          this.switchToProject(projectDir);
+        }
+      }),
       vscode.workspace.onDidChangeWorkspaceFolders(() =>
         this.switchToProject(this.findActiveProjectDir())
       ),
@@ -105,6 +113,14 @@ export default class ProjectObservable {
   }
 
   findActiveProjectDir() {
+    let projectDir = undefined;
+    if (extension.getSetting('activateProjectOnTextEditorChange')) {
+      projectDir = this.getActiveEditorProjectDir();
+    }
+    return projectDir || this.getSelectedProjectDir();
+  }
+
+  getSelectedProjectDir() {
     const pioProjectDirs = ProjectObservable.getPIOProjectDirs();
     const currentActiveDir = this._pool.getActiveProjectDir();
     if (pioProjectDirs.length < 1) {
@@ -126,6 +142,27 @@ export default class ProjectObservable {
     return pioProjectDirs[0];
   }
 
+  getActiveEditorProjectDir() {
+    const pioProjectDirs = ProjectObservable.getPIOProjectDirs();
+    if (pioProjectDirs.length < 1) {
+      return undefined;
+    }
+    const editor = vscode.window.activeTextEditor;
+    if (!editor) {
+      return undefined;
+    }
+    const resource = editor.document.uri;
+    if (resource.scheme !== 'file') {
+      return undefined;
+    }
+    const folder = vscode.workspace.getWorkspaceFolder(resource);
+    if (!folder || !ProjectObservable.isPIOProjectSync(folder.uri.fsPath)) {
+      // outside workspace
+      return undefined;
+    }
+    return folder.uri.fsPath;
+  }
+
   loadProjectStateItem(projectDir, name) {
     const data = (this._persistentState.getValue('projects') || {})[projectDir] || {};
     return data[name];
@@ -169,30 +206,45 @@ export default class ProjectObservable {
     }
     this._sbEnvSwitcher.text = '$(root-folder) Loading...';
 
+    let currentProjectDir = undefined;
+    let currentEnvName = undefined;
+    if (this._pool.getActiveObserver()) {
+      currentProjectDir = this._pool.getActiveObserver().projectDir;
+      currentEnvName = this._pool.getActiveObserver().getActiveEnvName();
+    }
+
     const observer = this._pool.getObserver(projectDir);
-    let envName = undefined;
     if ('envName' in options) {
-      envName = options.envName;
+      await observer.switchProjectEnv(options.envName);
     } else if (!observer.getActiveEnvName()) {
-      envName = this.loadProjectStateItem(projectDir, 'activeEnv');
-    }
-    await observer.switchProjectEnv(envName);
-    this._pool.switch(projectDir);
-
-    if (this._taskManager) {
-      this._taskManager.dispose();
-      this._taskManager = undefined;
+      await observer.switchProjectEnv(
+        this.loadProjectStateItem(projectDir, 'activeEnv')
+      );
     }
-    this._taskManager = new ProjectTaskManager(projectDir, observer);
 
-    // open "platformio.ini" if no visible editors
+    // ignore active project and & env
     if (
-      vscode.window.visibleTextEditors.length === 0 &&
-      extension.getSetting('autoOpenPlatformIOIniFile')
+      !currentProjectDir ||
+      currentProjectDir !== projectDir ||
+      currentEnvName !== observer.getActiveEnvName()
     ) {
-      vscode.window.showTextDocument(
-        vscode.Uri.file(path.join(projectDir, 'platformio.ini'))
-      );
+      this._pool.switch(projectDir);
+
+      if (this._taskManager) {
+        this._taskManager.dispose();
+        this._taskManager = undefined;
+      }
+      this._taskManager = new ProjectTaskManager(projectDir, observer);
+
+      // open "platformio.ini" if no visible editors
+      if (
+        vscode.window.visibleTextEditors.length === 0 &&
+        extension.getSetting('autoOpenPlatformIOIniFile')
+      ) {
+        vscode.window.showTextDocument(
+          vscode.Uri.file(path.join(projectDir, 'platformio.ini'))
+        );
+      }
     }
 
     this.updateEnvSwitcher();