Skip to content

Commit 4cc029d

Browse files
authored
docs: add curated release notes for v0.1.0 (#202)
User-facing notes for the upcoming 0.1.0 release: CLI 0.15.2 alignment, Insert after section, install channels, and upgrade guidance. Signed-off-by: Sebastien Tardif <sebtardif@ncf.ca>
1 parent 3742f21 commit 4cc029d

1 file changed

Lines changed: 114 additions & 0 deletions

File tree

RELEASE_NOTES.md

Lines changed: 114 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,114 @@
1+
# Patchloom for VS Code 0.1.0
2+
3+
This is the first **0.1** release of the official VS Code extension for
4+
[Patchloom](https://github.com/patchloom/patchloom). It pairs the extension
5+
with [Patchloom CLI v0.15.2](https://github.com/patchloom/patchloom/releases/tag/patchloom-v0.15.2):
6+
more install options, a new markdown Quick Action, clearer Batch Apply
7+
examples, and docs that match the current CLI and MCP surface.
8+
9+
## Highlights
10+
11+
- **Recommended CLI is 0.15.2.** Managed install and **Update Patchloom**
12+
still pull the latest GitHub release. Minimum supported CLI remains **0.3.0**.
13+
- **Insert after section.** New Quick Action for `md insert-after-section`
14+
(CLI 0.14+): place a sibling markdown section after a full section body,
15+
not just under the heading line.
16+
- **Easier CLI installs.** README and Getting Started walkthrough cover
17+
Homebrew, npm (`npm install -g patchloom` / `npx`), Scoop (Windows),
18+
cargo, and the shell installer, in addition to **Install Patchloom**.
19+
- **Batch plans that match modern CLI.** The Batch Apply template includes
20+
fuzzy replace with `--min-fuzzy-score` and `md.insert_after_section`.
21+
22+
MCP servers started through the extension still use `patchloom mcp-server`.
23+
With CLI 0.15.x that exposes **56 tools** (up from 54 in the 0.10 era).
24+
25+
## Why 0.1.0
26+
27+
0.0.x covered the full setup path (managed CLI, agent rules, multi-editor
28+
MCP, Quick Actions, Batch Apply, status bar, verify). 0.1.0 is the same
29+
product, now versioned as a stable minor line and aligned with current
30+
Patchloom CLI practice for agent and workspace use.
31+
32+
No settings migration is required. Existing `patchloom.path` values and
33+
managed installs keep working.
34+
35+
## Aligned with Patchloom CLI 0.11–0.15
36+
37+
You do not need every CLI feature to use the extension. These are the
38+
parts that matter if you upgrade the binary:
39+
40+
| CLI range | What you get with a current managed install |
41+
|-----------|---------------------------------------------|
42+
| 0.11–0.13 | Stronger `--contain` coverage, clearer plan/batch errors, match reporting on replace |
43+
| 0.14 | `md insert-after-section`, batch flags such as `--fuzzy` / `--min-fuzzy-score`, more install channels (npm, Scoop, Chocolatey) |
44+
| 0.15 | Stable MCP and JSON contracts (`selector` on doc tools, `applied` on write results), 56 MCP tools |
45+
46+
Workspace Quick Actions and Batch Apply still pass global `--contain` so
47+
paths stay inside the open folder. Containment follows the effective
48+
working directory (the workspace folder). Patch merge still skips
49+
containment when the patch file may live outside the project.
50+
51+
## New features
52+
53+
- **Insert after section.** From **Patchloom: Quick Action**, insert
54+
sibling content after a full markdown section (for example a `## FAQ`
55+
after `## Config` without stuffing text under the Config heading).
56+
Same diff preview and Apply flow as other markdown actions. (#198)
57+
- **Richer Batch Apply template.** Default plan lines demonstrate fuzzy
58+
replace and `md.insert_after_section` alongside replace, `doc.set`,
59+
`file.append`, and `tidy.fix`. (#198)
60+
- **Install docs for npm and Scoop.** Getting started and the walkthrough
61+
list the channels Patchloom publishes today, so Windows and Node users
62+
have a clear path when they are not using Homebrew. (#198)
63+
64+
## Improvements
65+
66+
- **Docs match live CLI/MCP contracts.** Recommended version, tool count,
67+
and capability descriptions track CLI 0.15.2. Command shapes used by
68+
the extension (`replace` with `--new`, `doc` selectors, MCP `selector`,
69+
`agent-rules` mode/platform, line-oriented `batch`) were re-checked
70+
against that release. (#198)
71+
- **Initialize Project and Batch Apply tests.** Extra coverage for
72+
agent-rules mode/platform picks and for Batch Apply always invoking
73+
`batch` with global `--contain`. (#192)
74+
75+
## Upgrading
76+
77+
1. Update the extension to **0.1.0** (VS Code Marketplace, Open VSX, or `.vsix`).
78+
2. Update the Patchloom CLI when you can:
79+
80+
```bash
81+
# Managed install (Command Palette)
82+
# Patchloom: Update Patchloom
83+
84+
brew upgrade patchloom
85+
86+
npm install -g patchloom
87+
88+
scoop update patchloom
89+
90+
curl -LsSf https://github.com/patchloom/patchloom/releases/latest/download/patchloom-installer.sh | sh
91+
```
92+
93+
3. If you use MCP in VS Code, Cursor, or Windsurf, restart the MCP host
94+
after a CLI upgrade so tool lists and schemas refresh.
95+
4. Optional: run **Setup Workspace** or **Initialize Project** if you want
96+
a fresh `AGENTS.md` for the current CLI guidance.
97+
98+
### CLI version guidance
99+
100+
| Level | Version | Notes |
101+
|-------|---------|--------|
102+
| Minimum | 0.3.0 | Older builds may miss commands the extension offers |
103+
| Recommended | **0.15.2+** | Current MCP tool set, markdown section insert, fuzzy batch flags, path containment |
104+
105+
## Requirements
106+
107+
- VS Code 1.90 or newer (or compatible editors: Cursor, Windsurf, VSCodium)
108+
- Patchloom CLI 0.3.0 or newer (0.15.2+ recommended)
109+
110+
## Links
111+
112+
- Extension: [VS Code Marketplace](https://marketplace.visualstudio.com/items?itemName=patchloom.patchloom) · [Open VSX](https://open-vsx.org/extension/patchloom/patchloom)
113+
- CLI release: [patchloom-v0.15.2](https://github.com/patchloom/patchloom/releases/tag/patchloom-v0.15.2)
114+
- Issues: [patchloom/patchloom-vscode](https://github.com/patchloom/patchloom-vscode/issues)

0 commit comments

Comments
 (0)