improving the Searcher JS module
Nobody has claimed this yet.
- Dominant language
- Ruby
- Stars
- 930
- Forks
- 465
- Avg merge
- 3d 10h
- Merged PRs (30d)
- 27
Description
Hello, I'd like to propose a change to the Searcher.js module at lib/rdoc/generator/template/json_index/js/searcher.js, to have this switch to using Fuse.js for its full text searching and highlighting capabilities. That part I can handle in a PR.
What part I got stuck on was how to test that this new implementation would be working as well (or, ideally, better) than the previous one. Are there some test cases that this should be passing within the RDoc project itself or some real-world cases that I could try out?
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading lib/rdoc/generator/template/json_index/js/searcher.js and compare its current full-text search and highlighting behavior with the proposed Fuse.js approach. Identify suitable RDoc test cases or real-world examples, then verify that the new implementation matches or improves the existing behavior and that those cases pass.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- search
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100