1
0
mirror of https://github.com/BurntSushi/ripgrep.git synced 2024-12-12 19:18:24 +02:00
ripgrep/crates/core
Andrew Gallant d6365117e2
doc: sync --help output with man page
The man page had the correct usage hints, but the -h/--help output was
using an older more incorrect version of the hints.

Closes #1730 (again)
2020-11-15 15:27:23 -05:00
..
app.rs doc: sync --help output with man page 2020-11-15 15:27:23 -05:00
args.rs doc: fix typos 2020-06-04 09:06:09 -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.