BurntSushi/ripgrep

ngram indexing implementation details

Open

#1518 opened on Mar 16, 2020

View on GitHub
 (17 comments) (0 reactions) (0 assignees)Rust (63,768 stars) (2,559 forks)batch import
enhancementhelp wanted

Description

This is split off from #1497 as a space to discuss specific implementation details of the indexing strategy. I'd like to keep this discussion separate so that folks won't feel put off from participating in a higher level discussion around the UX.

TODO: I'll fill in a sketch of my high level plan when I get a chance.

Contributor guide

Tech stack
rust
Domain
searchcli
Issue type
research
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
5
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
over 1 week
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
unclear
Prerequisites
Rust programmingindexing conceptsngramsripgrep internals
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
10
Research direction
This issue is a placeholder for discussing implementation details of ngram indexing for ripgrep, split from issue #1497. The original author plans to provide a high level plan. To contribute, first review the comments and linked issue for context, then propose a concrete indexing strategy and implementation design. No active PRs or assignees.