Fix #111, Relative paths in pyIgnore setting do not work

- Added support for syncFolder specific pyIgnore values

Author: paulober

README.md

@@ -6,7 +6,7 @@ Pico-W-Go provides code auto-completion and allows you to communicate with your
 
 Works with:
 | Platform | x64 | arm64 | armhf |
-| -------- | --- | ----- | ----- |
+| :------- | :-: | :---: | :---: |
 | Windows  | ✅   | ✅     | ❌     |
 | macOS    | ✅   | ✅     | ❌     |
 | Linux    | ✅   | ✅     | ✅     |
@@ -74,7 +74,7 @@ This extension contributes the following settings:
 * `picowgo.additionalSyncFolders`: Specifies additional folders that can be selected as upload sources when uploading a project. If left empty, the sync will be performed based on the folder specified in the 'syncFolder' setting. Only folders within the project are allowed. Specify the path relative to the project you have opened in Visual Studio Code, without a leading or trailing slash.
 * `picowgo.syncAllFileTypes`: If enabled, all files will be uploaded no matter the file type. The list of file types below will be ignored.
 * `picowgo.syncFileTypes`: All types of files that will be uploaded to the board, seperated by comma. All other filetypes will be ignored during an upload (or download) action.
-* `picowgo.pyIgnore`: Comma separated list of files and folders to ignore when uploading (no wildcard or regular expressions supported).
+* `picowgo.pyIgnore`: Comma separated list of files and folders to ignore when uploading relative to syncFolder (no wildcard or regular expressions supported except `**/<file/folder>` to exclude an item by its name in every sub folder). Use `<additionalSyncFolder>:file/to/exclude.py` to create sync folder exclusive exclusion rules (all other rules will always be applied relative to the selected sync folder). Replace `additionalSyncFolder` with a value from your `picowgo.additionalSyncFolders` setting or the value from `picowgo.syncFolder`.
 * `picowgo.openOnStart`: Automatically open the Pico-W-Go console and connect to the board after starting VS Code.
 * `picowgo.statusbarButtons`: Select which buttons to show in the statusbar (DO NOT CHANGE, unless you know what you are doing)
 * `picowgo.gcBeforeUpload`: Run garbage collection before uploading files to the board. This will free up some memory usefull when uploading large files but adds about a second or two to the upload process.

package.json

@@ -314,19 +314,20 @@
         },
         "picowgo.pyIgnore": {
           "title": "Pyignore list",
-          "description": "Comma separated list of files and folders to ignore when uploading relative to syncFolder (no wildcard or regular expressions supported)",
+          "markdownDescription": "Comma separated list of files and folders to ignore when uploading relative to syncFolder (no wildcard or regular expressions supported except `**/<file/folder>` to exclude an item by its name in every sub folder). Use `<additionalSyncFolder>:file/to/exclude.py` to create sync folder exclusive exclusion rules (all other rules will always be applied relative to the selected sync folder). Replace `additionalSyncFolder` with a value from your `picowgo.additionalSyncFolders` setting or the value from `picowgo.syncFolder`.",
           "type": "array",
           "items": {
             "type": "string"
           },
           "default": [
-            ".picowgo",
-            ".vscode",
-            ".gitignore",
-            ".git",
-            "project.pico-go",
-            "env",
-            "venv"
+            "**/.picowgo",
+            "**/.vscode",
+            "**/.gitignore",
+            "**/.git",
+            "**/.DS_Store",
+            "**/project.pico-go",
+            "**/env",
+            "**/venv"
           ],
           "order": 8
         },
@@ -380,7 +381,6 @@
         "picowgo.softResetAfterUpload": {
           "type": "boolean",
           "default": false,
-          "scope": "machine-overridable",
           "title": "Soft-reset after upload",
           "description": "Soft-resets your board after any upload action which also reruns main.py and boot.py. Usefull when working with main.py and boot.py.",
           "order": 12

src/activator.mts

@@ -513,6 +513,20 @@ export default class Activator {
         return;
       }
 
+      // reducde replaces filter, map and concat
+      const ignoredSyncItems = settings.getIngoredSyncItems().reduce(
+        (acc: string[], item: string) => {
+          // item must either be global or for the current sync folder otherwise it is ignored
+          if (!item.includes(":") || item.split(":")[0] === syncDir[0]) {
+            const finalItem = item.includes(":") ? item.split(":")[1] : item;
+            acc.push(finalItem);
+          }
+
+          return acc;
+        },
+        ["**/.picowgo", "**/.DS_Store"]
+      );
+
       if (settings.getBoolean(SettingsKey.gcBeforeUpload)) {
         // TODO: maybe do soft reboot instead of gc for bigger impact
         await this.pyb?.executeCommand(
@@ -532,9 +546,9 @@ export default class Activator {
 
           let currentFileIndex = -1;
           const data = await this.pyb?.startUploadingProject(
-            syncDir,
+            syncDir[1],
             settings.getSyncFileTypes(),
-            settings.getIngoredSyncItems().concat([".picowgo"]),
+            ignoredSyncItems,
             (data: string) => {
               this.logger.debug("upload progress: " + data);
               const status = this.analyseUploadDownloadProgress(data);
@@ -551,7 +565,7 @@ export default class Activator {
               }
 
               progress.report({
-                message: sep + relative(syncDir, status.filePath),
+                message: sep + relative(syncDir[1], status.filePath),
               });
             }
           );
@@ -693,7 +707,7 @@ export default class Activator {
           async (progress /*, token*/) => {
             let currentFileIndex = -1;
             const data = await this.pyb?.downloadProject(
-              syncDir,
+              syncDir[1],
               (data: string) => {
                 const status = this.analyseUploadDownloadProgress(data);
 

src/settings.mts

@@ -2,7 +2,7 @@ import type { Memento, WorkspaceConfiguration } from "vscode";
 import { window, workspace } from "vscode";
 import { PyboardRunner } from "@paulober/pyboard-serial-com";
 import { getProjectPath } from "./api.mjs";
-import { join } from "path";
+import { join, relative } from "path";
 
 export enum SettingsKey {
   autoConnect = "autoConnect",
@@ -129,11 +129,12 @@ export default class Settings {
    * @param actionTitle The title of the action to perform. Used in the selection dialog.
    * E.g. "Upload" or "Download".
    *
-   * @returns The absolute path to one sync folder.
+   * @returns [Relative to workspace root path of one sync folder,
+   * The absolute path to one sync folder]
    */
   public async requestSyncFolder(
     actionTitle: string
-  ): Promise<string | undefined> {
+  ): Promise<[string, string] | undefined> {
     const syncFolder = this.getSyncFolderAbsPath();
     const projectDir = getProjectPath();
 
@@ -150,7 +151,11 @@ export default class Settings {
       additionalSyncFolders === undefined ||
       additionalSyncFolders.length === 0
     ) {
-      return syncFolder;
+      if (syncFolder === undefined) {
+        return undefined;
+      } else {
+        return [relative(projectDir, syncFolder), syncFolder];
+      }
     }
 
     // prepend normal syncFolder if available to options
@@ -170,7 +175,9 @@ export default class Settings {
       title: `${actionTitle} sync folder selection`,
     });
 
-    return selectedFolder;
+    return selectedFolder === undefined
+      ? undefined
+      : [relative(projectDir, selectedFolder), selectedFolder];
   }
 
   /**