summaryrefslogtreecommitdiffstats
path: root/CHANGELOG.md
AgeCommit message (Collapse)Author
2023-11-26changelog: add link for reporting perf improvements/regressionsAndrew Gallant
2023-11-26changelog: updates for the 14.0.0 releaseAndrew Gallant
2023-11-26doc: progressAndrew Gallant
2023-11-25changelog: note that --no-ignore --ignore-vcs works as expectedAndrew Gallant
This fix fell out of the move off of Clap. Closes #1376
2023-11-25doc: clarify errors for -z/--search-zipAndrew Gallant
Fixes #1622
2023-11-25doc: be more explicit about ripgrep's behavior when printing to a ttyAndrew Gallant
Fixes #1709
2023-11-25changelog: mention M2 binaries for releasesAndrew Gallant
Fixes #1737
2023-11-25changelog: mention perf improvement for inner literalsAndrew Gallant
Fixes #1746
2023-11-25cli: error when searching for NULAndrew Gallant
Basically, unless the -a/--text flag is given, it is generally always an error to search for an explicit NUL byte because the binary detection will prevent it from matching. Fixes #1838
2023-11-25doc: clarify that --pre can accept any kind of pathAndrew Gallant
Fixes #2046
2023-11-25doc: improve -r/--replace docsAndrew Gallant
It looks like this was done a while ago, but it didn't get added to the CHANGELOG or connected with the corresponding issue. Fixes #2201
2023-11-25log: add message when a binary file is skippedAndrew Gallant
The way we do this is a little hokey but I believe it is correct. Fixes #2246
2023-11-25doc: add cargo-binstall instructionsAndrew Gallant
Closes #2298
2023-11-25doc: mention that --stats is always implied by --jsonAndrew Gallant
Fixes #2337
2023-11-25doc: add more warnings about --vimgrepAndrew Gallant
The --vimgrep flag has some severe footguns when using a pattern that matches very frequently. We had already written some docs to warn about that, but now we also include a suggestion to avoid exorbitant heap usage. Closes #2505
2023-11-25doc: improve --sort=pathAndrew Gallant
This clarifies that the paths are not sorted in a fully lexicographic order, but that / is treated specially. Fixes #2418
2023-11-25cli: rejigger --version to include PCRE2 infoAndrew Gallant
This adds info about whether PCRE2 is available or not to the output of --version. Essentially, --version now subsumes --pcre2-version, although we do retain the former because it (usefully) emits an exit code based on whether PCRE2 is available or not. Closes #2645
2023-11-25printer: trim before applying max column windowingAndrew Gallant
Previously, we were applying the -M/--max-columns flag *before* triming prefix ASCII whitespace. But this doesn't make a whole lot of sense. We should be trimming first, but the result of trimming is ultimately what we'll be printing and that's what -M/--max-columns should be applied to. Fixes #2458
2023-11-25changelog: mention shell completion generation featureAndrew Gallant
Closes #2425
2023-11-25doc: add docs about .ignore/.rgignore in parent directoriesAndrew Gallant
Closes #2479
2023-11-25changelog: mention --field-match-separator bug fixAndrew Gallant
This was probably fixed in the migration off of Clap. Closes #2519
2023-11-25logging: show heuristic information and decisionAndrew Gallant
When one does not provide any paths to ripgrep to search, it has to guess between searching stdin and the current working directory. It is possible for this guess to be wrong, and having the heuristics and the choice in the debug logs is useful for diagnosing this. The failure mode here is still pretty bad because you need to know to reach for the `--debug` flag in the first place. Namely, the typical failure mode is that ripgrep tries to search stdin while the intent is for it to search the current working directory, and thus likely blocking forever waiting for data on stdin. (Arguably this is a problem with the process architecture that invokes ripgrep. It shouldn't give ripgrep an open stdin handle that isn't closed.) Closes #2524
2023-11-21ignore: Avoid contention on num_pendingTavian Barnes
Previously, every worker would increment the shared num_pending count on every new work item, and decrement it after finishing them, leading to lots of contention. Now, we only track the number of workers actively running, so there is no contention except when workers go to sleep or wake up. Closes #2642
2023-11-21cli: make -d a short flag for --max-depthAndrew Gallant
Interestingly, ripgrep now only has two available ASCII letter short flags remaining: -k and -y. Closes #2643, Closes #2644
2023-11-21changelog: --pretty now behaves more sensiblyAndrew Gallant
This actually just kind of fell out of the migration off of Clap as a result of treating `-p/--pretty` more rigorously as an alias for `--line-number --heading --color always`. Fixes #2381, Closes #2637
2023-11-21ci: strip release binaries on macOSAndrew Gallant
We were purportedly doing this already, but actually weren't because of confusion in the `if` condition. Closes #2636
2023-11-21doc: scrub mentions of asciidoc/asciidoctorAndrew Gallant
This optional dependency is now finally dropped. So ends a long journey of trying to generate man pages in a lightweight and dependable way. The only thing I could figure out how to make work reliably was to just learn how to write roff myself. Yay.
2023-11-20cli: replace clap with lexopt and supporting codeAndrew Gallant
ripgrep began it's life with docopt for argument parsing. Then it moved to Clap and stayed there for a number of years. Clap has served ripgrep well, and it probably could continue to serve ripgrep well, but I ended up deciding to move off of it. Why? The first time I had the thought of moving off of Clap was during the 2->3->4 transition. I thought the 3.x and 4.x releases were great, but for me, it ended up moving a little too quickly. Since the release of 4.x was telegraphed around when 3.x came out, I decided to just hold off and wait to migrate to 4.x instead of doing a 3.x migration followed shortly by another 4.x migration. Of course, I just never ended up doing the migration at all. I never got around to it and there just wasn't a compelling reason for me to upgrade. While I never investigated it, I saw an upgrade as a non-trivial amount of work in part because I didn't encapsulate the usage of Clap enough. The above is just what got me started thinking about it. It wasn't enough to get me to move off of it on its own. What ended up pushing me over the edge was a combination of factors: * As mentioned above, I didn't want to run on the migration treadmill. This has proven to not be much of an issue, but at the time of the 2->3->4 releases, I didn't know how long Clap 4.x would be out before a 5.x would come out. * The release of lexopt[1] caught my eye. IMO, that crate demonstrates exactly how something new can arrive on the scene and just thoroughly solve a problem minimalistically. It has the docs, the reasoning, the simple API, the tests and good judgment. It gets all the weird corner cases right that Clap also gets right (and is part of why I was originally attracted to Clap). * I have an overall desire to reduce the size of my dependency tree. In part because a smaller dependency tree tends to correlate with better compile times, but also in part because it reduces my reliance and trust on others. It lets me be the "master" of ripgrep's destiny by reducing the amount of behavior that is the result of someone else's decision (whether good or bad). * I perceived that Clap solves a more general problem than what I actually need solved. Despite the vast number of flags that ripgrep has, its requirements are actually pretty simple. We just need simple switches and flags that support one value. No multi-value flags. No sub-commands. And probably a lot of other functionality that Clap has that makes it so flexible for so many different use cases. (I'm being hand wavy on the last point.) With all that said, perhaps most importantly, the future of ripgrep possibly demands a more flexible CLI argument parser. In today's world, I would really like, for example, flags like `--type` and `--type-not` to be able to accumulate their repeated values into a single sequence while respecting the order they appear on the CLI. For example, prior to this migration, `rg regex-automata -Tlock -ttoml` would not return results in `Cargo.lock` in this repository because the `-Tlock` always took priority even though `-ttoml` appeared after it. But with this migration, `-ttoml` now correctly overrides `-Tlock`. We would like to do similar things for `-g/--glob` and `--iglob` and potentially even now introduce a `-G/--glob-not` flag instead of requiring users to use `!` to negate a glob. (Which I had done originally to work-around this problem.) And some day, I'd like to add some kind of boolean matching to ripgrep perhaps similar to how `git grep` does it. (Although I haven't thought too carefully on a design yet.) In order to do that, I perceive it would be difficult to implement correctly in Clap. I believe that this last point is possible to implement correctly in Clap 2.x, although it is awkward to do so. I have not looked closely enough at the Clap 4.x API to know whether it's still possible there. In any case, these were enough reasons to move off of Clap and own more of the argument parsing process myself. This did require a few things: * I had to write my own logic for how arguments are combined into one single state object. Of course, I wanted this. This was part of the upside. But it's still code I didn't have to write for Clap. * I had to write my own shell completion generator. * I had to write my own `-h/--help` output generator. * I also had to write my own man page generator. Well, I had to do this with Clap 2.x too, although my understanding is that Clap 4.x supports this. With that said, without having tried it, my guess is that I probably wouldn't have liked the output it generated because I ultimately had to write most of the roff by hand myself to get the man page I wanted. (This also had the benefit of dropping the build dependency on asciidoc/asciidoctor.) While this is definitely a fair bit of extra work, it overall only cost me a couple days. IMO, that's a good trade off given that this code is unlikely to change again in any substantial way. And it should also allow for more flexible semantics going forward. Fixes #884, Fixes #1648, Fixes #1701, Fixes #1814, Fixes #1966 [1]: https://docs.rs/lexopt/0.3.0/lexopt/index.html
2023-11-20ignore: improve 'excludesFile' parsingKento Okamoto
This permits the value to be surrounded in double quotes. It's still not perfect, but probably better than it was. Getting this to be more correct will likely require writing (or using) a real parser, which I'm not particularly incliend to do at present. Fixes #2392, Closes #2629
2023-10-09changelog: add another note about -w/--word-regexp bugsAndrew Gallant
This was fixed a few commits ago when we updated to regex-automata 0.4 (regex 1.10). Fixes #2623
2023-10-09changelog: add perf bug fix for \bAndrew Gallant
Like the previous CHANGELOG entry, this marks a bug that was fixed likely with the introduction of regex 1.9: $ hyperfine "rg-13.0.0 -ic '\bfoo\b \bbar\b' git-3a06386e.txt" "rg -ic '\bfoo\b \bbar\b' git-3a06386e.txt" Benchmark 1: rg-13.0.0 -ic '\bfoo\b \bbar\b' git-3a06386e.txt Time (mean ± σ): 1.034 s ± 0.011 s [User: 1.030 s, System: 0.004 s] Range (min … max): 1.021 s … 1.053 s 10 runs Benchmark 2: rg -ic '\bfoo\b \bbar\b' git-3a06386e.txt Time (mean ± σ): 6.3 ms ± 0.3 ms [User: 4.6 ms, System: 1.6 ms] Range (min … max): 5.6 ms … 7.3 ms 343 runs Summary 'rg -ic '\bfoo\b \bbar\b' git-3a06386e.txt' ran 164.95 ± 7.70 times faster than 'rg-13.0.0 -ic '\bfoo\b \bbar\b' git-3a06386e.txt' This was not fixed by making \b itself faster, but rather, by improving inner literal extraction. In particular, if the regex doesn't have any literals extracted, then search time can still be quite slow: $ time rg-13.0.0 -ic '\b[a-z]{3}\b\s\b[a-z]{3}\b' git-3a06386e.txt 57538 real 0.427 user 0.423 sys 0.003 maxmem 46 MB faults 0 $ time rg -ic '\b[a-z]{3}\b\s\b[a-z]{3}\b' git-3a06386e.txt 57538 real 0.337 user 0.333 sys 0.003 maxmem 46 MB faults 0 But then again, so is grep, because grep doesn't benefit from any literal optimizations either: $ time grep -E -ic '\b[a-z]{3}\b\s\b[a-z]{3}\b' git-3a06386e.txt 62396 real 1.316 user 1.292 sys 0.007 maxmem 13 MB faults 7 The count mismatch should probably be investigated. Fixes #1760
2023-10-09changelog: add bug fix for \bAndrew Gallant
This was probably fixed in a past commit where I bumped the regex engine to 1.9 (or perhaps more precisely, regex-automata 0.3). But I didn't track it as fixed at the time. Fixes #1275
2023-09-20ignore: use work-stealing stack instead of Arc<Mutex<Vec<_>>>Tavian Barnes
This represents yet another iteration on how `ignore` enqueues and distributes work in parallel. The original implementation used a multi-producer/multi-consumer thread safe queue from crossbeam. At some point, I migrated to a simple `Arc<Mutex<Vec<_>>>` and treated it as a stack so that we did depth first traversal. This helped with memory usage in very wide directories. But it turns out that a naive stack-behind-a-mutex can be quite a bit slower than something that's a little smarter, such as a work-stealing stack used in this commit. My hypothesis for why this helps is that without the stealing component, work distribution can get stuck in sub-optimal configurations that depend on which directory entries get assigned to a particular worker. It's likely that this can result in some workers getting "more" work than others, just by chance, and thus remain idle. But the work-stealing approach heads that off. This does re-introduce a dependency on parts of crossbeam which is kind of a bummer, but it's carrying its weight for now. Closes #1823, Closes #2591 Ref https://github.com/sharkdp/fd/issues/28
2023-09-20ignore: fix filtering when searching subdirectoriesThilo Uttendorfer
When searching subdirectories the path was not correctly built and included duplicate parts. This fix will remove the duplicate part if possible. Fixes #1757, Closes #2295
2023-08-21ignore/types: add Prolog file typesmataha
This improves the Prolog file type rules. * `.pl` is the most common extension in the wild, though `.pro` is preferred in places where file extension may clash with Perl[1]. * `.P` is used for compatibility with XSB Prolog dialect[2]. PR #2590 [1]: https://www.swi-prolog.org/pldoc/man?section=fileext [2]: https://www.swi-prolog.org/pldoc/man?section=xsb-source
2023-08-20ignore/types: tweak Gradle file typesmataha
This PR extends Gradle file types with the following: - Kotlin DSL buildscripts (`*.gradle.kts`) - Gradle Java properties (`gradle.properties`) - wrapper files (`gradle-wrapper.*`) - wrapper scripts (`gradlew`, `gradlew.bat`) PR #2587
2023-07-31regex: fix fast path for -w/--word-regexp flag (#2576)Andrew Gallant
It turns out our fast path for -w/--word-regexp wasn't quite correct in some cases. Namely, we use `(?m:^|\W)(<original-regex>)(?m:\W|$)` as the implementation of -w/--word-regexp since `\b(<original-regex>)\b` has some unintuitive results in certain cases, specifically when <original-regex> matches non-word characters at match boundaries. The problem is that using this formulation means that you need to extract the capture group around <original-regex> to find the "real" match, since the surrounding (^|\W) and (\W|$) aren't part of the match. This is fine, but the capture group engine is usually slow, so we have a fast path where we try to deduce the correct match boundary after an initial match (before running capture groups). The problem is that doing this is rather tricky because it's hard to know, in general, whether the `^` or the `\W` matched. This still doesn't seem quite right overall, but we at least fix one more case. Fixes #2574
2023-07-09cli: fix non-path sorting behaviornguyenvukhang
Previously, sorting worked by sorting the parents and then sorting the children within each parent. This was done during traversal, but it only works when sorting parents preserves the overall order. This generally only works for '--sort path' in ascending order. This commit fixes the rest of the sorting behavior by collecting all of the paths to search and then sorting them before searching. We only collect all of the paths when sorting was requested. Fixes #2243, Closes #2361
2023-07-08cli: add --stop-on-nonmatch flagEdoardo Pirovano
This causes ripgrep to stop searching an individual file after it has found a non-matching line. But this only occurs after it has found a matching line. Fixes #1790, Closes #1930
2023-07-08doc: improve -r/--replace flag syntax docsKyle Todeschini
Fixes #2108, Closes #2123
2023-07-08ignore/types: add 'typescript' alias for 'ts'Klas Mellbourn
Closes #2009
2023-07-08ignore/types: add Ada filetypes, including gprbuild and alireTama McGlinn
*.adb and *.ads are the usual extensions for Ada source code, and *.gpr indicates a GPRbuild project file used for Ada, and these days often being combined with alire for package dependency resolution. Alire stores a bunch of files named alire.toml in different directories in your (gitignored) cache/dependencies/... Closes #2013
2023-07-08ignore/types: add raku extensions to ignore typesJuan Francisco Cantero Hurtado
Closes #2117
2023-07-08ignore/types: add MDX format to Markdown typesAndrew Gallant
Ref https://mdxjs.com/ Closes #2142
2023-07-08ignore/types: add DITA (Darwin Information Typing Architecture)chrispy
Closes #2148
2023-07-08complete: add extra-verbose support to _rg_typesdana
When the extra-verbose style is set for the types tag, completed types are displayed along with the patterns they correspond to. This can be enabled by e.g. adding the following to .zshrc: zstyle ':completion:*:rg:*:types' extra-verbose true This change also makes _rg_types use the actual rg specified on the command line to look up types, and it fixes a mangled complete-all style check Fixes #2195
2023-07-08cli: '--no-ignore-dot' should also '.rgignore'Richard Sternagel
Fixes #2198, Closes #2202
2023-07-08ignore/types: added V typeedam
V (http://vlang.io) uses '.v' files. Closes #2302
2023-07-08readme: add winget installation sectionsitiom
Closes #2409
2023-07-08ignore/types: add USD to the default file typesMark Sisson
Closes #2432