feat(internal/librarian/java): add extractSnippets for README generation - #6597
feat(internal/librarian/java): add extractSnippets for README generation#6597yangyzs wants to merge 6 commits into
Conversation
…README Add minLeadingSpaces and trimLeadingWhitespace helper functions to calculate and normalize code snippet indentation for README block rendering. Add unit tests in readme_test.go. For googleapis#6515
…r README rendering Add collectSnippetFiles and extractSnippetsFromFile helpers to scan Java and XML sample files for code snippets. Add unit tests in readme_test.go. For googleapis#6515
Add extractSnippets main function to collect sample files, extract code snippets, and trim leading whitespace across a directory. Add unit tests in readme_test.go. For googleapis#6515
There was a problem hiding this comment.
Code Review
This pull request introduces functionality to recursively scan, extract, and trim tagged code snippets from Java and XML files within a samples directory, along with comprehensive unit tests. The reviewer suggests using strings.Split instead of bufio.NewScanner when parsing files to prevent potential silent data loss if any line exceeds the default token limit.
Signed-off-by: yangyzs <171981480+yangyzs@users.noreply.github.com>
|
We discussed about this pull request offline. We think the logic to fetch pom settings from snippets is complex thus hard to maintain. We should render the pom settings in |
Agreed. Separately, I created #6619 to track the golden tests idea we discussed offline. |
Note: This pull request builds on top of #6593 and #6592. Please review and merge those first.
Add extractSnippets main function to collect sample files, extract code snippets, and trim leading whitespace across a directory. Add unit tests in readme_test.go.
For #6515