rust/ripgrep
1
0
Fork 0
mirror of https://github.com/BurntSushi/ripgrep.git synced 2024-12-12 19:18:24 +02:00
Code Issues Releases Activity
a0e8dbe9df
ripgrep/Cargo.toml

108 lines
3.0 KiB
TOML
Raw Normal View History

initial commit
2016-02-27 18:07:26 +02:00
[package]
Rename xrep to ripgrep.
2016-09-08 22:15:44 +02:00
name = "ripgrep"
13.0.0
2021-06-12 14:12:24 +02:00
version = "13.0.0" #:version
initial commit
2016-02-27 18:07:26 +02:00
authors = ["Andrew Gallant <jamslam@gmail.com>"]
description = """
doc: improve wording This tightens up the wording in ripgrep's opening description. It's used in several places, so we update all of them. Closes #1881
2021-05-30 09:03:40 +02:00
ripgrep is a line-oriented search tool that recursively searches the current
directory for a regex pattern while respecting gitignore rules. ripgrep has
first class support on Windows, macOS and Linux.
initial commit
2016-02-27 18:07:26 +02:00
"""
Rename xrep to ripgrep.
2016-09-08 22:15:44 +02:00
documentation = "https://github.com/BurntSushi/ripgrep"
homepage = "https://github.com/BurntSushi/ripgrep"
repository = "https://github.com/BurntSushi/ripgrep"
initial commit
2016-02-27 18:07:26 +02:00
keywords = ["regex", "grep", "egrep", "search", "pattern"]
Add 'text-processing' category.
2017-01-21 18:31:09 +02:00
categories = ["command-line-utilities", "text-processing"]
crates.io: use 'OR' instead of '/' Fixes #987
2018-07-21 19:25:39 +02:00
license = "Unlicense OR MIT"
Don't include HomebrewFormula in crate.
2016-10-11 04:24:28 +02:00
exclude = ["HomebrewFormula"]
Switch from Docopt to Clap. There were two important reasons for the switch: 1. Performance. Docopt does poorly when the argv becomes large, which is a reasonable common use case for search tools. (e.g., use with xargs) 2. Better failure modes. Clap knows a lot more about how a particular argv might be invalid, and can therefore provide much clearer error messages. While both were important, (1) made it urgent. Note that since Clap requires at least Rust 1.11, this will in turn increase the minimum Rust version supported by ripgrep from Rust 1.9 to Rust 1.11. It is therefore a breaking change, so the soonest release of ripgrep with Clap will have to be 0.3. There is also at least one subtle breaking change in real usage. Previous to this commit, this used to work: rg -e -foo Where this would cause ripgrep to search for the string `-foo`. Clap currently has problems supporting this use case (see: https://github.com/kbknapp/clap-rs/issues/742), but it can be worked around by using this instead: rg -e [-]foo or even rg [-]foo and this still works: rg -- -foo This commit also adds Bash, Fish and PowerShell completion files to the release, fixes a bug that prevented ripgrep from working on file paths containing invalid UTF-8 and shows short descriptions in the output of `-h` but longer descriptions in the output of `--help`. Fixes #136, Fixes #189, Fixes #210, Fixes #230
2016-11-13 04:48:11 +02:00
build = "build.rs"
ripgrep: disable autotests This keeps us working in Rust 2018. Fixes #923
2018-06-24 02:19:34 +02:00
autotests = false
edition: move core ripgrep to Rust 2018
2019-01-19 17:15:56 +02:00
edition = "2018"
cargo: set rust-version This should hopefully make compilation errors from using an older-than-supported compiler more helpful. PR #2373
2022-12-21 14:37:09 +02:00
rust-version = "1.65"
initial commit
2016-02-27 18:07:26 +02:00
globbing by regex
2016-08-26 03:44:37 +02:00
[[bin]]
bench = false
repo: make ripgrep build with the new organization
2020-02-18 01:28:09 +02:00
path = "crates/core/main.rs"
Rename xrep to ripgrep.
2016-09-08 22:15:44 +02:00
name = "rg"
globbing by regex
2016-08-26 03:44:37 +02:00
Add integration tests.
2016-09-10 04:58:30 +02:00
[[test]]
name = "integration"
path = "tests/tests.rs"
Speeding CI builds
2017-12-19 01:04:49 +02:00
[workspace]
libripgrep: initial commit introducing libripgrep libripgrep is not any one library, but rather, a collection of libraries that roughly separate the following key distinct phases in a grep implementation: 1. Pattern matching (e.g., by a regex engine). 2. Searching a file using a pattern matcher. 3. Printing results. Ultimately, both (1) and (3) are defined by de-coupled interfaces, of which there may be multiple implementations. Namely, (1) is satisfied by the `Matcher` trait in the `grep-matcher` crate and (3) is satisfied by the `Sink` trait in the `grep2` crate. The searcher (2) ties everything together and finds results using a matcher and reports those results using a `Sink` implementation. Closes #162
2018-04-29 15:29:52 +02:00
members = [
repo: make ripgrep build with the new organization
2020-02-18 01:28:09 +02:00
"crates/globset",
"crates/grep",
"crates/cli",
"crates/matcher",
"crates/pcre2",
"crates/printer",
"crates/regex",
"crates/searcher",
"crates/ignore",
libripgrep: initial commit introducing libripgrep libripgrep is not any one library, but rather, a collection of libraries that roughly separate the following key distinct phases in a grep implementation: 1. Pattern matching (e.g., by a regex engine). 2. Searching a file using a pattern matcher. 3. Printing results. Ultimately, both (1) and (3) are defined by de-coupled interfaces, of which there may be multiple implementations. Namely, (1) is satisfied by the `Matcher` trait in the `grep-matcher` crate and (3) is satisfied by the `Sink` trait in the `grep2` crate. The searcher (2) ties everything together and finds results using a matcher and reports those results using a `Sink` implementation. Closes #162
2018-04-29 15:29:52 +02:00
]
Speeding CI builds
2017-12-19 01:04:49 +02:00
initial commit
2016-02-27 18:07:26 +02:00
[dependencies]
deps: upgrade bstr to 1.1
2023-01-05 15:19:33 +02:00
bstr = "1.1.0"
deps/grep: update minimal versions
2021-06-12 14:08:58 +02:00
grep = { version = "0.2.8", path = "crates/grep" }
deps/ignore: update minimal versions
2021-06-12 14:01:13 +02:00
ignore = { version = "0.4.18", path = "crates/ignore" }
deps: update versions for all crates I don't think every change here is needed, but this ensures we're using the latest version of every direct dependency.
2018-09-07 19:14:31 +02:00
lazy_static = "1.1.0"
log = "0.4.5"
ripgrep: release 12.0.0
2020-03-16 03:38:59 +02:00
regex = "1.3.5"
deps: update versions for all crates I don't think every change here is needed, but this ensures we're using the latest version of every direct dependency.
2018-09-07 19:14:31 +02:00
serde_json = "1.0.23"
ripgrep: release 12.0.0
2020-03-16 03:38:59 +02:00
termcolor = "1.1.0"
globbing by regex
2016-08-26 03:44:37 +02:00
deps: remove vec-map feature from clap This removes the vec-map feature from clap. clap's README claims that vec-map provides a small performance benefit, but I could observe any in ripgrep workloads. The benefit here is that it drops a dependency. Amazingly, this drops whole release build times for ripgrep from 68s to 33s, and debug build time also decreases from 22s to 15.5s. This was entirely unintentional but a welcome surprise.
2018-02-04 04:50:30 +02:00
[dependencies.clap]
ripgrep: release 12.0.0
2020-03-16 03:38:59 +02:00
version = "2.33.0"
deps: remove vec-map feature from clap This removes the vec-map feature from clap. clap's README claims that vec-map provides a small performance benefit, but I could observe any in ripgrep workloads. The benefit here is that it drops a dependency. Amazingly, this drops whole release build times for ripgrep from 68s to 33s, and debug build time also decreases from 22s to 15.5s. This was entirely unintentional but a welcome surprise.
2018-02-04 04:50:30 +02:00
default-features = false
deps: update clap Update clap to the latest version. Also, drop the ansi_term dependency by disabling color output in clap's error messages.
2018-08-22 05:10:34 +02:00
features = ["suggestions"]
deps: remove vec-map feature from clap This removes the vec-map feature from clap. clap's README claims that vec-map provides a small performance benefit, but I could observe any in ripgrep workloads. The benefit here is that it drops a dependency. Amazingly, this drops whole release build times for ripgrep from 68s to 33s, and debug build time also decreases from 22s to 15.5s. This was entirely unintentional but a welcome surprise.
2018-02-04 04:50:30 +02:00
ci: use cross for musl x86_64 builds This is necessary because jemalloc + musl + Ubuntu 16.04 is apparently broken. Moreover, jemalloc doesn't support i686, so we accept the performance regression there. See also: https://github.com/gnzlbg/jemallocator/issues/124
2019-04-25 16:49:59 +02:00
[target.'cfg(all(target_env = "musl", target_pointer_width = "64"))'.dependencies.jemallocator]
deps: upgrade to jemallocator 0.5
2023-01-05 15:33:43 +02:00
version = "0.5.0"
alloc: use jemalloc when building with musl It turns out that musl's allocator is slow enough to cause a fairly noticeable performance regression when ripgrep is built as a static binary with musl. We fix this by using jemalloc when building with musl. We continue to use the default system allocator in all other scenarios. Namely, glibc's allocator doesn't noticeably regress performance compared to jemalloc. But we could add more targets to this logic if other system allocators (macOS, Windows) prove to be slow. This wasn't necessary before because rustc recently stopped using jemalloc by default. Fixes #1268
2019-04-24 23:21:38 +02:00
Switch from Docopt to Clap. There were two important reasons for the switch: 1. Performance. Docopt does poorly when the argv becomes large, which is a reasonable common use case for search tools. (e.g., use with xargs) 2. Better failure modes. Clap knows a lot more about how a particular argv might be invalid, and can therefore provide much clearer error messages. While both were important, (1) made it urgent. Note that since Clap requires at least Rust 1.11, this will in turn increase the minimum Rust version supported by ripgrep from Rust 1.9 to Rust 1.11. It is therefore a breaking change, so the soonest release of ripgrep with Clap will have to be 0.3. There is also at least one subtle breaking change in real usage. Previous to this commit, this used to work: rg -e -foo Where this would cause ripgrep to search for the string `-foo`. Clap currently has problems supporting this use case (see: https://github.com/kbknapp/clap-rs/issues/742), but it can be worked around by using this instead: rg -e [-]foo or even rg [-]foo and this still works: rg -- -foo This commit also adds Bash, Fish and PowerShell completion files to the release, fixes a bug that prevented ripgrep from working on file paths containing invalid UTF-8 and shows short descriptions in the output of `-h` but longer descriptions in the output of `--help`. Fixes #136, Fixes #189, Fixes #210, Fixes #230
2016-11-13 04:48:11 +02:00
[build-dependencies]
deps: update versions for all crates I don't think every change here is needed, but this ensures we're using the latest version of every direct dependency.
2018-09-07 19:14:31 +02:00
lazy_static = "1.1.0"
Switch from Docopt to Clap. There were two important reasons for the switch: 1. Performance. Docopt does poorly when the argv becomes large, which is a reasonable common use case for search tools. (e.g., use with xargs) 2. Better failure modes. Clap knows a lot more about how a particular argv might be invalid, and can therefore provide much clearer error messages. While both were important, (1) made it urgent. Note that since Clap requires at least Rust 1.11, this will in turn increase the minimum Rust version supported by ripgrep from Rust 1.9 to Rust 1.11. It is therefore a breaking change, so the soonest release of ripgrep with Clap will have to be 0.3. There is also at least one subtle breaking change in real usage. Previous to this commit, this used to work: rg -e -foo Where this would cause ripgrep to search for the string `-foo`. Clap currently has problems supporting this use case (see: https://github.com/kbknapp/clap-rs/issues/742), but it can be worked around by using this instead: rg -e [-]foo or even rg [-]foo and this still works: rg -- -foo This commit also adds Bash, Fish and PowerShell completion files to the release, fixes a bug that prevented ripgrep from working on file paths containing invalid UTF-8 and shows short descriptions in the output of `-h` but longer descriptions in the output of `--help`. Fixes #136, Fixes #189, Fixes #210, Fixes #230
2016-11-13 04:48:11 +02:00
deps: remove vec-map feature from clap This removes the vec-map feature from clap. clap's README claims that vec-map provides a small performance benefit, but I could observe any in ripgrep workloads. The benefit here is that it drops a dependency. Amazingly, this drops whole release build times for ripgrep from 68s to 33s, and debug build time also decreases from 22s to 15.5s. This was entirely unintentional but a welcome surprise.
2018-02-04 04:50:30 +02:00
[build-dependencies.clap]
ripgrep: release 12.0.0
2020-03-16 03:38:59 +02:00
version = "2.33.0"
deps: remove vec-map feature from clap This removes the vec-map feature from clap. clap's README claims that vec-map provides a small performance benefit, but I could observe any in ripgrep workloads. The benefit here is that it drops a dependency. Amazingly, this drops whole release build times for ripgrep from 68s to 33s, and debug build time also decreases from 22s to 15.5s. This was entirely unintentional but a welcome surprise.
2018-02-04 04:50:30 +02:00
default-features = false
deps: update clap Update clap to the latest version. Also, drop the ansi_term dependency by disabling color output in clap's error messages.
2018-08-22 05:10:34 +02:00
features = ["suggestions"]
deps: remove vec-map feature from clap This removes the vec-map feature from clap. clap's README claims that vec-map provides a small performance benefit, but I could observe any in ripgrep workloads. The benefit here is that it drops a dependency. Amazingly, this drops whole release build times for ripgrep from 68s to 33s, and debug build time also decreases from 22s to 15.5s. This was entirely unintentional but a welcome surprise.
2018-02-04 04:50:30 +02:00
tests: re-tool integration tests This basically rewrites every integration test. We reduce the amount of magic involved here in terms of which arguments are being passed to ripgrep processes. To make up for the boiler plate saved by the magic, we make the Dir (formerly WorkDir) type a bit nicer to use, along with a new TestCommand that wraps a std::process::Command. In exchange, we get tests that are easier to read and write. We also run every test with the `--pcre2` flag to make sure that works, when PCRE2 is available.
2018-08-07 02:11:58 +02:00
[dev-dependencies]
deps: update versions for all crates I don't think every change here is needed, but this ensures we're using the latest version of every direct dependency.
2018-09-07 19:14:31 +02:00
serde = "1.0.77"
serde_derive = "1.0.77"
tests: add debugging output The transient failures appear to be persisting and they are quite difficult to debug. So include a full directory listing in the output of every test failure.
2020-02-19 14:28:08 +02:00
walkdir = "2"
tests: re-tool integration tests This basically rewrites every integration test. We reduce the amount of magic involved here in terms of which arguments are being passed to ripgrep processes. To make up for the boiler plate saved by the magic, we make the Dir (formerly WorkDir) type a bit nicer to use, along with a new TestCommand that wraps a std::process::Command. In exchange, we get tests that are easier to read and write. We also run every test with the `--pcre2` flag to make sure that works, when PCRE2 is available.
2018-08-07 02:11:58 +02:00
File path filtering works and is pretty fast. I'm pretty disappointed by the performance of regex sets. They are apparently spending a lot of their time in construction of the DFA, which probably means that the DFA is just too big. It turns out that it's actually faster to build an *additional* normal regex with the alternation of every glob and use it as a first-pass filter over every file path. If there's a match, only then do we try the more expensive RegexSet.
2016-08-27 07:01:06 +02:00
[features]
ripgrep: migrate to libripgrep This commit does the work to delete the old `grep` crate and effectively rewrite most of ripgrep core to use the new libripgrep crates. The new `grep` crate is now a facade that collects the various crates that make up libripgrep. The most complex part of ripgrep core is now arguably the translation between command line parameters and the library options, which is ultimately where we want to be.
2018-08-03 23:26:22 +02:00
simd-accel = ["grep/simd-accel"]
pcre2 = ["grep/pcre2"]
File path filtering works and is pretty fast. I'm pretty disappointed by the performance of regex sets. They are apparently spending a lot of their time in construction of the DFA, which probably means that the DFA is just too big. It turns out that it's actually faster to build an *additional* normal regex with the alternation of every glob and use it as a first-pass filter over every file path. If there's a match, only then do we try the more expensive RegexSet.
2016-08-27 07:01:06 +02:00
initial commit
2016-02-27 18:07:26 +02:00
[profile.release]
ripgrep: migrate to libripgrep This commit does the work to delete the old `grep` crate and effectively rewrite most of ripgrep core to use the new libripgrep crates. The new `grep` crate is now a facade that collects the various crates that make up libripgrep. The most complex part of ripgrep core is now arguably the translation between command line parameters and the library options, which is ultimately where we want to be.
2018-08-03 23:26:22 +02:00
debug = 1
release: better support for binary Debian package This commit beefs up the package metadata used by the 'cargo deb' tool to produce a binary dpkg. In particular, we now include ripgrep's man page. This commit includes a new script, 'ci/build_deb.sh', which will handle the build process for a dpkg, which has become a bit more nuanced than just running 'cargo deb'. We don't (yet) run this script in CI. Fixes #842
2018-08-22 03:26:18 +02:00
[package.metadata.deb]
features = ["pcre2"]
deb: add section info Put it in the same section as https://packages.debian.org/stretch/grep PR #1051
2018-09-13 14:17:24 +02:00
section = "utils"
release: better support for binary Debian package This commit beefs up the package metadata used by the 'cargo deb' tool to produce a binary dpkg. In particular, we now include ripgrep's man page. This commit includes a new script, 'ci/build_deb.sh', which will handle the build process for a dpkg, which has become a bit more nuanced than just running 'cargo deb'. We don't (yet) run this script in CI. Fixes #842
2018-08-22 03:26:18 +02:00
assets = [
["target/release/rg", "usr/bin/", "755"],
["COPYING", "usr/share/doc/ripgrep/", "644"],
["LICENSE-MIT", "usr/share/doc/ripgrep/", "644"],
["UNLICENSE", "usr/share/doc/ripgrep/", "644"],
["CHANGELOG.md", "usr/share/doc/ripgrep/CHANGELOG", "644"],
["README.md", "usr/share/doc/ripgrep/README", "644"],
["FAQ.md", "usr/share/doc/ripgrep/FAQ", "644"],
# The man page is automatically generated by ripgrep's build process, so
spelling: fix various misspellings These were found by the check spelling action[1] and reported here[2]. PR #1685 [1] - https://github.com/marketplace/actions/check-spelling [2] - https://github.com/jsoref/ripgrep/commit/6f02d056716a116b643da1de4b53c6f15118fc38#commitcomment-42625778
2020-09-22 16:29:16 +02:00
# this file isn't actually committed. Instead, to create a dpkg, either
deb: add completions This commit adds Bash, zsh and fish completions to the Debian binary package. Fixes #1032
2018-09-07 19:28:57 +02:00
# create a deployment/deb directory and copy the man page to it, or use the
ci: make script names consistent
2020-03-16 02:43:13 +02:00
# 'ci/build-deb' script.
deb: add completions This commit adds Bash, zsh and fish completions to the Debian binary package. Fixes #1032
2018-09-07 19:28:57 +02:00
["deployment/deb/rg.1", "usr/share/man/man1/rg.1", "644"],
# Similarly for shell completions.
["deployment/deb/rg.bash", "usr/share/bash-completion/completions/rg", "644"],
deb: fix fish completion install location It looks like `completions` is owned by Fish itself. Third party completions should go in `vendor_completions.d`. Fixes #1485
2020-02-17 20:33:35 +02:00
["deployment/deb/rg.fish", "usr/share/fish/vendor_completions.d/rg.fish", "644"],
deb: add completions This commit adds Bash, zsh and fish completions to the Debian binary package. Fixes #1032
2018-09-07 19:28:57 +02:00
["deployment/deb/_rg", "usr/share/zsh/vendor-completions/", "644"],
release: better support for binary Debian package This commit beefs up the package metadata used by the 'cargo deb' tool to produce a binary dpkg. In particular, we now include ripgrep's man page. This commit includes a new script, 'ci/build_deb.sh', which will handle the build process for a dpkg, which has become a bit more nuanced than just running 'cargo deb'. We don't (yet) run this script in CI. Fixes #842
2018-08-22 03:26:18 +02:00
]
extended-description = """\
ripgrep (rg) recursively searches your current directory for a regex pattern.
By default, ripgrep will respect your .gitignore and automatically skip hidden
files/directories and binary files.
"""
Reference in New Issue Copy Permalink