fix: be more resilient to invalid config files (#273)

Author: hverlin

.vscode-test.js

@@ -59,6 +59,25 @@ module.exports = defineConfig([
 			timeout: 60_000,
 		},
 	},
+	{
+		label: "broken-config",
+		files: "src/e2e-tests/broken-config/*.e2e.ts",
+		workspaceFolder: path.join(fixturesPath, "broken-config-workspace"),
+		env: {
+			MISE_CEILING_PATHS: fixturesPath,
+			MISE_LOCKED: "0",
+			MISE_TRUSTED_CONFIG_PATHS: fixturesPath,
+			MISE_GLOBAL_CONFIG_FILE: path.join(
+				fixturesPath,
+				"broken-config-workspace",
+				"global-config.toml",
+			),
+		},
+		mocha: {
+			require: ["tsx/cjs"],
+			timeout: 60_000,
+		},
+	},
 	{
 		label: "command-injection",
 		files: "src/e2e-tests/command-injection/*.e2e.ts",

docs/src/content/docs/reference/Environment-variables.md

@@ -12,6 +12,9 @@ variable to find where it's defined.
 
 ![env-list.png](../../../assets/env-1.png)
 
+While a config file does not parse, the list keeps showing the previous
+values. See [While a config file is being edited](/mise-vscode/reference/misetoml-language-support/#while-a-config-file-is-being-edited).
+
 ## Loading environment variables
 
 `mise-vscode` will automatically load all the environment variables provided by

docs/src/content/docs/reference/Tasks.md

@@ -20,6 +20,9 @@ Click on a task to navigate to the file where the task is defined.
 Using the command palette: `cmd|ctrl+shift+p` and search for
 `Mise: Open task definition`.
 
+While a config file does not parse, the task list and the code lens actions
+keep showing the previous tasks. See [While a config file is being edited](/mise-vscode/reference/misetoml-language-support/#while-a-config-file-is-being-edited).
+
 ## Running a task
 
 You have several ways to run a task with the extension:

docs/src/content/docs/reference/Tools.md

@@ -23,6 +23,9 @@ in the current project. You can also the list of global tools.
 
 ![img.png](../../../assets/tools-activity-bar.png)
 
+A config file that does not parse is marked in the explorer. Its tools are the
+ones from the last time the file parsed. See [While a config file is being edited](/mise-vscode/reference/misetoml-language-support/#while-a-config-file-is-being-edited).
+
 ## Tools list
 
 Use the list `List all tools` button to list all installed tools.

docs/src/content/docs/reference/mise.toml-language-support.md

@@ -137,3 +137,31 @@ If you are using [multi-lines task script](https://mise.jdx.dev/tasks/toml-tasks
 The following languages are supported: Python, Node.js, Deno, Bun, Deno, Ruby, Bash, and Shell.
 
 ![screenshot showing syntax highlighting support when shebang is used](./syntax-highlighting-shebang.png)
+
+### While a config file is being edited
+
+With auto save enabled, a config file is written while you are still typing it.
+mise cannot read a file that does not parse, so every command fails until it
+does.
+
+Instead of clearing the panels, the extension keeps showing the last state it
+could read. The status bar shows a warning while this is the case, and config
+files that do not parse are marked in the activity bar.
+
+If a command never succeeded, its error is shown as usual. Opening a project
+with a config file that is already broken shows errors.
+
+Running or watching a task is refused while a config file does not parse. You
+get a message pointing at the file, instead of a mise error about a task that
+does not exist.
+
+The kept state is dropped when:
+
+- the file parses again
+- you save it yourself with `Cmd`/`Ctrl`+`S`
+- you reload the configuration from the activity bar, the status bar or the
+  command palette
+
+Reloads the extension does on its own, for example after running a task, do not
+drop it. There is no timeout: the state is kept for as long as the file does not
+parse.

package.json

@@ -617,7 +617,7 @@
     "viewsWelcome": [
       {
         "view": "miseTasksView",
-        "contents": "[Tasks](https://mise.jdx.dev/tasks/) will be displayed here. ([refresh](command:mise.refreshEntry))\n[Add task](command:mise.createTomlTask)",
+        "contents": "[Tasks](https://mise.jdx.dev/tasks/) will be displayed here. ([refresh](command:mise.reloadConfiguration))\n[Add task](command:mise.createTomlTask)",
         "when": "config.mise.binPath && config.mise.enable && !mise.tasksProviderError"
       },
       {
@@ -627,7 +627,7 @@
       },
       {
         "view": "miseTasksView",
-        "contents": "[Install mise](https://mise.jdx.dev/getting-started.html) to get started.\nOnce mise is installed, click reload.\n[Reload](command:mise.refreshEntry)\n[Configure](command:mise.openExtensionSettings)",
+        "contents": "[Install mise](https://mise.jdx.dev/getting-started.html) to get started.\nOnce mise is installed, click reload.\n[Reload](command:mise.reloadConfiguration)\n[Configure](command:mise.openExtensionSettings)",
         "when": "!config.mise.binPath"
       },
       {
@@ -709,6 +709,11 @@
     "commands": [
       {
         "command": "mise.refreshEntry",
+        "title": "Mise: Reload configuration (internal)",
+        "enablement": "!isWeb"
+      },
+      {
+        "command": "mise.reloadConfiguration",
         "title": "Mise: Reload configuration",
         "icon": "$(refresh)",
         "enablement": "!isWeb"
@@ -999,6 +1004,10 @@
     ],
     "menus": {
       "commandPalette": [
+        {
+          "command": "mise.refreshEntry",
+          "when": "false"
+        },
         {
           "command": "mise.showTaskCacheMenu",
           "when": "false"
@@ -1111,7 +1120,7 @@
           "group": "navigation@3"
         },
         {
-          "command": "mise.refreshEntry",
+          "command": "mise.reloadConfiguration",
           "when": "view == miseTasksView || view == miseToolsView || view == miseEnvsView || view == miseBootstrapView",
           "group": "navigation@4"
         }

src/commands.ts

@@ -30,6 +30,12 @@ export const MISE_OPEN_EXTENSION_SETTINGS = "mise.openExtensionSettings";
 export const MISE_OPEN_TASK_DEFINITION = "mise.openTaskDefinition";
 export const MISE_OPEN_TOOL_DEFINITION = "mise.openToolDefinition";
 export const MISE_RELOAD = "mise.refreshEntry";
+/**
+ * The reload the user asks for, from the sidebar, the status bar or the palette.
+ * `MISE_RELOAD` is also fired internally after tasks, settings and workspace
+ * changes, so only this one drops the state kept while a config does not parse.
+ */
+export const MISE_RELOAD_FROM_USER = "mise.reloadConfiguration";
 export const MISE_REMOVE_TOOL = "mise.removeTool";
 export const MISE_OPEN_BOOTSTRAP_ENTRY_DEFINITION =
 	"mise.openBootstrapEntryDefinition";

src/e2e-tests/bootstrap/bootstrap.e2e.ts

@@ -76,6 +76,8 @@ suite("Bootstrap Test Suite", function () {
 			"mise.runBootstrapDryRun",
 			"mise.runBootstrapPlan",
 			"mise.showBootstrap",
+			"mise.reloadConfiguration",
+			"mise.refreshEntry",
 			"mise.openBootstrapEntryDefinition",
 		]) {
 			assert.ok(