📖 Add README Preview to Repository Overview#11
Merged
rkristelijn merged 4 commits intomainfrom Sep 24, 2025
Merged
Conversation
- Add getReadmePreview() function to extract first meaningful line from README files - Support README.md, readme.md, README.txt, readme.txt - Filter out HTML comments, badges, and empty headers - Skip project name if it matches repository name - Truncate long descriptions to 80 characters with '...' - Update both --list and interactive modes to show previews - Add 3 comprehensive tests for the new functionality Example output: 0: white-hat-hacking - Ethical Hacking Findings Collection 1: todo-md - A tool for the TODO.md standard Closes #10
- Increase default search depth to better handle nested directory structures - Now finds repos in ~/git/hub AND ~/git/lab by default - Update help text to reflect new default - Resolves issue where repos at depth 3+ were missed Before: 58 repos found (only ~/git/hub) After: 134 repos found (~/git/hub + ~/git/lab + others)
- Remove markdown links [text](url) -> text for cleaner display - Example: 'A tool for the [TODO.md](https://github.com/todo-md/todo-md) standard' becomes 'A tool for the TODO.md standard' - Add test for markdown link stripping - Fix test to expect new default maxDepth of 5 All 29 tests passing ✅
- Add previewLength config option (default: 80)
- Strip non-alphanumeric chars except spaces, dots, hyphens
- Pass config.previewLength to getReadmePreview function
- Add previewLength to default config creation
- Add 2 tests for character filtering and custom length
Example config:
{
"previewLength": 50 // Shorter previews
}
All 31 tests passing ✅
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
1 participant
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.
Closes #10
What's New
Repository listings now show README descriptions for better context:
Before:
After:
Features
Testing
Ready to merge!