Structured Notes (VS Code Extension)

Structured Notes turns a plain text outline into an interactive task tree. Point the extension at the .txt file you already maintain and it mirrors the numbered headings as checkboxes with live progress, comments, and commands.

Highlights

• Reads a numbered outline (e.g. 1., 1.1, 1.2) from a workspace text file.
• Syncs both ways: toggling a checkbox edits the file, and file edits refresh the tree.
• Status bar progress indicator shows completed vs total items in real time.
• Optional inline comments per line (// comment) surface inside the tree view.
• Markdown-style headings (#, ##, …) become collapsible sections without checkboxes so you can group related tasks.
• Commands to add, rename, delete, or auto-clear completed items while keeping numbering tidy.
• Full view toolbar includes search, quick add, and a one-click “Delete completed” action synced with your outline.
• Color accents and priorities: annotate numbers like 1.(red) or 1.(green) to tint cards, or 1.(pr1)…1.(pr5) for priority reds.
• Drag & drop inside the full view to reorder notes; numbering and nested tasks update automatically.

Getting Started Locally

1. Install dependencies and compile once:

   npm install
   npm run compile
   

2. Open the folder in VS Code.
3. Launch the extension host (F5 → “Run Extension”).
4. In the Extension Development Host window, open the Explorer pane and locate the Structured Notes tree.
5. Run the command palette action Notes: Open Full View if you want a dedicated panel with large checkboxes and a progress bar.
6. Create or open the text file referenced by the setting structuredNotes.notesFile (defaults to NOTES.txt in the workspace). The extension creates an empty file if it cannot find one.
7. In the full view, use the toolbar to search across notes, add new top-level items, delete completed tasks, and right beside each entry tap + Sub-note or Delete for nested edits.

File format

Each note lives on one line:

--title-- Release Blueprint // optional subtitle
# Release Planning
1. [ ] Plan project            // optional comment
1.1.(red) [x] Chat with stakeholder //! shipped
1.2.(pr2) [ ] Draft proposal //!TODO capture screenshots
## Sprint Backlog
2.(green) [ ] Ship MVP
## System Roles
3.(pr1) [ ] System roles with auth //# roadmap
 3.1 [ ] Admin //! owner review
 3.2 [ ] Customer
   3.2.1 [ ] Validate customer flow
===

• Lines starting with # (one to six hashes) create headings in the tree; they are shown without checkboxes and act as containers.
• Lines starting with --title-- create a banner at the top of the panel; append // text for an optional subtitle.
• Lines starting with --subtitle-- add blue callout text beneath the banner (best used right after --title--).
• Lines containing only === (or <br>) drop in a horizontal separator between sections.
• The numbering (1., 1.1, 2. …) defines the hierarchy.
• Append color tokens directly after a number with parentheses to accent notes: e.g. 1.(red), 1.2.(green). Use pr1…pr5 for priority shades of red (pr1 highest).
• Completion state is taken from [ ] or [x]; toggling checkboxes inside VS Code updates the file.
• Anything after // becomes the note’s comment tooltip/description.
  • Prefix comments with ! for red alerts, !TODO for orange to-dos, ? for blue info, or # for green success. Plain // comments stay neutral.

Available Commands

• Notes: Add Note – create a new top-level note.
• Notes: Add Sub-Note – add a child to the selected note.
• Notes: Rename – rename the selected note.
• Notes: Edit Comment – attach or update a quick comment.
• Notes: Toggle Completion – flip completion state for a note and its children.
• Notes: Delete – remove the selected note (with confirmation).
• Notes: Clear Completed Notes – remove all completed items in the hierarchy.

The status bar entry doubles as a shortcut to add your next note. Hover items to see the numbered heading, completion state, and any stored comment. Use the full view’s toolbar to add top-level notes, insert nested items, or delete entries without leaving the panel.