Merge branch 'master' of https://github.com/burntsushi/ripgrep

Author: aswild

.cargo/config.toml

@@ -0,0 +1,8 @@
+# On Windows MSVC, statically link the C runtime so that the resulting EXE does
+# not depend on the vcruntime DLL.
+#
+# See: https://github.com/BurntSushi/ripgrep/pull/1613
+[target.x86_64-pc-windows-msvc]
+rustflags = ["-C", "target-feature=+crt-static"]
+[target.i686-pc-windows-msvc]
+rustflags = ["-C", "target-feature=+crt-static"]

.github/ISSUE_TEMPLATE/feature_request.md

@@ -15,3 +15,6 @@ examples of how ripgrep would be used if your feature request were added.
 If you're not sure what to write here, then try imagining what the ideal
 documentation of your new feature would look like in ripgrep's man page. Then
 try to write it.
+
+If you're requesting the addition or change of default file types, please open
+a PR. We can discuss it there if necessary.

.github/workflows/ci.yml

@@ -43,7 +43,7 @@ jobs:
         include:
         - build: pinned
           os: ubuntu-18.04
-          rust: 1.41.0
+          rust: 1.52.1
         - build: stable
           os: ubuntu-18.04
           rust: stable
@@ -118,10 +118,10 @@ jobs:
         echo "target flag is: ${{ env.TARGET_FLAGS }}"
 
     - name: Build ripgrep and all crates
-      run: ${{ env.CARGO }} build --verbose --all ${{ env.TARGET_FLAGS }}
+      run: ${{ env.CARGO }} build --verbose --workspace ${{ env.TARGET_FLAGS }}
 
     - name: Build ripgrep with PCRE2
-      run: ${{ env.CARGO }} build --verbose --all --features pcre2 ${{ env.TARGET_FLAGS }}
+      run: ${{ env.CARGO }} build --verbose --workspace --features pcre2 ${{ env.TARGET_FLAGS }}
 
     # This is useful for debugging problems when the expected build artifacts
     # (like shell completions and man pages) aren't generated.
@@ -139,15 +139,15 @@ jobs:
 
     - name: Run tests with PCRE2 (sans cross)
       if: matrix.target == ''
-      run: ${{ env.CARGO }} test --verbose --all --features pcre2 ${{ env.TARGET_FLAGS }}
+      run: ${{ env.CARGO }} test --verbose --workspace --features pcre2 ${{ env.TARGET_FLAGS }}
 
     - name: Run tests without PCRE2 (with cross)
       # These tests should actually work, but they almost double the runtime.
       # Every integration test spins up qemu to run 'rg', and when PCRE2 is
       # enabled, every integration test is run twice: one with the default
       # regex engine and once with PCRE2.
       if: matrix.target != ''
-      run: ${{ env.CARGO }} test --verbose --all ${{ env.TARGET_FLAGS }}
+      run: ${{ env.CARGO }} test --verbose --workspace ${{ env.TARGET_FLAGS }}
 
     - name: Test for existence of build artifacts (Windows)
       if: matrix.os == 'windows-2019'
@@ -194,3 +194,20 @@ jobs:
     - name: Check formatting
       run: |
         cargo fmt --all -- --check
+
+  docs:
+    name: Docs
+    runs-on: ubuntu-20.04
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v2
+      - name: Install Rust
+        uses: actions-rs/toolchain@v1
+        with:
+          toolchain: stable
+          profile: minimal
+          override: true
+      - name: Check documentation
+        env:
+          RUSTDOCFLAGS: -D warnings
+        run: cargo doc --no-deps --document-private-items --workspace

.github/workflows/release.yml

@@ -1,43 +1,46 @@
-# The way this works is a little weird. But basically, the create-release job
-# runs purely to initialize the GitHub release itself. Once done, the upload
-# URL of the release is saved as an artifact.
+# The way this works is the following:
 #
-# The build-release job runs only once create-release is finished. It gets
-# the release upload URL by downloading the corresponding artifact (which was
-# uploaded by create-release). It then builds the release executables for each
-# supported platform and attaches them as release assets to the previously
-# created release.
+# The create-release job runs purely to initialize the GitHub release itself
+# and to output upload_url for the following job.
+#
+# The build-release job runs only once create-release is finished. It gets the
+# release upload URL from create-release job outputs, then builds the release
+# executables for each supported platform and attaches them as release assets
+# to the previously created release.
 #
 # The key here is that we create the release only once.
+#
+# Reference:
+# https://eugene-babichenko.github.io/blog/2020/05/09/github-actions-cross-platform-auto-releases/
 
 name: release
 on:
   push:
     # Enable when testing release infrastructure on a branch.
     # branches:
-    # - ag/release
+    # - ag/work
     tags:
-    - '[0-9]+.[0-9]+.[0-9]+'
+    - "[0-9]+.[0-9]+.[0-9]+"
 jobs:
   create-release:
     name: create-release
     runs-on: ubuntu-latest
     # env:
       # Set to force version number, e.g., when no tag exists.
       # RG_VERSION: TEST-0.0.0
+    outputs:
+      upload_url: ${{ steps.release.outputs.upload_url }}
+      rg_version: ${{ env.RG_VERSION }}
     steps:
-      - name: Create artifacts directory
-        run: mkdir artifacts
-
       - name: Get the release version from the tag
+        shell: bash
         if: env.RG_VERSION == ''
         run: |
           # Apparently, this is the right way to get a tag name. Really?
           #
           # See: https://github.community/t5/GitHub-Actions/How-to-get-just-the-tag-name/m-p/32167/highlight/true#M1027
           echo "RG_VERSION=${GITHUB_REF#refs/tags/}" >> $GITHUB_ENV
           echo "version is: ${{ env.RG_VERSION }}"
-
       - name: Create GitHub release
         id: release
         uses: actions/create-release@v1
@@ -47,18 +50,6 @@ jobs:
           tag_name: ${{ env.RG_VERSION }}
           release_name: ${{ env.RG_VERSION }}
 
-      - name: Save release upload URL to artifact
-        run: echo "${{ steps.release.outputs.upload_url }}" > artifacts/release-upload-url
-
-      - name: Save version number to artifact
-        run: echo "${{ env.RG_VERSION }}" > artifacts/release-version
-
-      - name: Upload artifacts
-        uses: actions/upload-artifact@v1
-        with:
-          name: artifacts
-          path: artifacts
-
   build-release:
     name: build-release
     needs: ['create-release']
@@ -68,7 +59,7 @@ jobs:
       # systems.
       CARGO: cargo
       # When CARGO is set to CROSS, this is set to `--target matrix.target`.
-      TARGET_FLAGS:
+      TARGET_FLAGS: ""
       # When CARGO is set to CROSS, TARGET_DIR includes matrix.target.
       TARGET_DIR: ./target
       # Emit backtraces on panics.
@@ -129,7 +120,7 @@ jobs:
         target: ${{ matrix.target }}
 
     - name: Use Cross
-      # if: matrix.os != 'windows-2019'
+      shell: bash
       run: |
         cargo install cross
         echo "CARGO=cross" >> $GITHUB_ENV
@@ -142,22 +133,6 @@ jobs:
         echo "target flag is: ${{ env.TARGET_FLAGS }}"
         echo "target dir is: ${{ env.TARGET_DIR }}"
 
-    - name: Get release download URL
-      uses: actions/download-artifact@v1
-      with:
-        name: artifacts
-        path: artifacts
-
-    - name: Set release upload URL and release version
-      shell: bash
-      run: |
-        release_upload_url="$(cat artifacts/release-upload-url)"
-        echo "RELEASE_UPLOAD_URL=$release_upload_url" >> $GITHUB_ENV
-        echo "release upload url: $RELEASE_UPLOAD_URL"
-        release_version="$(cat artifacts/release-version)"
-        echo "RELEASE_VERSION=$release_version" >> $GITHUB_ENV
-        echo "release version: $RELEASE_VERSION"
-
     - name: Build release binary
       run: ${{ env.CARGO }} build --verbose --release --features pcre2 ${{ env.TARGET_FLAGS }}
 
@@ -178,7 +153,7 @@ jobs:
       shell: bash
       run: |
         outdir="$(ci/cargo-out-dir "${{ env.TARGET_DIR }}")"
-        staging="ripgrep-${{ env.RELEASE_VERSION }}-${{ matrix.target }}"
+        staging="ripgrep-${{ needs.create-release.outputs.rg_version }}-${{ matrix.target }}"
         mkdir -p "$staging"/{complete,doc}
 
         cp {README.md,COPYING,UNLICENSE,LICENSE-MIT} "$staging/"
@@ -203,7 +178,7 @@ jobs:
       env:
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
       with:
-        upload_url: ${{ env.RELEASE_UPLOAD_URL }}
+        upload_url: ${{ needs.create-release.outputs.upload_url }}
         asset_path: ${{ env.ASSET }}
         asset_name: ${{ env.ASSET }}
         asset_content_type: application/octet-stream

CHANGELOG.md

@@ -1,6 +1,26 @@
 TBD
 ===
-Unreleased changes. Release notes have not yet been written.
+ripgrep 13 is a new major version release of ripgrep that primarily contains
+bug fixes. There is also a fix for a security vulnerability on Windows
+([CVE-2021-3013](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-3013)),
+some performance improvements and some minor breaking changes.
+
+A new short flag, `-.`, has been added. It is an alias for the `--hidden` flag,
+which instructs ripgrep to search hidden files and directories.
+
+ripgrep is now using a new
+[vectorized implementation of `memmem`](https://github.com/BurntSushi/memchr/pull/82),
+which accelerates many common searches. If you notice any performance
+regressions (or major improvements), I'd love to hear about them through an
+issue report!
+
+Also, for Windows users targeting MSVC, Cargo will now build fully static
+executables of ripgrep. The release binaries for ripgrep 13 have been compiled
+using this configuration.
+
+**BREAKING CHANGES**:
+
+**Binary detection output has changed slightly.**
 
 In this release, a small tweak has been made to the output format when a binary
 file is detected. Previously, it looked like this:
@@ -15,12 +35,100 @@ Now it looks like this:
 FOO: binary file matches (found "\0" byte around offset XXX)
 ```
 
+**vimgrep output in multi-line now only prints the first line for each match.**
+
+See [issue 1866](https://github.com/BurntSushi/ripgrep/issues/1866) for more
+discussion on this. Previously, every line in a match was duplicated, even
+when it spanned multiple lines. There are no changes to vimgrep output when
+multi-line mode is disabled.
+
+**In multi-line mode, --count is now equivalent to --count-matches.**
+
+This appears to match how `pcre2grep` implements `--count`. Previously, ripgrep
+would produce outright incorrect counts. Another alternative would be to simply
+count the number of lines---even if it's more than the number of matches---but
+that seems highly unintuitive.
+
+**FULL LIST OF FIXES AND IMPROVEMENTS:**
+
+Security fixes:
+
+* [CVE-2021-3013](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-3013):
+  Fixes a security hole on Windows where running ripgrep with either the
+  `-z/--search-zip` or `--pre` flags can result in running arbitrary
+  executables from the current directory.
+* [VULN #1773](https://github.com/BurntSushi/ripgrep/issues/1773):
+  This is the public facing issue tracking CVE-2021-3013. ripgrep's README
+  now contains a section describing how to report a vulnerability.
+
+Performance improvements:
+
+* [PERF #1657](https://github.com/BurntSushi/ripgrep/discussions/1657):
+  Check if a file should be ignored first before issuing stat calls.
+* [PERF memchr#82](https://github.com/BurntSushi/memchr/pull/82):
+  ripgrep now uses a new vectorized implementation of `memmem`.
+
+Feature enhancements:
+
+* Added or improved file type filtering for ASP, Bazel, dvc, FlatBuffers,
+  Futhark, minified files, Mint, pofiles (from GNU gettext) Racket, Red, Ruby,
+  VCL, Yang.
+* [FEATURE #1404](https://github.com/BurntSushi/ripgrep/pull/1404):
+  ripgrep now prints a warning if nothing is searched.
+* [FEATURE #1613](https://github.com/BurntSushi/ripgrep/pull/1613):
+  Cargo will now produce static executables on Windows when using MSVC.
+* [FEATURE #1680](https://github.com/BurntSushi/ripgrep/pull/1680):
+  Add `-.` as a short flag alias for `--hidden`.
+* [FEATURE #1842](https://github.com/BurntSushi/ripgrep/issues/1842):
+  Add `--field-{context,match}-separator` for customizing field delimiters.
+* [FEATURE #1856](https://github.com/BurntSushi/ripgrep/pull/1856):
+  The README now links to a
+  [Spanish translation](https://github.com/UltiRequiem/traducciones/tree/master/ripgrep).
+
 Bug fixes:
 
 * [BUG #1277](https://github.com/BurntSushi/ripgrep/issues/1277):
   Document cygwin path translation behavior in the FAQ.
+* [BUG #1739](https://github.com/BurntSushi/ripgrep/issues/1739):
+  Fix bug where replacements were buggy if the regex matched a line terminator.
+* [BUG #1311](https://github.com/BurntSushi/ripgrep/issues/1311):
+  Fix multi-line bug where a search & replace for `\n` didn't work as expected.
+* [BUG #1401](https://github.com/BurntSushi/ripgrep/issues/1401):
+  Fix buggy interaction between PCRE2 look-around and `-o/--only-matching`.
+* [BUG #1412](https://github.com/BurntSushi/ripgrep/issues/1412):
+  Fix multi-line bug with searches using look-around past matching lines.
+* [BUG #1577](https://github.com/BurntSushi/ripgrep/issues/1577):
+  Fish shell completions will continue to be auto-generated.
+* [BUG #1642](https://github.com/BurntSushi/ripgrep/issues/1642):
+  Fixes a bug where using `-m` and `-A` printed more matches than the limit.
+* [BUG #1703](https://github.com/BurntSushi/ripgrep/issues/1703):
+  Clarify the function of `-u/--unrestricted`.
+* [BUG #1708](https://github.com/BurntSushi/ripgrep/issues/1708):
+  Clarify how `-S/--smart-case` works.
+* [BUG #1730](https://github.com/BurntSushi/ripgrep/issues/1730):
+  Clarify that CLI invocation must always be valid, regardless of config file.
 * [BUG #1741](https://github.com/BurntSushi/ripgrep/issues/1741):
   Fix stdin detection when using PowerShell in UNIX environments.
+* [BUG #1756](https://github.com/BurntSushi/ripgrep/pull/1756):
+  Fix bug where `foo/**` would match `foo`, but it shouldn't.
+* [BUG #1765](https://github.com/BurntSushi/ripgrep/issues/1765):
+  Fix panic when `--crlf` is used in some cases.
+* [BUG #1638](https://github.com/BurntSushi/ripgrep/issues/1638):
+  Correctly sniff UTF-8 and do transcoding, like we do for UTF-16.
+* [BUG #1816](https://github.com/BurntSushi/ripgrep/issues/1816):
+  Add documentation for glob alternate syntax, e.g., `{a,b,..}`.
+* [BUG #1847](https://github.com/BurntSushi/ripgrep/issues/1847):
+  Clarify how the `--hidden` flag works.
+* [BUG #1866](https://github.com/BurntSushi/ripgrep/issues/1866#issuecomment-841635553):
+  Fix bug when computing column numbers in `--vimgrep` mode.
+* [BUG #1868](https://github.com/BurntSushi/ripgrep/issues/1868):
+  Fix bug where `--passthru` and `-A/-B/-C` did not override each other.
+* [BUG #1869](https://github.com/BurntSushi/ripgrep/pull/1869):
+  Clarify docs for `--files-with-matches` and `--files-without-match`.
+* [BUG #1878](https://github.com/BurntSushi/ripgrep/issues/1878):
+  Fix bug where `\A` could produce unanchored matches in multiline search.
+* [BUG 94e4b8e3](https://github.com/BurntSushi/ripgrep/commit/94e4b8e3):
+  Fix column numbers with `--vimgrep` is used with `-U/--multiline`.
 
 
 12.1.1 (2020-05-29)