1
0
mirror of https://github.com/BurntSushi/ripgrep.git synced 2024-12-12 19:18:24 +02:00
ripgrep/crates/core
Andrew Gallant 12e4180985 doc: remove CPU features from man pages
It doesn't really belong in the man page since it's an artifact of a
build/runtime configuration. Moreover, it inhibits reproducible builds.

Fixes #1441
2020-03-15 13:19:14 -04:00
..
app.rs doc: remove CPU features from man pages 2020-03-15 13:19:14 -04:00
args.rs cli: add engine flag 2020-03-15 09:30:58 -04:00
config.rs repo: move all source code in crates directory 2020-02-17 19:24:53 -05:00
logger.rs repo: move all source code in crates directory 2020-02-17 19:24:53 -05:00
main.rs repo: move all source code in crates directory 2020-02-17 19:24:53 -05:00
messages.rs repo: move all source code in crates directory 2020-02-17 19:24:53 -05:00
path_printer.rs style: fix rust-analyzer lints in core 2020-03-15 09:04:54 -04:00
README.md repo: make ripgrep build with the new organization 2020-02-17 19:24:53 -05:00
search.rs style: fix rust-analyzer lints in core 2020-03-15 09:04:54 -04:00
subject.rs style: fix rust-analyzer lints in core 2020-03-15 09:04:54 -04:00

ripgrep core

This is the core ripgrep crate. In particular, main.rs is where the main function lives.

Most of ripgrep core consists of two things:

  • The definition of the CLI interface, including docs for every flag.
  • Glue code that brings the grep-matcher, grep-regex, grep-searcher and grep-printer crates together to actually execute the search.

Currently, there are no plans to make ripgrep core available as an independent library. However, much of the heavy lifting of ripgrep is done via its constituent crates, which can be reused independent of ripgrep. Unfortunately, there is no guide or tutorial to teach folks how to do this yet.