feat(markdown): improve markdown parser and diagnostics #5292
Conversation
This file contains 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
…d fenced code blocks
…robust block handling
…markdown, headers, and lists
…ens and kinds - Rename `DemoSyntaxTreeBuilder` to `MarkdownSyntaxTreeBuilder` in markdown factory - Extend `MarkdownSyntaxKind` with new tokens for tables, lists, blockquotes, and delimiters - Add utility functions in `make.rs` to create various Markdown syntax tokens - Update macro rules to include new token types
- Introduce `markdown` module in configuration crate - Add `MarkdownConfiguration` struct with formatter, linter, and parser options - Extend `Configuration` struct to include optional Markdown configuration - Implement default configuration and configuration builder for Markdown
- Update `LintCommandPayload` to include Markdown linter configuration - Modify CLI session to handle Markdown linter in command processing - Add Markdown linter configuration import and merge logic in command runner
github-actions
bot
added
A-CLI
…kdown block types - Enhance parsing logic for blockquotes, headers, list items, and thematic breaks - Add more robust whitespace and marker handling - Improve continuation line parsing for list items - Implement more precise checkpoint and rewind mechanisms - Add better error recovery and validation for different block types
CodSpeed Performance ReportMerging #5292 will not alter performanceComparing Summary
|
ematipico
requested changes
Mar 7, 2025
There was a problem hiding this comment.
I am a bit conflicted about accepting the parsing of headers because there was another contributor who was working on it before you: #5208
I wish you could have engaged with us before jumping straight to developments. Let's see how it goes, since this PR needs some reviews.
Comment on lines
144
to
149
| // For now, update snapshots automatically | ||
| insta::with_settings!({ | ||
| prepend_module_to_snapshot => false, | ||
| snapshot_path => &test_directory, | ||
| // Auto-accept new snapshots during development | ||
| input_file => test_case_path.to_string_lossy().to_string(), |
There was a problem hiding this comment.
Please, let's avoid this. It's easier to accept a snapshot with another CLI command than figuring out why a snapshot was updated, because we might forget to update this code.
crates/biome_markdown_parser/tests/md_test_suite/ok/thematic_break_block.md.snap
Outdated
Show resolved
Hide resolved
crates/biome_markdown_parser/tests/md_test_suite/ok/thematic_break_block.md.snap
Outdated
Show resolved
Hide resolved
crates/biome_markdown_parser/tests/md_test_suite/err/invalid_header.md.snap
Outdated
Show resolved
Hide resolved
…figuration imports - Delete markdown parser test files including `parser_test.rs` and `spec_test.rs` - Remove unused Markdown configuration import from CLI commands module - Update spec test to use more robust debugging and tree structure printing - Remove test files for invalid markdown headers
…t validation - Add direct support for thematic break literal tokens - Enhance thematic break block parsing to handle whitespace and marker variations - Implement stricter validation to prevent invalid thematic break content - Add comments to clarify thematic break detection logic
…ine handling - Refactor blockquote parsing to handle nested blockquotes and continuation lines - Improve line parsing logic to support more complex blockquote structures - Simplify content node creation and add more robust parsing mechanism - Enhance end-of-blockquote detection with better line and EOF handling
…ed logic - Simplify header block parsing by removing redundant diagnostic creation - Enhance whitespace handling with a more concise consumption method - Remove explicit text node creation for header content - Improve header validation and parsing robustness
…rkers and thematic breaks - Enhance lexer to handle list markers for stars, minus, digits, and underscores - Implement more robust thematic break detection with flexible marker parsing - Separate parsing logic for different marker types to improve code clarity - Add support for various list marker formats and whitespace handling
- Simplify document parsing by removing unnecessary checks and improving block handling - Introduce a checkpoint mechanism for better fallback to paragraph parsing - Streamline block element recognition and improve error handling for unrecognized tokens - Add support for '+' as a list marker and enhance overall lexer functionality - Update tests to allow for development diagnostics and improve tree structure printing
… function names and logic - Rename functions for clarity: `at_header_block` to `at_atx_header` and `parse_header_block` to `parse_atx_header` - Improve header validation by ensuring whitespace follows hash symbols - Streamline content parsing logic for ATX headers, including handling of trailing hashes - Add a new function `at_setext_header` for future Setext header support
…alidation and diagnostics - Introduce detailed logging for whitespace and marker checks in unordered and ordered list parsing - Refactor list item parsing functions to include parent indentation tracking - Improve whitespace handling after list markers and ensure valid content parsing - Streamline continuation line handling for list items and enhance overall structure
- Consolidate paragraph parsing by removing redundant checks and simplifying inline element handling - Introduce a checkpoint mechanism to improve content validation and error handling - Enhance whitespace management and ensure proper handling of leading spaces and newlines - Create a more efficient structure for paragraph item list creation and completion
…aders, lists, and thematic breaks
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
I've made some needed improvements to the Markdown parser's structure and error reporting. The main issues I tackled were:
Before these changes, the parser couldn't properly report when someone wrote "#Header" instead of "# Header". Now it catches these errors with the right position info and a clear message. The new structure should also make it easier for others to work on the parser going forward.
Test Plan
The implementation correctness is demonstrated by:
✅ Tests passing
✅ Invalid header reporting diagnostics
✅ Some manual testing
To verify:
cargo test -p biome_markdown_parserto confirm all tests passinvalid_header.mdtest properly emits the diagnostic "Invalid header format: missing space after '#'"