Harden document linter heuristics, report output, and test coverage#39
Merged
Conversation
- Add Document Linter that analyzes the currently open markdown document - Parse front matter, headings, prose, code chunks, callouts, lists, and links - Ignore or downweight code chunks to focus on human-facing text - Return actionable suggestions grouped into clarity, flow, scannability, and engagement - Implement rule-based tests plus a scoring layer for analysis - Generate suggestions tied to exact lines or sections like a code review - Build as a small web app with three stages: parse, analyze, generate suggestions - Include a practical rules engine with checks like readability.max_sentence_length, structure.heading_depth_jump, etc. - Create a simple single-page app with score panel and inline suggestions in the editor - Implement markdown-aware parsing to isolate prose from code - Use rule-based checks first, with optional LLM suggestions second - Output section-by-section report plus optional 'improved draft' mode
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
This PR hardens the Document Linter so its output is more trustworthy, more actionable, and better covered by tests.
What changed
setTimeoutfrom the analysis path.messages.tsmodule.Rerun on changetoggle in the linter panel.Tests
Added/expanded QUnit coverage for:
Validation
npm run build:testnpx qunit tests/qunit/document-linter.test.jsnpm run test:qunitnpm run buildNotes
tests/qunit/auth.test.js.