improving the Searcher JS module

Open
#1,207 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
45/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
javascript
Domain
search

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.

Description

enhancement

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?

Dominant language
Ruby
Stars
930
Forks
472
Avg merge
2d 8h
Merged PRs (30d)
12

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from ruby/rdoc

All issues in ruby/rdoc

Similar issues

More Ruby issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.