feat(read): add notes read for convention-aware body reading#144
Open
olavostauros wants to merge 1 commit into
Open
feat(read): add notes read for convention-aware body reading#144olavostauros wants to merge 1 commit into
olavostauros wants to merge 1 commit into
Conversation
- Add .mise/tasks/read — a uv-based Python mise task that returns visible body (stripping frontmatter by default) - Support --json flag for structured component output (frontmatter/body/ diagnostics) - Support --with-frontmatter flag to include YAML frontmatter in plain text - Leverages existing note_components parser from PR KnickKnackLabs#127 - Follows same uv/usage pattern as .mise/tasks/parse - Add test/read.bats with 10 tests covering plain notes, frontmatter notes, JSON output, malformed frontmatter, missing notes, slug/path resolution - Update README with documentation and usage examples Closes KnickKnackLabs#126
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Closes #126
Adds
notes read <file>— the convention-aware read command that returns the visible Markdown body without YAML frontmatter by default. This builds on the parser foundation from PR #127 (notes parse) and establishes the CLI interface the issue proposed.Changes
.mise/tasks/read— New uv-based Python mise task (same pattern as.mise/tasks/parse):--jsonflag outputs structured components (frontmatter, body, diagnostics)--with-frontmatterflag includes YAML frontmatter in plain text outputnote_componentsparser librarytest/read.bats— 10 tests covering:--with-frontmatter→ frontmatter included--json→ structured output with correct components--jsonfor plain notes (no frontmatter present)notes read slugresolves from notes dirnotes read /path/to/file.md--jsondiagnostics field presentREADME.md— Updated quick start, daily workflow, what notes manages, and gotchas sections withnotes readdocumentationTest plan
notes readuses the same path resolution and parser asnotes parse