README and spec status after milestone 0.6 9020cf612749
- Author
- Andy McCall @andymccall <[email protected]>
- When
- · 2026-09-27 16:02 UTC
- Signature
- ✔ signed by Andy McCall
- Hash
9020cf612749ab185636a39c31f09564344ae94da374a72a7dee3d0bb20bc7d5- Depends on
- 3006b700c514 bed495a96408
- Depended on by
- dac6876e4d08 cdcffe39dd9f 1f7fc1e3ae4a 44bfd5adfc9a b4626290e660 f6bda77ecb9f
- In bookmarks
- main
- In tags
- v0.16.0 v0.16.1 v0.17.0 v0.17.1 v0.18.0
- Edits
- 6 atoms, 0 tree operations, 2 files
Browse the tree at this change
modified README.md +23 −2
| … | 24 unchanged lines |
||
| 25 | 25 | `npm run watch` rebuilds on change; press F5 in VS Code to launch an |
|
| 26 | 26 | Extension Development Host with the bundle. |
|
| 27 | 27 | ||
| 28 | + | ## What it does |
|
| 29 | + | ||
| 30 | + | - **Source Control view**: Changes, Conflicts and Subrepos groups; open |
|
| 31 | + | changes as a diff against the working copy's base; discard, commit |
|
| 32 | + | selected paths, commit chosen hunks, amend; `Ctrl+Enter` commits. |
|
| 33 | + | - **Editor**: quick-diff gutters, explorer and tab decorations, inline blame |
|
| 34 | + | (toggle from the context menu), file history with diffs between versions, |
|
| 35 | + | CodeLens actions over conflict markers (accept a side, all sides, or a |
|
| 36 | + | deletion), keep-this-candidate for tree conflicts, Mark Resolved. |
|
| 37 | + | - **Status bar**: bookmark, working copy and state; click to switch, create, |
|
| 38 | + | merge or delete bookmarks; a sync counter with Sync, Fetch, Pull, Push and |
|
| 39 | + | Push Bookmark. |
|
| 40 | + | - **Views**: Oxygen Operations (undo to any point), Oxygen Bisect |
|
| 41 | + | (start, good, bad, skip, run, reset), Oxygen Trust (policy, signatures), |
|
| 42 | + | and a History graph with per-change actions (diff, check out, describe, |
|
| 43 | + | tag, abandon). |
|
| 44 | + | - **Commands**: Show History, File History, Tags, Create Tag, Add Workspace, |
|
| 45 | + | Update Subrepos, Verify Signatures, Clone Repository, Initialize Repository, |
|
| 46 | + | Show Output. |
|
| 47 | + | ||
| 28 | 48 | ## Status |
|
| 29 | 49 | ||
| 30 | - | Milestone 0.1 (read-only plus commit) of the spec. Bookmarks, sync, history, |
|
| 31 | - | blame, conflicts, subrepos, bisect and trust views follow in 0.2 to 0.6. |
|
| 50 | + | Milestones 0.1 to 0.6 of the spec are implemented (see CHANGELOG.md). Left |
|
| 51 | + | for 1.0: tests on macOS and Windows, a Marketplace publisher, and the open |
|
| 52 | + | questions in the spec. |
|
| 32 | 53 | ||
| 33 | 54 | ## Licence |
|
| 34 | 55 | ||
| … | 1 unchanged lines |
modified docs/spec.md +7 −1
| … | 1 unchanged lines |
||
| 2 | 2 | ||
| 3 | 3 | | | | |
|
| 4 | 4 | |---|---| |
|
| 5 | - | | **Status** | Draft 0.1 | |
|
| 5 | + | | **Status** | Draft 0.2 (milestones 0.1 to 0.6 implemented) | |
|
| 6 | 6 | | **Scope** | A VS Code extension giving Oxygen repositories the same integrated experience the built-in Git extension gives Git, plus what the Oxygen model makes possible | |
|
| 7 | 7 | | **Depends on** | `oxy` (reference implementation, spec Draft 0.8a) with the machine interface of §4 | |
|
| 8 | 8 | ||
| … | 191 unchanged lines |
||
| 200 | 200 | 6. **0.6 The rest**: subrepos, bisect, trust, tags, workspaces, clone and init. |
|
| 201 | 201 | 7. **1.0**: tests on three platforms, Marketplace listing, documentation. |
|
| 202 | 202 | ||
| 203 | + | ## 8a. Implementation notes (2026-09-27) |
|
| 204 | + | ||
| 205 | + | - The Timeline API is still proposed in VS Code, so file history is a command with a quick pick and diffs between versions rather than a Timeline provider. |
|
| 206 | + | - `oxy` gained `tag list --json` and `workspace list --json` for §4, and two bugs the extension's tests found were fixed in `oxy`: a chosen addition hunk now carries its content, and an unsigned repository keeps a tag's message. |
|
| 207 | + | - Extensions are per VS Code profile; the install command must name the profile a workspace uses. |
|
| 208 | + | ||
| 203 | 209 | ## 9. Open questions |
|
| 204 | 210 | ||
| 205 | 211 | 1. Whether the extension should ship `oxy` binaries for the three platforms or only locate one; shipping simplifies onboarding but ties releases together. |
|
| … | 2 unchanged lines |