Merge pull request #4 from vquelque/glob_pattern_support

Release V1.1.0
vquelque · Apr 11, 2023 · 1ea3b35 · 1ea3b35
2 parents 4714c3c + c7cf2b7
commit 1ea3b35
Show file tree

Hide file tree

Showing 28 changed files with 550 additions and 422 deletions.
diff --git a/.eslintrc.json b/.eslintrc.json
@@ -1,24 +1,18 @@
 {
-    "root": true,
-    "parser": "@typescript-eslint/parser",
-    "parserOptions": {
-        "ecmaVersion": 6,
-        "sourceType": "module"
-    },
-    "plugins": [
-        "@typescript-eslint"
-    ],
-    "rules": {
-        "@typescript-eslint/naming-convention": "warn",
-        "@typescript-eslint/semi": "warn",
-        "curly": "warn",
-        "eqeqeq": "warn",
-        "no-throw-literal": "warn",
-        "semi": "off"
-    },
-    "ignorePatterns": [
-        "out",
-        "dist",
-        "**/*.d.ts"
-    ]
+  "root": true,
+  "parser": "@typescript-eslint/parser",
+  "parserOptions": {
+    "ecmaVersion": 6,
+    "sourceType": "module"
+  },
+  "plugins": ["@typescript-eslint"],
+  "rules": {
+    "@typescript-eslint/naming-convention": "warn",
+    "@typescript-eslint/semi": "warn",
+    "curly": "warn",
+    "eqeqeq": "warn",
+    "no-throw-literal": "warn",
+    "semi": "off"
+  },
+  "ignorePatterns": ["out", "dist", "**/*.d.ts"]
 }
diff --git a/.gitignore b/.gitignore
@@ -102,3 +102,9 @@ dist
 
 # TernJS port file
 .tern-port
+
+#test
+.vscode-test
+
+#typescript compiled artifacts
+out/
diff --git a/.vscode/extensions.json b/.vscode/extensions.json
@@ -1,7 +1,5 @@
 {
-	// See http://go.microsoft.com/fwlink/?LinkId=827846
-	// for the documentation about the extensions.json format
-	"recommendations": [
-		"dbaeumer.vscode-eslint"
-	]
+  // See http://go.microsoft.com/fwlink/?LinkId=827846
+  // for the documentation about the extensions.json format
+  "recommendations": ["dbaeumer.vscode-eslint"]
 }
diff --git a/.vscode/launch.json b/.vscode/launch.json
@@ -3,34 +3,30 @@
 // Hover to view descriptions of existing attributes.
 // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
 {
-	"version": "0.2.0",
-	"configurations": [
-		{
-			"name": "Run Extension",
-			"type": "extensionHost",
-			"request": "launch",
-			"args": [
-				"--disable-extensions", 
-				"--extensionDevelopmentPath=${workspaceFolder}"
-			],
-			"outFiles": [
-				"${workspaceFolder}/out/**/*.js"
-			],
-			"preLaunchTask": "${defaultBuildTask}"
-		},
-		{
-			"name": "Extension Tests",
-			"type": "extensionHost",
-			"request": "launch",
-			"args": [
-				"--disable-extensions",
-				"--extensionDevelopmentPath=${workspaceFolder}",
-				"--extensionTestsPath=${workspaceFolder}/out/test/suite/index"
-			],
-			"outFiles": [
-				"${workspaceFolder}/out/test/**/*.js"
-			],
-			"preLaunchTask": "${defaultBuildTask}"
-		}
-	]
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "Run Extension",
+      "type": "extensionHost",
+      "request": "launch",
+      "args": [
+        "--disable-extensions",
+        "--extensionDevelopmentPath=${workspaceFolder}"
+      ],
+      "outFiles": ["${workspaceFolder}/out/**/*.js"],
+      "preLaunchTask": "${defaultBuildTask}"
+    },
+    {
+      "name": "Extension Tests",
+      "type": "extensionHost",
+      "request": "launch",
+      "args": [
+        "--disable-extensions",
+        "--extensionDevelopmentPath=${workspaceFolder}",
+        "--extensionTestsPath=${workspaceFolder}/out/test/suite/index"
+      ],
+      "outFiles": ["${workspaceFolder}/out/test/**/*.js"],
+      "preLaunchTask": "${defaultBuildTask}"
+    }
+  ]
 }
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -1,11 +1,12 @@
 // Place your settings in this file to overwrite default and user settings.
 {
-    "files.exclude": {
-        "out": false // set this to true to hide the "out" folder with the compiled JS files
-    },
-    "search.exclude": {
-        "out": true // set this to false to include "out" folder in search results
-    },
-    // Turn off tsc task auto detection since we have the necessary tasks as npm scripts
-    "typescript.tsc.autoDetect": "off"
-}
+  "files.exclude": {
+    "out": false // set this to true to hide the "out" folder with the compiled JS files
+  },
+  "search.exclude": {
+    "out": true // set this to false to include "out" folder in search results
+  },
+  // Turn off tsc task auto detection since we have the necessary tasks as npm scripts
+  "typescript.tsc.autoDetect": "off",
+  "editor.formatOnSave": true
+}
diff --git a/.vscode/tasks.json b/.vscode/tasks.json
@@ -1,20 +1,20 @@
 // See https://go.microsoft.com/fwlink/?LinkId=733558
 // for the documentation about the tasks.json format
 {
-	"version": "2.0.0",
-	"tasks": [
-		{
-			"type": "npm",
-			"script": "watch",
-			"problemMatcher": "$tsc-watch",
-			"isBackground": true,
-			"presentation": {
-				"reveal": "never"
-			},
-			"group": {
-				"kind": "build",
-				"isDefault": true
-			}
-		}
-	]
+  "version": "2.0.0",
+  "tasks": [
+    {
+      "type": "npm",
+      "script": "watch",
+      "problemMatcher": "$tsc-watch",
+      "isBackground": true,
+      "presentation": {
+        "reveal": "never"
+      },
+      "group": {
+        "kind": "build",
+        "isDefault": true
+      }
+    }
+  ]
 }
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -8,3 +8,16 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [Unreleased]
 
 ## [1.0.0] - 2023-03-12
+
+## [1.1.0] - 2023-04-11
+
+### Added
+
+- Mark/Unmark multiple files from the file explorer (Thanks @UsmannK)
+- Switch to '.gitignore format' for the `scope.txt` file (Thanks @DavidBDiligence)
+- Switch from disk-based storage to workspace memory (for future web compatibility)
+- Add a feature to export marked files to a custom file on disk
+
+### Changed
+
+- Formatted files using Prettier.
diff --git a/LICENSE.md b/LICENSE.md
@@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+SOFTWARE.
diff --git a/README.md b/README.md
@@ -6,11 +6,11 @@
 
 The extension allows you to mark/unmark files by:
 
-* Providing a `scope.txt` file in the workspace root folder. The file contains a list of absolute file paths or relative file paths to the workspace root folder. The file paths must be separated by newlines.
-* Right clicking on a file in the file explorer and selecting `Mark/Unmark File` from the context menu.
-* Right clicking on an editor tab and selecting `Mark/Unmark File` from the context menu.
+- Providing a `scope.txt` file in the workspace root folder. The file contains a list of patterns for files to include in the scope. The patterns are written using the [.gitignore format](https://git-scm.com/docs/gitignore#_pattern_format), e.g., `**.sol` to include all Solidity files in all directories.
+- Selecting a single/multiple files in the explorer and clicking on `Mark/Unmark File` from the context menu.
+- Right clicking on an editor tab and selecting `Mark/Unmark File` from the context menu.
 
-Note that the marked files are stored in a `scope.txt` file in the workspace root folder. If the file does not exist, it will be created.
+Note that the marked files are stored in the workspace local storage. In case of mulit-root workspaces, if you don't save the workspace, the marks will be discarded if the workspace is closed. You can also export the marked files to a file on disk by invoking the `Export maked files to a file` command. For multi-root workspaces, marked files will be exported to individual files located at the root of each opened foler. Marked files exported to disk can be re-imported by naming the export file as `scope.txt`, and using the import feature.
 
 ### Mark/Unmark files from contextual menus
 
@@ -20,13 +20,12 @@ Note that the marked files are stored in a `scope.txt` file in the workspace roo
 
 ![Mark files from scope file](images/scope.gif)
 
-
 ## Extension Settings
 
 This extension contributes the following settings:
 
-* `markfiles.colorMarkedFile`: Choose whether to mark files by adding an icon, changing the color of the file name or both.
-* `markfiles.markedFileIcon`: Choose the symbol to use for marked files. Note that the symbol must be a single unicode character.
+- `markfiles.colorMarkedFile`: Choose whether to mark files by adding an icon, changing the color of the file name or both.
+- `markfiles.markedFileIcon`: Choose the symbol to use for marked files. Note that the symbol must be a single unicode character.
 
 The color used to mark files can be changed by modifying the following key in your `settings.json` file:
 
@@ -36,7 +35,6 @@ The color used to mark files can be changed by modifying the following key in yo
 }
 ```
 
-
 ## Release Notes
 
 Check [CHANGELOG.md](CHANGELOG.md)
diff --git a/out/extension.js b/out/extension.js
diff --git a/out/extension.js.map b/out/extension.js.map