Skip to content

Latest commit

 

History

1 Commit

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Roughdraft for Froots

Shows the Roughdraft review notes living in your KB pages — comments, suggested edits, replies, and what's still unresolved — in one Froots tab.

Why it works without talking to Roughdraft

Roughdraft keeps review state in the Markdown: CriticMarkup inline ({>>comment<<}, {++insert++}, {~~old~>new~~}) with the metadata in a trailing YAML endmatter block. Your KB pages are Markdown. So this plugin just reads them through app.kb.read and parses them.

It has to work that way. The Froots plugin sandbox has no network of its own, and the brokered app.net.fetch refuses http://, localhost, IP literals and any address that resolves to loopback — so Roughdraft's local server on port 7373 is unreachable from a plugin by design. This plugin therefore declares no capabilities at all.

The practical consequence: the plugin reads review notes, it does not open Roughdraft for you. Opening a document for review is still the CLI's job:

roughdraft open "path/to/page.md"

Install (development)

Copy this folder to <app data dir>/workspace/plugins/roughdraft/, then Settings → Plugins → Reload plugins. No build step.

App data dir is ~/Library/Application Support/com.motivex.desktop/ (or com.motivex.desktop.dev/ on dev builds); Settings → Plugins has an "Open folder" button.

What you get

  • A Roughdraft tab listing every KB page carrying review notes, each one expandable to the individual notes with author, line number and resolved state. The header pill counts what's still open.
  • ⌘K Open Roughdraft — jump to the tab.
  • ⌘K Roughdraft: count open review notes — a toast, no navigation.

Read-only in this version. Replying and resolving still happen in Roughdraft.

Tests

npm test

Nine tests over the parser. The last one writes a fixture to a temp dir and compares our counts against Roughdraft's own /api/review-index for the same bytes — it skips itself when the Roughdraft server isn't running, so the suite passes offline.

License

MIT.

About

Roughdraft review notes for your Froots KB — a community plugin

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages