feat: bootstrap code lens (#272)

Author: hverlin

docs/src/content/docs/reference/Bootstrap.md

@@ -54,6 +54,24 @@ Selecting an entry jumps to its declaration.
 Secrets are listed by name and by the environment variable they are read from.
 Their values are never read by the extension.
 
+## Section code lens
+
+Each `[bootstrap.*]` table gets a code lens on its header reporting how many of
+its entries are not in their desired state, for example
+`⚠ Bootstrap · 2/5 pending`. A section whose entries are all converged reads
+`✓ Bootstrap · 5 ok`, and one mise could not inspect here (a Linux-only section
+on macOS, Docker not running) reads `⊘ Bootstrap · not applicable here`.
+Hovering lists the entries behind the count, and clicking opens the bootstrap
+status view.
+
+Counts cover only the entries of the file you are looking at. `mise bootstrap
+status` merges every config file, so a workspace `mise.toml` does not report the
+packages or files declared in your global config.
+
+Reading the status inspects the machine, so it is only read for files that
+declare a bootstrap section. Set `mise.enableBootstrapCodeLens` to `false` to
+turn the lens off, or `mise.enableCodeLens` to turn off every code lens.
+
 ## Bootstrap plan
 
 `Mise: Show mise bootstrap plan` (or the diff icon in the `Bootstrap` panel)
@@ -63,6 +81,13 @@ by a summary of the create/update/remove/unchanged counts.
 
 This requires mise `2026.8.2` or later.
 
+A plan only covers the sections that have moved to mise's declarative resource
+model. The others are still applied by `mise bootstrap`, they just never show up
+in a plan, so a configuration made only of those plans nothing at all. mise
+grows this coverage as more sections adopt the model, so
+[the mise bootstrap docs](https://mise.jdx.dev/bootstrap.html) are the reference
+for what a plan reports today.
+
 ## Bootstrap status view
 
 Use the `Mise: Show bootstrap status` command (or the list icon in the

docs/src/content/docs/reference/Settings.md

@@ -269,6 +269,16 @@ Show the tools and environment variables of each [monorepo](https://mise.jdx.dev
 
 ---
 
+##### `mise.enableBootstrapCodeLens`
+- **Type:** `boolean`
+- **Default:** `true`
+
+Show a code lens on each `[bootstrap.*]` section reporting how many of its entries are not in their desired state.
+
+Requires `#mise.enableCodeLens#` and mise 2026.7.16+. Reading the status runs `mise bootstrap status`, which inspects the machine (installed packages, cloned repos, macOS defaults, Docker Compose projects); the result is cached and only read for files that declare a bootstrap section.
+
+---
+
 ##### `mise.showNotificationIfMissingTools`
 - **Type:** `boolean`
 - **Default:** `true`

package.json

@@ -384,6 +384,13 @@
           "default": true,
           "markdownDescription": "Show run/add tool code lens indicators in the editor."
         },
+        "mise.enableBootstrapCodeLens": {
+          "order": 11,
+          "type": "boolean",
+          "title": "Enable bootstrap code lens",
+          "default": true,
+          "markdownDescription": "Show a code lens on each `[bootstrap.*]` section reporting how many of its entries are not in their desired state.\n\nRequires `#mise.enableCodeLens#` and mise 2026.7.16+. Reading the status runs `mise bootstrap status`, which inspects the machine (installed packages, cloned repos, macOS defaults, Docker Compose projects); the result is cached and only read for files that declare a bootstrap section."
+        },
         "mise.enableToolLinks": {
           "order": 10.5,
           "type": "boolean",

src/configuration.ts

@@ -19,6 +19,7 @@ export const CONFIGURATION_FLAGS = {
 	configureExtensionsAutomaticallyIncludeList:
 		"configureExtensionsAutomaticallyIncludeList",
 	enableCodeLens: "enableCodeLens",
+	enableBootstrapCodeLens: "enableBootstrapCodeLens",
 	enableToolLinks: "enableToolLinks",
 	showToolVersionsDecorations: "showToolVersionsDecorations",
 	showToolEnvVarsDecorations: "showToolEnvVarsDecorations",
@@ -212,6 +213,10 @@ export const isCodeLensEnabled = () => {
 	return getConfOrElse(CONFIGURATION_FLAGS.enableCodeLens, true);
 };
 
+export const isBootstrapCodeLensEnabled = () => {
+	return getConfOrElse(CONFIGURATION_FLAGS.enableBootstrapCodeLens, true);
+};
+
 export const isToolLinksEnabled = () => {
 	return getConfOrElse(CONFIGURATION_FLAGS.enableToolLinks, true);
 };

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

@@ -195,14 +195,18 @@ suite("Bootstrap Test Suite", function () {
 			[
 				fixturePath(".mise-vscode-e2e-dir"),
 				fixturePath(".mise-vscode-e2e-dir-two"),
+				// [bootstrap.files] and [bootstrap.directories] merge across config
+				// files, so the global config contributes to the same section
+				fixturePath(".mise-vscode-e2e-global-dir"),
 				fixturePath(".mise-vscode-e2e-file.conf"),
+				fixturePath(".mise-vscode-e2e-global.conf"),
 				fixturePath(".mise-vscode-e2e-secret.conf"),
 			],
 			"directories and files share one section, in mise's order",
 		);
-		assert.equal(files.entries[2]?.state, "create");
+		assert.equal(files.entries[3]?.state, "create");
 		// the secret this file templates is never set, so mise cannot inspect it
-		assert.equal(files.entries[3]?.state, "unknown");
+		assert.equal(files.entries[5]?.state, "unknown");
 
 		const secrets = byLabel("Secrets");
 		assert.ok(secrets, "Secrets section should be present");
@@ -235,12 +239,14 @@ suite("Bootstrap Test Suite", function () {
 			[
 				{ kind: "directory", name: fixturePath(".mise-vscode-e2e-dir") },
 				{ kind: "directory", name: fixturePath(".mise-vscode-e2e-dir-two") },
+				{ kind: "directory", name: fixturePath(".mise-vscode-e2e-global-dir") },
 				{ kind: "file", name: fixturePath(".mise-vscode-e2e-file.conf") },
+				{ kind: "file", name: fixturePath(".mise-vscode-e2e-global.conf") },
 				{ kind: "file", name: fixturePath(".mise-vscode-e2e-secret.conf") },
 			],
 		);
 		assert.deepEqual(plan.summary, {
-			create: 3,
+			create: 5,
 			update: 0,
 			remove: 0,
 			unchanged: 0,
@@ -299,4 +305,115 @@ suite("Bootstrap Test Suite", function () {
 			"Selection should be on the secret declaration line",
 		);
 	});
+
+	test("shows a code lens on every bootstrap section of the document", async () => {
+		const lenses = (
+			(await vscode.commands.executeCommand<vscode.CodeLens[]>(
+				"vscode.executeCodeLensProvider",
+				miseTomlDocument.uri,
+			)) ?? []
+		).filter((lens) => lens.command?.command === "mise.showBootstrap");
+
+		// one lens per table declared in the fixture, anchored on its header
+		const byTable = new Map(
+			lenses.map((lens) => [
+				lens.command?.arguments?.[0] as string,
+				{ title: lens.command?.title ?? "", line: lens.range.start.line },
+			]),
+		);
+
+		assert.deepEqual(
+			[...byTable.keys()].sort(),
+			[
+				"bootstrap.directories",
+				"bootstrap.files",
+				// the friendly shorthands are reported as com.apple.* defaults, but
+				// they are written here, so their lenses belong on these tables
+				"bootstrap.macos.dock",
+				"bootstrap.macos.finder",
+				"bootstrap.macos.defaults.com.example.mise-vscode-e2e",
+				"bootstrap.repos",
+				"bootstrap.secrets",
+				"dotfiles",
+			].sort(),
+			"every bootstrap table of the fixture should get a lens",
+		);
+
+		assert.equal(
+			byTable.get("bootstrap.macos.finder")?.line,
+			lineOf("[bootstrap.macos.finder]"),
+			"the shorthand lens should sit on the shorthand table, not on defaults",
+		);
+		// `dock.autohide` is a dotted key inside [bootstrap.macos]: the lens has
+		// to anchor on that header, not on the line the key happens to be written
+		// on, or it renders in the middle of the table
+		assert.equal(
+			byTable.get("bootstrap.macos.dock")?.line,
+			lineOf("[bootstrap.macos]"),
+			"a dotted-key shorthand should anchor on its enclosing table header",
+		);
+
+		assert.equal(
+			byTable.get("bootstrap.repos")?.line,
+			lineOf("[bootstrap.repos]"),
+			"the lens should sit on the table header",
+		);
+
+		// the fixture entries all point at resources that do not exist
+		assert.match(
+			byTable.get("bootstrap.repos")?.title ?? "",
+			/^\$\(warning\) Bootstrap · 1\/1 pending$/,
+		);
+		assert.match(
+			byTable.get("bootstrap.secrets")?.title ?? "",
+			/^\$\(warning\) Bootstrap · 1\/1 pending$/,
+		);
+		// two files here, one of which mise cannot inspect without the secret: an
+		// uninspectable entry is not actionable, so it must not be reported. The
+		// global config declares a third file, which merges into the same status
+		// section and must not be counted by this document's lens
+		assert.match(
+			byTable.get("bootstrap.files")?.title ?? "",
+			/^\$\(warning\) Bootstrap · 1\/2 pending$/,
+		);
+		// likewise: two directories here, a third in the global config
+		assert.match(
+			byTable.get("bootstrap.directories")?.title ?? "",
+			/^\$\(warning\) Bootstrap · 2\/2 pending$/,
+		);
+	});
+
+	test("each config file gets a lens for its own entries only", async () => {
+		// the global config declares one file and one directory of its own, which
+		// merge into the same status sections as the workspace ones: its lenses
+		// must report only its two entries, not all six
+		const globalConfig = await vscode.workspace.openTextDocument(
+			path.join(workspaceRoot, "global-config.toml"),
+		);
+
+		const lenses = (
+			(await vscode.commands.executeCommand<vscode.CodeLens[]>(
+				"vscode.executeCodeLensProvider",
+				globalConfig.uri,
+			)) ?? []
+		).filter((lens) => lens.command?.command === "mise.showBootstrap");
+
+		assert.deepEqual(
+			lenses.map((lens) => lens.command?.arguments?.[0]).sort(),
+			["bootstrap.directories", "bootstrap.files"],
+			"only the sections the global config declares should get a lens",
+		);
+		for (const lens of lenses) {
+			assert.match(
+				lens.command?.title ?? "",
+				/^\$\(warning\) Bootstrap · 1\/1 pending$/,
+				`${lens.command?.arguments?.[0]} should count one entry`,
+			);
+			assert.match(
+				lens.command?.tooltip ?? "",
+				/mise-vscode-e2e-global/,
+				"the tooltip should list the entry of this document",
+			);
+		}
+	});
 });

src/e2e-tests/fixtures/bootstrap-workspace/global-config.toml

@@ -1,2 +1,13 @@
 # Used as MISE_GLOBAL_CONFIG_FILE for the bootstrap e2e suite so the machine's
 # real global config (tools, bootstrap sections) never leaks into the tests.
+
+# `bootstrap status` merges [bootstrap.files] and [bootstrap.directories]
+# across config files (unlike [bootstrap.repos], which the closest config wins
+# outright). These entries are what proves each code lens counts only the
+# entries of its own document.
+[bootstrap.directories."~/.mise-vscode-e2e-global-dir"]
+mode = "0755"
+
+[bootstrap.files."~/.mise-vscode-e2e-global.conf"]
+content = "global = true\n"
+mode = "0644"

src/e2e-tests/fixtures/bootstrap-workspace/mise.toml

@@ -5,6 +5,12 @@
 [bootstrap.repos]
 "vendor/mise-e2e-repo" = { url = "https://example.invalid/mise-e2e-repo.git" }
 
+# a shorthand written as a dotted key rather than as its own table. It parses
+# to the identical table, but it is not written on a header line, so the code
+# lens has to anchor on the enclosing header rather than on the key
+[bootstrap.macos]
+dock.autohide = true
+
 [bootstrap.macos.defaults]
 "com.example.mise-vscode-e2e" = { ExampleKey = true }
 

src/miseService.ts

@@ -288,6 +288,26 @@ export class MiseService {
 		storage: { type: "memory" },
 	}).define("getProjects", () => this.loadProjectEntries());
 
+	/**
+	 * `mise bootstrap status` inspects the machine: it shells out to the package
+	 * managers, `defaults`, docker and git, which costs far more than the default
+	 * command ttl is meant for. The code lens re-renders on every keystroke, so
+	 * the result is kept long enough that typing never spawns a subprocess.
+	 *
+	 * Everything the extension can observe invalidates this eagerly through
+	 * `invalidateCache`: running bootstrap from the extension reloads on task
+	 * end, and editing a config file reloads through the file watcher. What
+	 * stays unobservable is the machine changing on its own (`brew install` in a
+	 * terminal, `docker compose up`, `defaults write`), and the ttl is the only
+	 * thing that recovers from that.
+	 */
+	private bootstrapCache = createCache({
+		ttl: 30,
+		storage: { type: "memory" },
+	}).define("execCmd", ({ args, setMiseEnv } = {}) =>
+		this.execMiseCommand(args, { setMiseEnv }),
+	);
+
 	async invalidateCache() {
 		await Promise.all([
 			this.dedupeCache.clear(),
@@ -296,6 +316,7 @@ export class MiseService {
 			this.longTTLCache.clear(),
 			this.projectsCache.clear(),
 			this.taskCacheCache.clear(),
+			this.bootstrapCache.clear(),
 		]);
 		this.eventEmitter.fire();
 	}
@@ -1976,7 +1997,7 @@ export class MiseService {
 		}
 
 		try {
-			const { stdout } = await this.cache.execCmd({
+			const { stdout } = await this.bootstrapCache.execCmd({
 				args: ["bootstrap", "status", "--json"],
 			});
 			return JSON.parse(stdout) as MiseBootstrapStatus;
@@ -2019,7 +2040,7 @@ export class MiseService {
 		}
 
 		try {
-			const { stdout } = await this.cache.execCmd({
+			const { stdout } = await this.bootstrapCache.execCmd({
 				args: ["bootstrap", "plan", "--json"],
 			});
 			return JSON.parse(stdout) as MiseBootstrapPlan;