Review flow
A reviewed mark belongs to the content of a symbol, not to a line. When the author pushes again, only the symbols that changed are open again.
Status: partly available
Reviewed marks
Available
- Select a symbol in the change map and press r. The symbol has the reviewed mark.
- The author pushes new commits.
- A symbol whose content is the same keeps its mark. A symbol whose content changed has no mark.
Oaink keeps a mark with the identity of the symbol and a hash of its content. Comments, spaces and line breaks are not in the hash. A push that only formats a symbol again does not remove its mark.
Mark Reviewed on a file or on a package marks each symbol in it.
Where a mark is
- Reviewed marks
- In the local store, in the Oaink data directory. Marks do not go to GitHub.
- Review drafts
- In the local store, in the Oaink data directory. A draft does not go to GitHub until a person publishes it.
- The Viewed state of a file
- On GitHub. Oaink does not write it yet.
- Planned
- Threads and reviews
- On GitHub, which is the shared record.
- Planned
Review drafts
A pull request has one review draft: an overview and threads. Oaink keeps the draft in the local store. The state of the pull request decides where the draft goes.
- Open pull request
- A pull request review, with a comment on the lines of each thread.
- Merged or closed
- A follow-up issue. It names the pull request. Each thread is a section with a permanent link to the file and the lines at the head that you reviewed.
- oaink draft show
- Shows the local draft of a pull request: the overview and the threads.
- oaink draft preview
- Shows what a publish of the draft sends to GitHub at this moment. The command sends nothing.
- Write and publish
- In the extension, by a person.
- Planned
A thread keeps the commit and the lines that you chose. It stays in the draft after new commits, a merge or a deleted branch.
What does not change
- Oaink does not approve a pull request and does not reject one.
- Oaink does not post to GitHub by itself. A person publishes.
- A mark says that you read a symbol. It says nothing about the symbol.
Other features
- Structural diffavailableRead symbols, not hunks. Only the tokens that changed have a mark.
- Signalspartly availableDeep static analysis in one Overview, with a reading order.
- NavigationavailableGo from a fact to the code: callers, broken imports, tests, the file at the line.
- The CLI for agentspartly availableThe same facts for an agent: one fact on each line, as JSON. It also shows a review draft.
- Oaink ProPlannedLens, agent context and CLI automation. Your review stays in your hands.
- Local-firstavailableOaink runs on your machine. It does not track your use.
Oaink is not released.
When it is, it installs from the VS Code Marketplace. Getting started