Fix: Issue #6 #7
Merged
Conversation
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
- Modified `WordDocumentReader` to detect "Heading1" through "Heading6" styles and prepend Markdown-style headers (`#` to `######`) to the text. - Added code comments explaining the heading detection logic. - Removed unused `HeaderRegex` from `SemanticChunker`. - Added `WordDocumentReaderTests` to verify that document structure is preserved. Fixes #6
There was a problem hiding this comment.
Pull request overview
This pull request enhances the WordDocumentReader to preserve document structure by detecting heading styles (Heading1-Heading6) and converting them to Markdown-style headers, enabling the SemanticChunker to properly understand Word document hierarchies. The PR also removes an unused HeaderRegex from SemanticChunker and adds tests to verify the new functionality.
Changes:
- Enhanced
WordDocumentReaderto detect and convert Word heading styles to Markdown headers - Removed unused
HeaderRegex()method fromSemanticChunker - Added comprehensive test coverage for the heading detection feature
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 5 comments.
| File | Description |
|---|---|
| Solutions/Rlm.Cli/Core/Documents/WordDocumentReader.cs | Added heading style detection logic that converts Word heading styles (Heading1-Heading6) to Markdown headers (#-######) to preserve document structure |
| Solutions/Rlm.Cli/Core/Chunking/SemanticChunker.cs | Removed unused HeaderRegex() GeneratedRegex method that was never called in the codebase |
| Solutions/Rlm.Cli.Tests/Core/Documents/WordDocumentReaderTests.cs | Added new test class to verify that Word documents with heading styles are correctly converted to Markdown format |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Solutions/Rlm.Cli.Tests/Core/Documents/WordDocumentReaderTests.cs
Outdated
Show resolved
Hide resolved
Solutions/Rlm.Cli.Tests/Core/Documents/WordDocumentReaderTests.cs
Outdated
Show resolved
Hide resolved
Solutions/Rlm.Cli.Tests/Core/Documents/WordDocumentReaderTests.cs
Outdated
Show resolved
Hide resolved
Comment on lines
50
to
73
| [TestMethod] | ||
| public async Task ReadAsync_DocumentWithHeadings_PreservesStructure() | ||
| { | ||
| // Arrange | ||
| CreateDocxWithHeadings(tempFilePath); | ||
| Uri uri = new(tempFilePath); | ||
|
|
||
| // Act | ||
| RlmDocument? document = await reader.ReadAsync(uri, TestContext.CancellationToken); | ||
|
|
||
| // Assert | ||
| document.ShouldNotBeNull(); | ||
|
|
||
| // This assertion is expected to FAIL currently | ||
| // We want to see: | ||
| // # Heading Level 1 | ||
| // Normal text | ||
| // ## Heading Level 2 | ||
| // More text | ||
|
|
||
| string content = document.Content; | ||
| content.ShouldContain("# Heading Level 1"); | ||
| content.ShouldContain("## Heading Level 2"); | ||
| } |
There was a problem hiding this comment.
The test coverage for heading detection could be more comprehensive. Consider adding test cases for:
- Edge cases like Heading6 (the maximum supported level)
- Invalid cases like Heading7 or Heading0 (should not be converted to markdown headers)
- Empty paragraphs with heading styles
- Case variations (e.g., "heading1" vs "Heading1")
- Integration with normal paragraphs without heading styles
This would ensure the heading detection logic in WordDocumentReader.cs (lines 84-88) is properly validated for all scenarios.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Solutions/Rlm.Cli.Tests/Core/Documents/WordDocumentReaderTests.cs
Outdated
Show resolved
Hide resolved
Contributor
|
@HowardvanRooijen I've opened a new pull request, #8, to work on those changes. Once the pull request is ready, I'll request review from you. |
* Initial plan * Fix platform-dependent newline assertion in WordDocumentReaderTests Co-authored-by: HowardvanRooijen <128664+HowardvanRooijen@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: HowardvanRooijen <128664+HowardvanRooijen@users.noreply.github.com>
Code Coverage Summary Report - Linux (No TFM)Summary
Coveragerlm - 65.2%
|
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.
WordDocumentReaderto detect "Heading1" through "Heading6" styles and prepend Markdown-style headers (#to######) to the text.HeaderRegexfromSemanticChunker.WordDocumentReaderTeststo verify that document structure is preserved.Fixes #6