@runfile/cli 0.41.0 → 0.43.0

package/README.md

@@ -1,6 +1,6 @@
 # Runfile
 
-[Quick start](#quick-start) · [Why Runfile?](#why-runfile) · [Features](#what-makes-it-different) · [Platforms](#platform-support) · [Docs](.github/DOCS.md)
+[Quick start](#quick-start) · [Why Runfile?](#why-runfile) · [Features](#what-makes-it-different) · [VS Code](#vs-code-extension) · [Platforms](#platform-support) · [Docs](.github/DOCS.md)
 
 **One JSON file. One binary. Every OS. Every shell.**
 
@@ -98,6 +98,30 @@ prints that command to run from a fresh shell (npm can't overwrite the running `
 
 ---
 
+## VS Code extension
+
+Every release ships a VS Code extension that puts your targets in the editor — no `tasks.json` to generate or keep
+in sync. It runs `run :generate task-descriptors` and turns the result into real VS Code tasks plus a
+**Runfile → Targets** sidebar, complete with namespace folders and a **Globals** bucket for machine-wide targets.
+
+**Install** — download `runfile-vscode-<version>.vsix` from the
+[latest release](https://github.com/JoaaoVerona/runfile/releases/latest), then:
+
+```bash
+code --install-extension runfile-vscode-<version>.vsix
+```
+
+(or, in VS Code: **Extensions → … → Install from VSIX…**)
+
+Targets then show up in **Terminal → Run Task…** and in the Runfile sidebar. Every task is invoked with
+`--stdin-args`, so targets that need input prompt for it right in the task terminal. Nothing is written to your
+repository.
+
+The source lives in [`editors/vscode`](editors/vscode) — see its [README](editors/vscode/README.md) for settings,
+commands, and how the sidebar groups targets.
+
+---
+
 ## Why Runfile?
 
 Other runners assume one platform and one shell. Runfile assumes **none**.
@@ -642,7 +666,7 @@ independent flags widen the set:
 ##### Building your own integration: `task-descriptors`
 
 For tooling that builds its **own** editor integration (like the
-[Runfile VS Code extension](https://github.com/JoaaoVerona/runfile)), there's an editor-agnostic
+[Runfile VS Code extension](editors/vscode) shipped with this repo), there's an editor-agnostic
 alternative that always prints to stdout and never touches disk:
 
 ```bash
@@ -660,6 +684,7 @@ provenance so a client can bucket local vs. included vs. global targets itself:
     {
       "filePath": "/abs/path/Runfile.json",
       "kind": "local",              // "local" | "included" | "global"
+      "onlyInDirectories": ["~/w"], // only on globals restricted to certain dirs
       "targets": [
         {
           "name": "api:build",      // full canonical invocation name
@@ -672,6 +697,11 @@ provenance so a client can bucket local vs. included vs. global targets itself:
 }
 ```
 
+`onlyInDirectories` appears only on a `global` source that declared
+[`globals.onlyInDirectories`](.github/DOCS.md#onlyindirectories) — meaning it merged in only because the
+current directory is inside one of those paths. Such a source is registered machine-wide but scoped in
+practice, so clients are expected to treat it as project-local rather than truly global.
+
 Skip a target from the generated configs by setting `metadata.excludeFromGenerateCommand: true`. The
 `metadata` block on `globals` and on each target is **fully open** — any property of any JSON type
 (strings, numbers, booleans, arrays, deeply-nested objects) is accepted and round-trips untouched, so
@@ -775,6 +805,16 @@ run lint           # auto-format + clippy
 run test           # full workspace test suite
 ```
 
+The VS Code extension in [`editors/vscode`](editors/vscode) has its own targets, namespaced under `vscode:`:
+
+```bash
+run vscode:deps      # one-time: pnpm install (required before the targets below)
+run vscode:compile   # type-check + compile to editors/vscode/out
+run vscode:watch     # recompile on change
+run vscode:package   # build the .vsix
+run vscode:install   # package + install into VS Code
+```
+
 ---
 
 ## License

package/package.json

@@ -13,5 +13,5 @@
 	"license": "MIT",
 	"name": "@runfile/cli",
 	"repository": "https://github.com/JoaaoVerona/runfile",
-	"version": "0.41.0"
+	"version": "0.43.0"
 }