Bump version to v0.24.0

We need to bump 0.x.0 because the library API changed in incompatible
ways:

    $ cargo public-api diff
    Resolved `diff` to `diff 0.23.0`
    Removed items from the public API
    =================================
    (none)

    Changed items in the public API
    ===============================
    -pub fn bat::controller::Controller<'b>::run(&self, inputs: alloc::vec::Vec<bat::input::Input<'_>>) -> bat::error::Result<bool>
    +pub fn bat::controller::Controller<'b>::run(&self, inputs: alloc::vec::Vec<bat::input::Input<'_>>, output_buffer: core::option::Option<&mut dyn core::fmt::Write>) -> bat::error::Result<bool>
    -pub fn bat::controller::Controller<'b>::run_with_error_handler(&self, inputs: alloc::vec::Vec<bat::input::Input<'_>>, handle_error: impl core::ops::function::Fn(&bat::error::Error, &mut dyn std::io::Write)) -> bat::error::Result<bool>
    +pub fn bat::controller::Controller<'b>::run_with_error_handler(&self, inputs: alloc::vec::Vec<bat::input::Input<'_>>, output_buffer: core::option::Option<&mut dyn core::fmt::Write>, handle_error: impl core::ops::function::Fn(&bat::error::Error, &mut dyn std::io::Write)) -> bat::error::Result<bool>

    Added items to the public API
    =============================
    [...]

.github/dependabot.yml

@@ -16,3 +16,9 @@ updates:
     interval: monthly
     time: "04:00"
     timezone: Europe/Berlin
+- package-ecosystem: "github-actions"
+  directory: "/"
+  schedule:
+    interval: monthly
+    time: "04:00"
+    timezone: Europe/Berlin

.github/workflows/CICD.yml

@@ -1,8 +1,8 @@
 name: CICD
 
 env:
-  MIN_SUPPORTED_RUST_VERSION: "1.60.0"
   CICD_INTERMEDIATES_DIR: "_cicd-intermediates"
+  MSRV_FEATURES: --no-default-features --features minimal-application,bugreport,build-assets
 
 on:
   workflow_dispatch:
@@ -14,91 +14,100 @@ on:
       - '*'
 
 jobs:
+  all-jobs:
+    if: always() # Otherwise this job is skipped if the matrix job fails
+    name: all-jobs
+    runs-on: ubuntu-latest
+    needs:
+      - crate_metadata
+      - ensure_cargo_fmt
+      - min_version
+      - license_checks
+      - test_with_new_syntaxes_and_themes
+      - test_with_system_config
+      - documentation
+      - cargo-audit
+      - build
+    steps:
+      - run: jq --exit-status 'all(.result == "success")' <<< '${{ toJson(needs) }}'
+
+  crate_metadata:
+    name: Extract crate metadata
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - name: Extract crate information
+      id: crate_metadata
+      run: |
+        cargo metadata --no-deps --format-version 1 | jq -r '"name=" + .packages[0].name' | tee -a $GITHUB_OUTPUT
+        cargo metadata --no-deps --format-version 1 | jq -r '"version=" + .packages[0].version' | tee -a $GITHUB_OUTPUT
+        cargo metadata --no-deps --format-version 1 | jq -r '"maintainer=" + .packages[0].authors[0]' | tee -a $GITHUB_OUTPUT
+        cargo metadata --no-deps --format-version 1 | jq -r '"homepage=" + .packages[0].homepage' | tee -a $GITHUB_OUTPUT
+        cargo metadata --no-deps --format-version 1 | jq -r '"msrv=" + .packages[0].rust_version' | tee -a $GITHUB_OUTPUT
+    outputs:
+      name: ${{ steps.crate_metadata.outputs.name }}
+      version: ${{ steps.crate_metadata.outputs.version }}
+      maintainer: ${{ steps.crate_metadata.outputs.maintainer }}
+      homepage: ${{ steps.crate_metadata.outputs.homepage }}
+      msrv: ${{ steps.crate_metadata.outputs.msrv }}
+
   ensure_cargo_fmt:
     name: Ensure 'cargo fmt' has been run
     runs-on: ubuntu-20.04
     steps:
-    - uses: actions-rs/toolchain@v1
+    - uses: dtolnay/rust-toolchain@stable
       with:
-        toolchain: stable
-        default: true
-        profile: minimal
         components: rustfmt
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
     - run: cargo fmt -- --check
 
+  min_version:
+    name: Minimum supported rust version
+    runs-on: ubuntu-20.04
+    needs: crate_metadata
+    steps:
+    - name: Checkout source code
+      uses: actions/checkout@v4
+
+    - name: Install rust toolchain (v${{ needs.crate_metadata.outputs.msrv }})
+      uses: dtolnay/rust-toolchain@master
+      with:
+        toolchain: ${{ needs.crate_metadata.outputs.msrv }}
+        components: clippy
+    - name: Run clippy (on minimum supported rust version to prevent warnings we can't fix)
+      run: cargo clippy --locked --all-targets ${{ env.MSRV_FEATURES }}
+    - name: Run tests
+      run: cargo test --locked ${{ env.MSRV_FEATURES }}
+
   license_checks:
     name: License checks
     runs-on: ubuntu-20.04
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
       with:
         submodules: true # we especially want to perform license checks on submodules
     - run: tests/scripts/license-checks.sh
 
-  min_version:
-    name: Minimum supported rust version
-    runs-on: ubuntu-20.04
-    env:
-      MSRV_FEATURES: --no-default-features --features minimal-application,bugreport,build-assets
-    steps:
-    - name: Checkout source code
-      uses: actions/checkout@v2
-
-    - name: Install rust toolchain (v${{ env.MIN_SUPPORTED_RUST_VERSION }})
-      uses: actions-rs/toolchain@v1
-      with:
-        toolchain: ${{ env.MIN_SUPPORTED_RUST_VERSION }}
-        default: true
-        profile: minimal # minimal component installation (ie, no documentation)
-        components: clippy
-    - name: Run clippy (on minimum supported rust version to prevent warnings we can't fix)
-      uses: actions-rs/cargo@v1
-      with:
-        command: clippy
-        args: --locked --all-targets ${{ env.MSRV_FEATURES }}
-    - name: Run tests
-      uses: actions-rs/cargo@v1
-      with:
-        command: test
-        args: --locked ${{ env.MSRV_FEATURES }}
-
   test_with_new_syntaxes_and_themes:
     name: Run tests with updated syntaxes and themes
     runs-on: ubuntu-20.04
     steps:
     - name: Git checkout
-      uses: actions/checkout@v2
+      uses: actions/checkout@v4
       with:
         submodules: true # we need all syntax and theme submodules
     - name: Install Rust toolchain
-      uses: actions-rs/toolchain@v1
-      with:
-        toolchain: stable
-        default: true
-        profile: minimal
+      uses: dtolnay/rust-toolchain@stable
     - name: Build and install bat
-      uses: actions-rs/cargo@v1
-      with:
-        command: install
-        args: --locked --path .
+      run: cargo install --locked --path .
     - name: Rebuild binary assets (syntaxes and themes)
       run: bash assets/create.sh
     - name: Build and install bat with updated assets
-      uses: actions-rs/cargo@v1
-      with:
-        command: install
-        args: --locked --path .
+      run: cargo install --locked --path .
     - name: Run unit tests with new syntaxes and themes
-      uses: actions-rs/cargo@v1
-      with:
-        command: test
-        args: --locked --release
+      run: cargo test --locked --release
     - name: Run ignored-by-default unit tests with new syntaxes and themes
-      uses: actions-rs/cargo@v1
-      with:
-        command: test
-        args: --locked --release --test assets -- --ignored
+      run: cargo test --locked --release --test assets -- --ignored
     - name: Syntax highlighting regression test
       run: tests/syntax-tests/regression_test.sh
     - name: List of languages
@@ -113,62 +122,43 @@ jobs:
     runs-on: ubuntu-20.04
     steps:
     - name: Git checkout
-      uses: actions/checkout@v2
+      uses: actions/checkout@v4
     - name: Prepare environment variables
       run: |
         echo "BAT_SYSTEM_CONFIG_PREFIX=$GITHUB_WORKSPACE/tests/examples/system_config" >> $GITHUB_ENV
     - name: Install Rust toolchain
-      uses: actions-rs/toolchain@v1
-      with:
-        toolchain: stable
-        default: true
-        profile: minimal
+      uses: dtolnay/rust-toolchain@stable
     - name: Build and install bat
-      uses: actions-rs/cargo@v1
-      with:
-        command: install
-        args: --locked --path .
+      run: cargo install --locked --path .
     - name: Run unit tests
-      uses: actions-rs/cargo@v1
-      with:
-        command: test
-        args: --locked --test system_wide_config -- --ignored
+      run: cargo test --locked --test system_wide_config -- --ignored
 
   documentation:
     name: Documentation
     runs-on: ubuntu-20.04
     steps:
     - name: Git checkout
-      uses: actions/checkout@v2
+      uses: actions/checkout@v4
     - name: Install Rust toolchain
-      uses: actions-rs/toolchain@v1
-      with:
-        toolchain: stable
-        default: true
-        profile: minimal
-    - name: Print -h
-      uses: actions-rs/cargo@v1
-      with:
-        command: run
-        args: --locked -- -h
-    - name: Print --help
-      uses: actions-rs/cargo@v1
-      with:
-        command: run
-        args: --locked -- --help
-    - name: Show man page
-      run: man $(find . -name bat.1)
+      uses: dtolnay/rust-toolchain@stable
     - name: Check documentation
       env:
         RUSTDOCFLAGS: -D warnings
-      uses: actions-rs/cargo@v1
-      with:
-        command: doc
-        args: --locked --no-deps --document-private-items --all-features
+      run: cargo doc --locked --no-deps --document-private-items --all-features
+    - name: Show man page
+      run: man $(find . -name bat.1)
+
+  cargo-audit:
+    name: cargo audit
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - run: cargo audit
 
   build:
     name: ${{ matrix.job.target }} (${{ matrix.job.os }})
     runs-on: ${{ matrix.job.os }}
+    needs: crate_metadata
     strategy:
       fail-fast: false
       matrix:
@@ -179,14 +169,16 @@ jobs:
           - { target: i686-pc-windows-msvc        , os: windows-2019                  }
           - { target: i686-unknown-linux-gnu      , os: ubuntu-20.04, use-cross: true }
           - { target: i686-unknown-linux-musl     , os: ubuntu-20.04, use-cross: true }
-          - { target: x86_64-apple-darwin         , os: macos-10.15                   }
+          - { target: x86_64-apple-darwin         , os: macos-12                      }
           - { target: x86_64-pc-windows-gnu       , os: windows-2019                  }
           - { target: x86_64-pc-windows-msvc      , os: windows-2019                  }
           - { target: x86_64-unknown-linux-gnu    , os: ubuntu-20.04, use-cross: true }
           - { target: x86_64-unknown-linux-musl   , os: ubuntu-20.04, use-cross: true }
+    env:
+      BUILD_CMD: cargo
     steps:
     - name: Checkout source code
-      uses: actions/checkout@v2
+      uses: actions/checkout@v4
 
     - name: Install prerequisites
       shell: bash
@@ -196,21 +188,21 @@ jobs:
           aarch64-unknown-linux-gnu) sudo apt-get -y update ; sudo apt-get -y install gcc-aarch64-linux-gnu ;;
         esac
 
-    - name: Extract crate information
-      shell: bash
-      run: |
-        echo "PROJECT_NAME=$(sed -n 's/^name = "\(.*\)"/\1/p' Cargo.toml | head -n1)" >> $GITHUB_ENV
-        echo "PROJECT_VERSION=$(sed -n 's/^version = "\(.*\)"/\1/p' Cargo.toml | head -n1)" >> $GITHUB_ENV
-        echo "PROJECT_MAINTAINER=$(sed -n 's/^authors = \["\(.*\)"\]/\1/p' Cargo.toml)" >> $GITHUB_ENV
-        echo "PROJECT_HOMEPAGE=$(sed -n 's/^homepage = "\(.*\)"/\1/p' Cargo.toml)" >> $GITHUB_ENV
-
     - name: Install Rust toolchain
-      uses: actions-rs/toolchain@v1
+      uses: dtolnay/rust-toolchain@stable
       with:
-        toolchain: stable
-        target: ${{ matrix.job.target }}
-        override: true
-        profile: minimal # minimal component installation (ie, no documentation)
+        targets: ${{ matrix.job.target }}
+
+    - name: Install cross
+      if: matrix.job.use-cross
+      uses: taiki-e/install-action@v2
+      with:
+        tool: cross
+
+    - name: Overwrite build command env variable
+      if: matrix.job.use-cross
+      shell: bash
+      run: echo "BUILD_CMD=cross" >> $GITHUB_ENV
 
     - name: Show version information (Rust, cargo, GCC)
       shell: bash
@@ -223,14 +215,11 @@ jobs:
         rustc -V
 
     - name: Build
-      uses: actions-rs/cargo@v1
-      with:
-        use-cross: ${{ matrix.job.use-cross }}
-        command: build
-        args: --locked --release --target=${{ matrix.job.target }}
+      shell: bash
+      run: $BUILD_CMD build --locked --release --target=${{ matrix.job.target }}
 
-    - name: Strip debug information from executable
-      id: strip
+    - name: Set binary name & path
+      id: bin
       shell: bash
       run: |
         # Figure out suffix of binary
@@ -239,31 +228,13 @@ jobs:
           *-pc-windows-*) EXE_suffix=".exe" ;;
         esac;
 
-        # Figure out what strip tool to use if any
-        STRIP="strip"
-        case ${{ matrix.job.target }} in
-          arm-unknown-linux-*) STRIP="arm-linux-gnueabihf-strip" ;;
-          aarch64-unknown-linux-gnu) STRIP="aarch64-linux-gnu-strip" ;;
-          *-pc-windows-msvc) STRIP="" ;;
-        esac;
-
         # Setup paths
-        BIN_DIR="${{ env.CICD_INTERMEDIATES_DIR }}/stripped-release-bin/"
-        mkdir -p "${BIN_DIR}"
-        BIN_NAME="${{ env.PROJECT_NAME }}${EXE_suffix}"
-        BIN_PATH="${BIN_DIR}/${BIN_NAME}"
+        BIN_NAME="${{ needs.crate_metadata.outputs.name }}${EXE_suffix}"
+        BIN_PATH="target/${{ matrix.job.target }}/release/${BIN_NAME}"
 
-        # Copy the release build binary to the result location
-        cp "target/${{ matrix.job.target }}/release/${BIN_NAME}" "${BIN_DIR}"
-
-        # Also strip if possible
-        if [ -n "${STRIP}" ]; then
-          "${STRIP}" "${BIN_PATH}"
-        fi
-
-        # Let subsequent steps know where to find the (stripped) bin
-        echo ::set-output name=BIN_PATH::${BIN_PATH}
-        echo ::set-output name=BIN_NAME::${BIN_NAME}
+        # Let subsequent steps know where to find the binary
+        echo "BIN_PATH=${BIN_PATH}" >> $GITHUB_OUTPUT
+        echo "BIN_NAME=${BIN_NAME}" >> $GITHUB_OUTPUT
 
     - name: Set testing options
       id: test-options
@@ -271,73 +242,55 @@ jobs:
       run: |
         # test only library unit tests and binary for arm-type targets
         unset CARGO_TEST_OPTIONS
-        unset CARGO_TEST_OPTIONS ; case ${{ matrix.job.target }} in arm-* | aarch64-*) CARGO_TEST_OPTIONS="--lib --bin ${PROJECT_NAME}" ;; esac;
-        echo ::set-output name=CARGO_TEST_OPTIONS::${CARGO_TEST_OPTIONS}
+        unset CARGO_TEST_OPTIONS ; case ${{ matrix.job.target }} in arm-* | aarch64-*) CARGO_TEST_OPTIONS="--lib --bin ${{ needs.crate_metadata.outputs.name }}" ;; esac;
+        echo "CARGO_TEST_OPTIONS=${CARGO_TEST_OPTIONS}" >> $GITHUB_OUTPUT
 
     - name: Run tests
-      uses: actions-rs/cargo@v1
-      with:
-        use-cross: ${{ matrix.job.use-cross }}
-        command: test
-        args: --locked --target=${{ matrix.job.target }} ${{ steps.test-options.outputs.CARGO_TEST_OPTIONS}}
+      shell: bash
+      run: |
+        if [[ ${{ matrix.job.os }} = windows-* ]]
+        then
+          powershell.exe -command "$BUILD_CMD test --locked --target=${{ matrix.job.target }} ${{ steps.test-options.outputs.CARGO_TEST_OPTIONS}}"
+        else
+          $BUILD_CMD test --locked --target=${{ matrix.job.target }} ${{ steps.test-options.outputs.CARGO_TEST_OPTIONS}}
+        fi
 
     - name: Run bat
-      uses: actions-rs/cargo@v1
-      with:
-        use-cross: ${{ matrix.job.use-cross }}
-        command: run
-        args: --locked --target=${{ matrix.job.target }} -- --paging=never --color=always --theme=ansi Cargo.toml src/config.rs
+      shell: bash
+      run: $BUILD_CMD run --locked --target=${{ matrix.job.target }} -- --paging=never --color=always --theme=ansi Cargo.toml src/config.rs
 
     - name: Show diagnostics (bat --diagnostic)
-      uses: actions-rs/cargo@v1
-      with:
-        use-cross: ${{ matrix.job.use-cross }}
-        command: run
-        args: --locked --target=${{ matrix.job.target }} -- --paging=never --color=always --theme=ansi Cargo.toml src/config.rs --diagnostic
+      shell: bash
+      run: $BUILD_CMD run --locked --target=${{ matrix.job.target }} -- --paging=never --color=always --theme=ansi Cargo.toml src/config.rs --diagnostic
 
     - name: "Feature check: regex-onig"
-      uses: actions-rs/cargo@v1
-      with:
-        use-cross: ${{ matrix.job.use-cross }}
-        command: check
-        args: --locked --target=${{ matrix.job.target }} --verbose --lib --no-default-features --features regex-onig
+      shell: bash
+      run: $BUILD_CMD check --locked --target=${{ matrix.job.target }} --verbose --lib --no-default-features --features regex-onig
 
     - name: "Feature check: regex-onig,git"
-      uses: actions-rs/cargo@v1
-      with:
-        use-cross: ${{ matrix.job.use-cross }}
-        command: check
-        args: --locked --target=${{ matrix.job.target }} --verbose --lib --no-default-features --features regex-onig,git
+      shell: bash
+      run: $BUILD_CMD check --locked --target=${{ matrix.job.target }} --verbose --lib --no-default-features --features regex-onig,git
 
     - name: "Feature check: regex-onig,paging"
-      uses: actions-rs/cargo@v1
-      with:
-        use-cross: ${{ matrix.job.use-cross }}
-        command: check
-        args: --locked --target=${{ matrix.job.target }} --verbose --lib --no-default-features --features regex-onig,paging
+      shell: bash
+      run: $BUILD_CMD check --locked --target=${{ matrix.job.target }} --verbose --lib --no-default-features --features regex-onig,paging
 
     - name: "Feature check: regex-onig,git,paging"
-      uses: actions-rs/cargo@v1
-      with:
-        use-cross: ${{ matrix.job.use-cross }}
-        command: check
-        args: --locked --target=${{ matrix.job.target }} --verbose --lib --no-default-features --features regex-onig,git,paging
+      shell: bash
+      run: $BUILD_CMD check --locked --target=${{ matrix.job.target }} --verbose --lib --no-default-features --features regex-onig,git,paging
 
     - name: "Feature check: minimal-application"
-      uses: actions-rs/cargo@v1
-      with:
-        use-cross: ${{ matrix.job.use-cross }}
-        command: check
-        args: --locked --target=${{ matrix.job.target }} --verbose --no-default-features --features minimal-application
+      shell: bash
+      run: $BUILD_CMD check --locked --target=${{ matrix.job.target }} --verbose --no-default-features --features minimal-application
 
     - name: Create tarball
       id: package
       shell: bash
       run: |
         PKG_suffix=".tar.gz" ; case ${{ matrix.job.target }} in *-pc-windows-*) PKG_suffix=".zip" ;; esac;
-        PKG_BASENAME=${PROJECT_NAME}-v${PROJECT_VERSION}-${{ matrix.job.target }}
+        PKG_BASENAME=${{ needs.crate_metadata.outputs.name }}-v${{ needs.crate_metadata.outputs.version }}-${{ matrix.job.target }}
         PKG_NAME=${PKG_BASENAME}${PKG_suffix}
-        echo ::set-output name=PKG_NAME::${PKG_NAME}
+        echo "PKG_NAME=${PKG_NAME}" >> $GITHUB_OUTPUT
 
         PKG_STAGING="${{ env.CICD_INTERMEDIATES_DIR }}/package"
         ARCHIVE_DIR="${PKG_STAGING}/${PKG_BASENAME}/"
@@ -345,19 +298,19 @@ jobs:
         mkdir -p "${ARCHIVE_DIR}/autocomplete"
 
         # Binary
-        cp "${{ steps.strip.outputs.BIN_PATH }}" "$ARCHIVE_DIR"
-
-        # Man page
-        cp 'target/${{ matrix.job.target }}/release/build/${{ env.PROJECT_NAME }}'-*/out/assets/manual/bat.1 "$ARCHIVE_DIR"
+        cp "${{ steps.bin.outputs.BIN_PATH }}" "$ARCHIVE_DIR"
 
         # README, LICENSE and CHANGELOG files
         cp "README.md" "LICENSE-MIT" "LICENSE-APACHE" "CHANGELOG.md" "$ARCHIVE_DIR"
 
+        # Man page
+        cp 'target/${{ matrix.job.target }}/release/build/${{ needs.crate_metadata.outputs.name }}'-*/out/assets/manual/bat.1 "$ARCHIVE_DIR"
+
         # Autocompletion files
-        cp 'target/${{ matrix.job.target }}/release/build/${{ env.PROJECT_NAME }}'-*/out/assets/completions/bat.bash "$ARCHIVE_DIR/autocomplete/${{ env.PROJECT_NAME }}.bash"
-        cp 'target/${{ matrix.job.target }}/release/build/${{ env.PROJECT_NAME }}'-*/out/assets/completions/bat.fish "$ARCHIVE_DIR/autocomplete/${{ env.PROJECT_NAME }}.fish"
-        cp 'target/${{ matrix.job.target }}/release/build/${{ env.PROJECT_NAME }}'-*/out/assets/completions/_bat.ps1 "$ARCHIVE_DIR/autocomplete/_${{ env.PROJECT_NAME }}.ps1"
-        cp 'target/${{ matrix.job.target }}/release/build/${{ env.PROJECT_NAME }}'-*/out/assets/completions/bat.zsh "$ARCHIVE_DIR/autocomplete/${{ env.PROJECT_NAME }}.zsh"
+        cp 'target/${{ matrix.job.target }}/release/build/${{ needs.crate_metadata.outputs.name }}'-*/out/assets/completions/bat.bash "$ARCHIVE_DIR/autocomplete/${{ needs.crate_metadata.outputs.name }}.bash"
+        cp 'target/${{ matrix.job.target }}/release/build/${{ needs.crate_metadata.outputs.name }}'-*/out/assets/completions/bat.fish "$ARCHIVE_DIR/autocomplete/${{ needs.crate_metadata.outputs.name }}.fish"
+        cp 'target/${{ matrix.job.target }}/release/build/${{ needs.crate_metadata.outputs.name }}'-*/out/assets/completions/_bat.ps1 "$ARCHIVE_DIR/autocomplete/_${{ needs.crate_metadata.outputs.name }}.ps1"
+        cp 'target/${{ matrix.job.target }}/release/build/${{ needs.crate_metadata.outputs.name }}'-*/out/assets/completions/bat.zsh "$ARCHIVE_DIR/autocomplete/${{ needs.crate_metadata.outputs.name }}.zsh"
 
         # base compressed package
         pushd "${PKG_STAGING}/" >/dev/null
@@ -368,7 +321,7 @@ jobs:
         popd >/dev/null
 
         # Let subsequent steps know where to find the compressed package
-        echo ::set-output name=PKG_PATH::"${PKG_STAGING}/${PKG_NAME}"
+        echo "PKG_PATH=${PKG_STAGING}/${PKG_NAME}" >> $GITHUB_OUTPUT
 
     - name: Create Debian package
       id: debian-package
@@ -380,10 +333,10 @@ jobs:
         DPKG_DIR="${DPKG_STAGING}/dpkg"
         mkdir -p "${DPKG_DIR}"
 
-        DPKG_BASENAME=${PROJECT_NAME}
-        DPKG_CONFLICTS=${PROJECT_NAME}-musl
-        case ${{ matrix.job.target }} in *-musl) DPKG_BASENAME=${PROJECT_NAME}-musl ; DPKG_CONFLICTS=${PROJECT_NAME} ;; esac;
-        DPKG_VERSION=${PROJECT_VERSION}
+        DPKG_BASENAME=${{ needs.crate_metadata.outputs.name }}
+        DPKG_CONFLICTS=${{ needs.crate_metadata.outputs.name }}-musl
+        case ${{ matrix.job.target }} in *-musl) DPKG_BASENAME=${{ needs.crate_metadata.outputs.name }}-musl ; DPKG_CONFLICTS=${{ needs.crate_metadata.outputs.name }} ;; esac;
+        DPKG_VERSION=${{ needs.crate_metadata.outputs.version }}
 
         unset DPKG_ARCH
         case ${{ matrix.job.target }} in
@@ -395,19 +348,19 @@ jobs:
         esac;
 
         DPKG_NAME="${DPKG_BASENAME}_${DPKG_VERSION}_${DPKG_ARCH}.deb"
-        echo ::set-output name=DPKG_NAME::${DPKG_NAME}
+        echo "DPKG_NAME=${DPKG_NAME}" >> $GITHUB_OUTPUT
 
         # Binary
-        install -Dm755 "${{ steps.strip.outputs.BIN_PATH }}" "${DPKG_DIR}/usr/bin/${{ steps.strip.outputs.BIN_NAME }}"
+        install -Dm755 "${{ steps.bin.outputs.BIN_PATH }}" "${DPKG_DIR}/usr/bin/${{ steps.bin.outputs.BIN_NAME }}"
 
         # Man page
-        install -Dm644 'target/${{ matrix.job.target }}/release/build/${{ env.PROJECT_NAME }}'-*/out/assets/manual/bat.1 "${DPKG_DIR}/usr/share/man/man1/${{ env.PROJECT_NAME }}.1"
-        gzip -n --best "${DPKG_DIR}/usr/share/man/man1/${{ env.PROJECT_NAME }}.1"
+        install -Dm644 'target/${{ matrix.job.target }}/release/build/${{ needs.crate_metadata.outputs.name }}'-*/out/assets/manual/bat.1 "${DPKG_DIR}/usr/share/man/man1/${{ needs.crate_metadata.outputs.name }}.1"
+        gzip -n --best "${DPKG_DIR}/usr/share/man/man1/${{ needs.crate_metadata.outputs.name }}.1"
 
         # Autocompletion files
-        install -Dm644 'target/${{ matrix.job.target }}/release/build/${{ env.PROJECT_NAME }}'-*/out/assets/completions/bat.bash "${DPKG_DIR}/usr/share/bash-completion/completions/${{ env.PROJECT_NAME }}"
-        install -Dm644 'target/${{ matrix.job.target }}/release/build/${{ env.PROJECT_NAME }}'-*/out/assets/completions/bat.fish "${DPKG_DIR}/usr/share/fish/vendor_completions.d/${{ env.PROJECT_NAME }}.fish"
-        install -Dm644 'target/${{ matrix.job.target }}/release/build/${{ env.PROJECT_NAME }}'-*/out/assets/completions/bat.zsh "${DPKG_DIR}/usr/share/zsh/vendor-completions/_${{ env.PROJECT_NAME }}"
+        install -Dm644 'target/${{ matrix.job.target }}/release/build/${{ needs.crate_metadata.outputs.name }}'-*/out/assets/completions/bat.bash "${DPKG_DIR}/usr/share/bash-completion/completions/${{ needs.crate_metadata.outputs.name }}"
+        install -Dm644 'target/${{ matrix.job.target }}/release/build/${{ needs.crate_metadata.outputs.name }}'-*/out/assets/completions/bat.fish "${DPKG_DIR}/usr/share/fish/vendor_completions.d/${{ needs.crate_metadata.outputs.name }}.fish"
+        install -Dm644 'target/${{ matrix.job.target }}/release/build/${{ needs.crate_metadata.outputs.name }}'-*/out/assets/completions/bat.zsh "${DPKG_DIR}/usr/share/zsh/vendor-completions/_${{ needs.crate_metadata.outputs.name }}"
 
         # README and LICENSE
         install -Dm644 "README.md" "${DPKG_DIR}/usr/share/doc/${DPKG_BASENAME}/README.md"
@@ -418,12 +371,12 @@ jobs:
 
         cat > "${DPKG_DIR}/usr/share/doc/${DPKG_BASENAME}/copyright" <<EOF
         Format: http://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
-        Upstream-Name: ${{ env.PROJECT_NAME }}
-        Source: ${{ env.PROJECT_HOMEPAGE }}
+        Upstream-Name: ${{ needs.crate_metadata.outputs.name }}
+        Source: ${{ needs.crate_metadata.outputs.homepage }}
 
         Files: *
-        Copyright: ${{ env.PROJECT_MAINTAINER }}
-        Copyright: $COPYRIGHT_YEARS ${{ env.PROJECT_MAINTAINER }}
+        Copyright: ${{ needs.crate_metadata.outputs.maintainer }}
+        Copyright: $COPYRIGHT_YEARS ${{ needs.crate_metadata.outputs.maintainer }}
         License: Apache-2.0 or MIT
 
         License: Apache-2.0
@@ -464,17 +417,17 @@ jobs:
         Version: ${DPKG_VERSION}
         Section: utils
         Priority: optional
-        Maintainer: ${{ env.PROJECT_MAINTAINER }}
-        Homepage: ${{ env.PROJECT_HOMEPAGE }}
+        Maintainer: ${{ needs.crate_metadata.outputs.maintainer }}
+        Homepage: ${{ needs.crate_metadata.outputs.homepage }}
         Architecture: ${DPKG_ARCH}
-        Provides: ${{ env.PROJECT_NAME }}
+        Provides: ${{ needs.crate_metadata.outputs.name }}
         Conflicts: ${DPKG_CONFLICTS}
         Description: cat(1) clone with wings.
           A cat(1) clone with syntax highlighting and Git integration.
         EOF
 
         DPKG_PATH="${DPKG_STAGING}/${DPKG_NAME}"
-        echo ::set-output name=DPKG_PATH::${DPKG_PATH}
+        echo "DPKG_PATH=${DPKG_PATH}" >> $GITHUB_OUTPUT
 
         # build dpkg
         fakeroot dpkg-deb --build "${DPKG_DIR}" "${DPKG_PATH}"
@@ -497,7 +450,7 @@ jobs:
       shell: bash
       run: |
         unset IS_RELEASE ; if [[ $GITHUB_REF =~ ^refs/tags/v[0-9].* ]]; then IS_RELEASE='true' ; fi
-        echo ::set-output name=IS_RELEASE::${IS_RELEASE}
+        echo "IS_RELEASE=${IS_RELEASE}" >> $GITHUB_OUTPUT
 
     - name: Publish archives and packages
       uses: softprops/action-gh-release@v1
@@ -508,3 +461,15 @@ jobs:
           ${{ steps.debian-package.outputs.DPKG_PATH }}
       env:
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+  winget:
+    name: Publish to Winget
+    runs-on: ubuntu-latest
+    needs: build
+    if: startsWith(github.ref, 'refs/tags/v')
+    steps:
+      - uses: vedantmgoyal2009/winget-releaser@v2
+        with:
+          identifier: sharkdp.bat
+          installers-regex: '-pc-windows-msvc\.zip$'
+          token: ${{ secrets.WINGET_TOKEN }}

.gitmodules

@@ -244,3 +244,19 @@
 	url = https://github.com/victor-gp/cmd-help-sublime-syntax.git
 	branch = main
 	shallow = true
+[submodule "assets/syntaxes/02_Extra/TodoTxt"]
+	path = assets/syntaxes/02_Extra/TodoTxt
+	url = https://github.com/dertuxmalwieder/SublimeTodoTxt
+[submodule "assets/syntaxes/02_Extra/Ada"]
+	path = assets/syntaxes/02_Extra/Ada
+	url = https://github.com/wiremoons/ada-sublime-syntax
+  
+[submodule "assets/syntaxes/02_Extra/Crontab"]
+	path = assets/syntaxes/02_Extra/Crontab
+	url = https://github.com/michaelblyons/SublimeSyntax-Crontab
+[submodule "assets/syntaxes/02_Extra/NSIS"]
+	path = assets/syntaxes/02_Extra/NSIS
+	url = https://github.com/SublimeText/NSIS
+[submodule "assets/syntaxes/02_Extra/vscode-wgsl"]
+	path = assets/syntaxes/02_Extra/vscode-wgsl
+	url = https://github.com/PolyMeilex/vscode-wgsl.git

CHANGELOG.md

@@ -1,3 +1,90 @@
+# v0.24.0
+
+## Features
+
+- Add environment variable `BAT_PAGING`, see #2629 (@einfachIrgendwer0815)
+- Add opt-in (`--features lessopen`) support for `LESSOPEN` and `LESSCLOSE`. See #1597, #1739, #2444, #2602, and #2662 (@Anomalocaridid)
+
+## Bugfixes
+
+- Fix `more` not being found on Windows when provided via `BAT_PAGER`, see #2570, #2580, and #2651 (@mataha)
+- Switched default behavior of `--map-syntax` to be case insensitive #2520
+- Updated version of `serde_yaml` to `0.9`. See #2627 (@Raghav-Bell)
+- Fix arithmetic overflow in `LineRange::from` and `LineRange::parse_range`, see #2674, #2698 (@skoriop)
+- Fix paging not happening when stdout is interactive but stdin is not, see #2574 (@Nigecat)
+- Make `-pp` override `--paging` and vice versa when passed as a later argument, see #2660 (@J-Kappes)
+
+## Other
+
+- Output directory for generated assets (completion, manual) can be customized, see #2515 (@tranzystorek-io)
+- Use the `is-terminal` crate instead of `atty`, see #2530 (@nickelc)
+- Add Winget Releaser workflow, see #2519 (@sitiom)
+- Bump MSRV to 1.70, see #2651 (@mataha)
+
+## Syntaxes
+
+- Associate `os-release` with `bash` syntax, see #2587 (@cyqsimon)
+- Associate `Containerfile` with `Dockerfile` syntax, see #2606 (@einfachIrgendwer0815)
+- Replaced quotes with double quotes so fzf integration example script works on windows and linux. see #2095 (@johnmatthiggins)
+- Associate `ksh` files with `bash` syntax, see #2633 (@johnmatthiggins)
+- Associate `sarif` files with `JSON` syntax, see #2695 (@rhysd)
+- Associate `ron` files with `rust` syntax, see #2427 (@YeungOnion)
+- Add support for [WebGPU Shader Language](https://www.w3.org/TR/WGSL/), see #2692 (@rhysd)
+- Add `.dpkg-new` and `.dpkg-tmp` to ignored suffixe, see #2595 (@scop)
+- fix: Add syntax mapping `*.jsonl` => `json`, see #2539 (@WinterCore)
+- Update `Julia` syntax, see #2553 (@dependabot)
+- add `NSIS` support, see #2577 (@idleberg)
+- Update `ssh-config`, see #2697 (@mrmeszaros)
+
+## `bat` as a library
+
+- Add optional output_buffer arg to `Controller::run()` and `Controller::run_with_error_handler()`, see #2618 (@Piturnah)
+
+
+# v0.23.0
+
+## Features
+
+- Implemented `-S` and `--chop-long-lines` flags as aliases for `--wrap=never`. See #2309 (@johnmatthiggins)
+- Breaking change: Environment variables can now override config file settings (but command-line arguments still have the highest precedence), see #1152, #1281, and #2381 (@aaronkollasch)
+- Implemented `--nonprintable-notation=caret` to support showing non-printable characters using caret notation. See #2429 (@einfachIrgendwer0815)
+
+## Bugfixes
+
+- Fix `bat cache --clear` not clearing the `--target` dir if specified. See #2393 (@miles170)
+
+## Other
+
+- Various bash completion improvements, see #2310 (@scop)
+- Disable completion of `cache` subcommand, see #2399 (@cyqsimon)
+- Signifigantly improve startup performance on macOS, see #2442 (@BlackHoleFox)
+- Bump MSRV to 1.62, see #2496 (@Enselic)
+
+## Syntaxes
+
+- Added support for Ada, see #1300 and #2316 (@dkm)
+- Added `todo.txt` syntax, see #2375 (@BANOnotIT)
+- Improve Manpage.sublime-syntax. See #2364 (@Freed-Wu) and #2461 (@keith-hall)
+- Added a new `requirements.txt` syntax, see #2361 (@Freed-Wu)
+- Added a new VimHelp syntax, see #2366 (@Freed-Wu)
+- Associate `pdm.lock` with `TOML` syntax, see #2410
+- `Todo.txt`: Fix highlighting of contexts and projects at beginning of done.txt, see #2411
+- `cmd-help`: overhaul scope names (colors) to improve theme support; misc syntax improvements. See #2419 (@victor-gp)
+- Added support for Crontab, see #2509 (@keith-hall)
+
+## Themes
+
+## `bat` as a library
+
+- `PrettyPrinter::header` correctly displays a header with the filename, see #2378 and #2406 (@cstyles)
+
+
+# v0.22.1
+
+## Bugfixes
+
+- Bring back pre-processing of ANSI escape characters to so that some common `bat` use cases starts working again. See #2308 (@Enselic)
+
 # v0.22.0
 
 ## Features

CONTRIBUTING.md

@@ -33,7 +33,7 @@ section in the README.
 
 Please consider opening a
 [feature request ticket](https://github.com/sharkdp/bat/issues/new?assignees=&labels=feature-request&template=feature_request.md)
-first in order to give us a chance to discuss the feature first.
+first in order to give us a chance to discuss the details and specifics of the potential new feature before you go and build it.
 
 
 ## Adding new syntaxes/languages or themes
@@ -50,12 +50,12 @@ first.
 
 ## Regression tests
 
-You are strongly encouraged to add regression tests. Regression tests are great,
+You are **strongly encouraged** to add regression tests. Regression tests are great,
 not least because they:
 
-* ensure that your contribution will never completely stop working,
+* ensure that your contribution will never completely stop working.
 
-* makes code review easier, because it becomes very clear what the code is
+* makes code reviews easier, because it becomes very clear what the code is
   supposed to do.
 
 For functional changes, you most likely want to add a test to

Cargo.toml

@@ -3,13 +3,14 @@ authors = ["David Peter <mail@david-peter.de>"]
 categories = ["command-line-utilities"]
 description = "A cat(1) clone with wings."
 homepage = "https://github.com/sharkdp/bat"
-license = "MIT/Apache-2.0"
+license = "MIT OR Apache-2.0"
 name = "bat"
 repository = "https://github.com/sharkdp/bat"
-version = "0.22.0"
+version = "0.24.0"
 exclude = ["assets/syntaxes/*", "assets/themes/*"]
 build = "build.rs"
 edition = '2018'
+rust-version = "1.70"
 
 [features]
 default = ["application"]
@@ -24,15 +25,15 @@ application = [
 # Mainly for developers that want to iterate quickly
 # Be aware that the included features might change in the future
 minimal-application = [
-    "atty",
     "clap",
-    "dirs-next",
+    "etcetera",
     "paging",
     "regex-onig",
     "wild",
 ]
 git = ["git2"] # Support indicating git modifications
 paging = ["shell-words", "grep-cli"] # Support applying a pager on the output
+lessopen = ["run_script", "os_str_bytes"] # Support $LESSOPEN preprocessor
 build-assets = ["syntect/yaml-load", "syntect/plist-load", "regex", "walkdir"]
 
 # You need to use one of these if you depend on bat as a library:
@@ -40,34 +41,35 @@ regex-onig = ["syntect/regex-onig"] # Use the "oniguruma" regex engine
 regex-fancy = ["syntect/regex-fancy"] # Use the rust-only "fancy-regex" engine
 
 [dependencies]
-atty = { version = "0.2.14", optional = true }
-ansi_term = "^0.12.1"
-ansi_colours = "^1.1"
+nu-ansi-term = "0.49.0"
+ansi_colours = "^1.2"
 bincode = "1.0"
-console = "0.15.1"
+console = "0.15.5"
 flate2 = "1.0"
-once_cell = "1.13"
+once_cell = "1.18"
 thiserror = "1.0"
 wild = { version = "2.1", optional = true }
 content_inspector = "0.2.4"
-encoding = "0.2"
 shell-words = { version = "1.1.0", optional = true }
-unicode-width = "0.1.9"
+unicode-width = "0.1.10"
 globset = "0.4"
 serde = { version = "1.0", features = ["derive"] }
-serde_yaml = "0.8"
+serde_yaml = "0.9"
 semver = "1.0"
 path_abs = { version = "0.5", default-features = false }
-clircle = "0.3"
+clircle = "0.4"
 bugreport = { version = "0.5.0", optional = true }
-dirs-next = { version = "2.0.0", optional = true }
-grep-cli = { version = "0.1.6", optional = true }
-regex = { version = "1.6.0", optional = true }
-walkdir = { version = "2.0", optional = true }
-bytesize = { version = "1.1.0" }
+etcetera = { version = "0.8.0", optional = true }
+grep-cli = { version = "0.1.9", optional = true }
+regex = { version = "1.8.3", optional = true }
+walkdir = { version = "2.3", optional = true }
+bytesize = { version = "1.3.0" }
+encoding_rs = "0.8.33"
+os_str_bytes = { version = "~6.4", optional = true }
+run_script = { version = "^0.10.0", optional = true}
 
 [dependencies.git2]
-version = "0.15"
+version = "0.18"
 optional = true
 default-features = false
 
@@ -77,24 +79,31 @@ default-features = false
 features = ["parsing"]
 
 [dependencies.clap]
-version = "3.2.20"
+version = "4.4.6"
 optional = true
-default-features = false
-features = ["std", "suggestions", "color", "wrap_help", "cargo"]
+features = ["wrap_help", "cargo"]
+
+[target.'cfg(target_os = "macos")'.dependencies]
+home = "0.5.4"
+plist = "1.4.3"
 
 [dev-dependencies]
-assert_cmd = "2.0.4"
-serial_test = "0.6.0"
-predicates = "2.1.1"
+assert_cmd = "2.0.10"
+expect-test = "1.4.1"
+serial_test = { version = "2.0.0", default-features = false }
+predicates = "3.0.3"
 wait-timeout = "0.2.0"
-tempfile = "3.3.0"
+tempfile = "3.8.0"
 
 [target.'cfg(unix)'.dev-dependencies]
-nix = { version = "0.24.2", default-features = false, features = ["term"] }
+nix = { version = "0.26.2", default-features = false, features = ["term"] }
 
-[build-dependencies]
-clap = { version = "3.2.20", optional = true }
+[build-dependencies.clap]
+version = "4.4.6"
+optional = true
+features = ["wrap_help", "cargo"]
 
 [profile.release]
 lto = true
+strip = true
 codegen-units = 1

LICENSE-MIT

@@ -1,4 +1,4 @@
-Copyright (c) 2018-2021 bat-developers (https://github.com/sharkdp/bat).
+Copyright (c) 2018-2023 bat-developers (https://github.com/sharkdp/bat).
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -32,6 +32,16 @@ A special *thank you* goes to our biggest <a href="doc/sponsors.md">sponsors</a>
   <sup>Add Single Sign-On (and more) in minutes instead of months.</sup>
 </a>
 
+<a href="https://www.warp.dev/?utm_source=github&utm_medium=referral&utm_campaign=bat_20231001">
+  <img src="doc/sponsors/warp-logo.png" width="200" alt="Warp">
+  <br>
+  <strong>Warp is a modern, Rust-based terminal with AI built in<br>so you and your team can build great software, faster.</strong>
+  <br>
+  <sub>Feel more productive on the command line with parameterized commands,</sub>
+  <br>
+  <sup>autosuggestions, and an IDE-like text editor.</sup>
+</a>
+
 ### Syntax highlighting
 
 `bat` supports syntax highlighting for a large number of programming and markup
@@ -118,7 +128,7 @@ use `bat`s `--color=always` option to force colorized output. You can also use `
 option to restrict the load times for long files:
 
 ```bash
-fzf --preview 'bat --color=always --style=numbers --line-range=:500 {}'
+fzf --preview "bat --color=always --style=numbers --line-range=:500 {}"
 ```
 
 For more information, see [`fzf`'s `README`](https://github.com/junegunn/fzf#preview-window).
@@ -228,6 +238,17 @@ help() {
 
 Then you can do `$ help cp` or `$ help git commit`.
 
+When you are using `zsh`, you can also use global aliases to override `-h` and `--help` entirely:
+
+```bash
+alias -g -- -h='-h 2>&1 | bat --language=help --style=plain'
+alias -g -- --help='--help 2>&1 | bat --language=help --style=plain'
+```
+
+This way, you can keep on using `cp --help`, but get colorized help pages.
+
+Be aware that in some cases, `-h` may not be a shorthand of `--help` (for example with `ls`).
+
 Please report any issues with the help syntax in [this repository](https://github.com/victor-gp/cmd-help-sublime-syntax).
 
 
@@ -367,7 +388,7 @@ Existing packages may be available, but are not officially supported and may con
 
 ### On macOS (or Linux) via Homebrew
 
-You can install `bat` with [Homebrew on MacOS](https://formulae.brew.sh/formula/bat) or [Homebrew on Linux](https://formulae.brew.sh/formula-linux/bat):
+You can install `bat` with [Homebrew](https://formulae.brew.sh/formula/bat):
 
 ```bash
 brew install bat
@@ -390,6 +411,14 @@ take a look at the ["Using `bat` on Windows"](#using-bat-on-windows) section.
 
 You will need to install the [Visual C++ Redistributable](https://support.microsoft.com/en-us/help/2977003/the-latest-supported-visual-c-downloads) package.
 
+#### With WinGet
+
+You can install `bat` via [WinGet](https://learn.microsoft.com/en-us/windows/package-manager/winget):
+
+```bash
+winget install sharkdp.bat
+```
+
 #### With Chocolatey
 
 You can install `bat` via [Chocolatey](https://chocolatey.org/packages/Bat):
@@ -418,7 +447,7 @@ binaries are also available: look for archives with `musl` in the file name.
 
 ### From source
 
-If you want to build `bat` from source, you need Rust 1.60.0 or
+If you want to build `bat` from source, you need Rust 1.70.0 or
 higher. You can then use `cargo` to build everything:
 
 ```bash
@@ -684,9 +713,7 @@ Windows 10 natively supports colors in both `conhost.exe` (Command Prompt) and P
 well as in newer versions of bash. On earlier versions of Windows, you can use
 [Cmder](http://cmder.net/), which includes [ConEmu](https://conemu.github.io/).
 
-**Note:** The Git and MSYS versions of `less` do not correctly interpret colors on Windows. If you
-don’t have any other pagers installed, you can disable paging entirely by passing `--paging=never`
-or by setting `BAT_PAGER` to an empty string.
+**Note:** Old versions of `less` do not correctly interpret colors on Windows. To fix this, you can add the optional Unix tools to your PATH when installing Git. If you don’t have any other pagers installed, you can disable paging entirely by passing `--paging=never` or by setting `BAT_PAGER` to an empty string.
 
 ### Cygwin
 
@@ -801,7 +828,7 @@ There are a lot of alternatives, if you are looking for similar programs. See
 [this document](doc/alternatives.md) for a comparison.
 
 ## License
-Copyright (c) 2018-2021 [bat-developers](https://github.com/sharkdp/bat).
+Copyright (c) 2018-2023 [bat-developers](https://github.com/sharkdp/bat).
 
 `bat` is made available under the terms of either the MIT License or the Apache License 2.0, at your option.
 

assets/completions/_bat.ps1.in

@@ -59,6 +59,8 @@ Register-ArgumentCompleter -Native -CommandName '{{PROJECT_EXECUTABLE}}' -Script
             [CompletionResult]::new('--unbuffered', 'unbuffered', [CompletionResultType]::ParameterName, 'unbuffered')
             [CompletionResult]::new('--no-config', 'no-config', [CompletionResultType]::ParameterName, 'Do not use the configuration file')
             [CompletionResult]::new('--no-custom-assets', 'no-custom-assets', [CompletionResultType]::ParameterName, 'Do not load custom assets')
+            [CompletionResult]::new('--lessopen', 'lessopen', [CompletionResultType]::ParameterName, 'Enable the $LESSOPEN preprocessor')
+            [CompletionResult]::new('--no-lessopen', 'no-lessopen', [CompletionResultType]::ParameterName, 'Disable the $LESSOPEN preprocessor if enabled (overrides --lessopen)')
             [CompletionResult]::new('--config-file', 'config-file', [CompletionResultType]::ParameterName, 'Show path to the configuration file.')
             [CompletionResult]::new('--generate-config-file', 'generate-config-file', [CompletionResultType]::ParameterName, 'Generates a default configuration file.')
             [CompletionResult]::new('--config-dir', 'config-dir', [CompletionResultType]::ParameterName, 'Show bat''s configuration directory.')
@@ -68,7 +70,8 @@ Register-ArgumentCompleter -Native -CommandName '{{PROJECT_EXECUTABLE}}' -Script
             [CompletionResult]::new('--help', 'help', [CompletionResultType]::ParameterName, 'Print this help message.')
             [CompletionResult]::new('-V', 'V', [CompletionResultType]::ParameterName, 'Show version information.')
             [CompletionResult]::new('--version', 'version', [CompletionResultType]::ParameterName, 'Show version information.')
-            [CompletionResult]::new('cache', 'cache', [CompletionResultType]::ParameterValue, 'Modify the syntax-definition and theme cache')
+            ## Completion of the 'cache' command itself is removed for better UX
+            ## See https://github.com/sharkdp/bat/issues/2085#issuecomment-1271646802
             break
         }
         '{{PROJECT_EXECUTABLE}};cache' {

assets/completions/bat.bash.in

@@ -10,8 +10,29 @@ __bat_init_completion()
 	_get_comp_words_by_ref "$@" cur prev words cword
 }
 
+__bat_escape_completions()
+{
+	# Do not escape if completing a quoted value.
+	[[ $cur == [\"\']* ]] && return 0
+	# printf -v to an array index is available in bash >= 4.1.
+	# Use it if available, as -o filenames is semantically incorrect if
+	# we are not actually completing filenames, and it has side effects
+	# (e.g. adds trailing slash to candidates matching present dirs).
+	if ((
+		BASH_VERSINFO[0] > 4 || \
+		BASH_VERSINFO[0] == 4 && BASH_VERSINFO[1] > 0
+	)); then
+		local i
+		for i in ${!COMPREPLY[*]}; do
+			printf -v "COMPREPLY[i]" %q "${COMPREPLY[i]}"
+		done
+	else
+		compopt -o filenames
+	fi
+}
+
 _bat() {
-	local cur prev words cword split=false
+	local cur prev words split=false
 	if declare -F _init_completion >/dev/null 2>&1; then
 		_init_completion -s || return 0
 	else
@@ -27,7 +48,12 @@ _bat() {
 			;;
 		esac
 		COMPREPLY=($(compgen -W "
-			--build --clear --source --target --blank --help
+			--build
+			--clear
+			--source
+			--target
+			--blank
+			--help
 		" -- "$cur"))
 		return 0
 	fi
@@ -40,13 +66,27 @@ _bat() {
 				printf "%s\n" "$lang"
 			done
 		)" -- "$cur"))
-		compopt -o filenames  # for escaping
+                __bat_escape_completions
 		return 0
 		;;
-	-H | --highlight-line | --diff-context | --tabs | --terminal-width | \
-	-m | --map-syntax | --style | --line-range | -h | --help | -V | \
-	--version | --diagnostic | --config-file | --config-dir | \
-	--cache-dir | --generate-config-file)
+	-H | --highlight-line | \
+	--diff-context | \
+	--tabs | \
+	--terminal-width | \
+	-m | --map-syntax | \
+	--ignored-suffix | \
+	--list-themes | \
+	--line-range | \
+	-L | --list-languages | \
+	--lessopen | \
+	--diagnostic | \
+	--acknowledgements | \
+	-h | --help | \
+	-V | --version | \
+	--cache-dir | \
+	--config-dir | \
+	--config-file | \
+	--generate-config-file)
 		# argument required but no completion available, or option
 		# causes an exit
 		return 0
@@ -74,28 +114,79 @@ _bat() {
 	--theme)
 		local IFS=$'\n'
 		COMPREPLY=($(compgen -W "$("$1" --list-themes)" -- "$cur"))
-		compopt -o filenames  # for escaping
+                __bat_escape_completions
 		return 0
 		;;
+	--style)
+		# shellcheck disable=SC2034
+		local -a styles=(
+			default
+			full
+			auto
+			plain
+			changes
+			header
+			header-filename
+			header-filesize
+			grid
+			rule
+			numbers
+			snip
+		)
+                # shellcheck disable=SC2016
+		if declare -F _comp_delimited >/dev/null 2>&1; then
+			# bash-completion > 2.11
+			_comp_delimited , -W '"${styles[@]}"'
+		else
+			COMPREPLY=($(compgen -W '${styles[@]}' -- "$cur"))
+		fi
+		return 0
 	esac
 
 	$split && return 0
 
 	if [[ $cur == -* ]]; then
+		# --unbuffered excluded intentionally (no-op)
 		COMPREPLY=($(compgen -W "
-			--show-all --plain --language --highlight-line
-			--file-name --diff --diff-context --tabs --wrap
-			--terminal-width --number --color --italic-text
-			--decorations --paging --pager --map-syntax --theme
-			--list-themes --style --line-range --list-languages
-			--help --version --force-colorization --unbuffered
-			--diagnostic --config-file --config-dir --cache-dir
+			--show-all
+			--plain
+			--language
+			--highlight-line
+			--file-name
+			--diff
+			--diff-context
+			--tabs
+			--wrap
+			--terminal-width
+			--number
+			--color
+			--italic-text
+			--decorations
+			--force-colorization
+			--paging
+			--pager
+			--map-syntax
+			--ignored-suffix
+			--theme
+			--list-themes
+			--style
+			--line-range
+			--list-languages
+			--lessopen
+			--diagnostic
+			--acknowledgements
+			--help
+			--version
+			--cache-dir
+			--config-dir
+			--config-file
 			--generate-config-file
 		" -- "$cur"))
 		return 0
 	fi
 
 	_filedir
-	((cword == 1)) && COMPREPLY+=($(compgen -W cache -- "$cur"))
-
+	
+	## Completion of the 'cache' command itself is removed for better UX
+	## See https://github.com/sharkdp/bat/issues/2085#issuecomment-1271646802
 } && complete -F _bat {{PROJECT_EXECUTABLE}}

assets/completions/bat.fish.in

@@ -163,6 +163,8 @@ complete -c $bat -l italic-text -x -a "$italic_text_opts" -d "When to use italic
 
 complete -c $bat -s l -l language -x -k -a "(__bat_complete_list_languages)" -d "Set the syntax highlighting language" -n __bat_no_excl_args
 
+complete -c $bat -l lessopen -d "Enable the $LESSOPEN preprocessor" -n __fish_is_first_arg
+
 complete -c $bat -s r -l line-range -x -d "Only print lines [M]:[N] (either optional)" -n __bat_no_excl_args
 
 complete -c $bat -l list-languages -f -d "List syntax highlighting languages" -n __fish_is_first_arg
@@ -198,7 +200,8 @@ complete -c $bat -s V -l version -f -d "Show version information" -n __fish_is_f
 complete -c $bat -l wrap -x -a "$wrap_opts" -d "Text-wrapping mode" -n __bat_no_excl_args
 
 # Sub-command 'cache' completions
-complete -c $bat -a cache -d "Modify the syntax/language definition cache" -n __fish_use_subcommand
+## Completion of the 'cache' command itself is removed for better UX
+## See https://github.com/sharkdp/bat/issues/2085#issuecomment-1271646802
 
 complete -c $bat -l build -f -d "Parse new definitions into cache" -n __bat_cache_no_excl
 

assets/completions/bat.zsh.in

@@ -46,6 +46,8 @@ _{{PROJECT_EXECUTABLE}}_main() {
         '(: --list-themes --list-languages -L)'{-L,--list-languages}'[Display all supported languages]'
         '(: --no-config)'--no-config'[Do not use the configuration file]'
         '(: --no-custom-assets)'--no-custom-assets'[Do not load custom assets]'
+        '(: --lessopen)'--lessopen'[Enable the $LESSOPEN preprocessor]'
+        '(: --no-lessopen)'--no-lessopen'[Disable the $LESSOPEN preprocessor if enabled (overrides --lessopen)]'
         '(: --config-dir)'--config-dir'[Show bat'"'"'s configuration directory]'
         '(: --config-file)'--config-file'[Show path to the configuration file]'
         '(: --generate-config-file)'--generate-config-file'[Generates a default configuration file]'
@@ -80,20 +82,14 @@ _{{PROJECT_EXECUTABLE}}_main() {
     esac
 }
 
-# first positional argument
-if (( ${#words} == 2 )); then
-    local -a subcommands
-    subcommands=('cache:Modify the syntax-definition and theme cache')
-    _describe subcommand subcommands
-    _{{PROJECT_EXECUTABLE}}_main
-else
-    case $words[2] in
-        cache)
-            _{{PROJECT_EXECUTABLE}}_cache_subcommand
-        ;;
+case $words[2] in
+    cache)
+        ## Completion of the 'cache' command itself is removed for better UX
+        ## See https://github.com/sharkdp/bat/issues/2085#issuecomment-1271646802
+        _{{PROJECT_EXECUTABLE}}_cache_subcommand
+    ;;
 
-        *)
-            _{{PROJECT_EXECUTABLE}}_main
-        ;;
-    esac
-fi
+    *)
+        _{{PROJECT_EXECUTABLE}}_main
+    ;;
+esac

assets/manual/bat.1.in

@@ -25,6 +25,18 @@ either '--language value', '--language=value', '-l value' or '-lvalue'.
 Show non\-printable characters like space, tab or newline. Use '\-\-tabs' to
 control the width of the tab\-placeholders.
 .HP
+\fB\-\-nonprintable\-notation\fR <notation>
+.IP
+Specify how to display non-printable characters when using \-\-show\-all.
+
+Possible values:
+.RS
+.IP "caret"
+Use character sequences like ^G, ^J, ^@, .. to identify non-printable characters
+.IP "unicode"
+Use special Unicode code points to identify non-printable characters
+.RE
+.HP
 \fB\-p\fR, \fB\-\-plain\fR
 .IP
 Only show plain style, no decorations. This is an alias for
@@ -231,6 +243,23 @@ If you ever want to remove the custom languages, you can clear the cache with `\
 Similarly to custom languages, {{PROJECT_EXECUTABLE}} supports Sublime Text \fB.tmTheme\fR themes.
 These can be installed to `\fB$({{PROJECT_EXECUTABLE}} --config-dir)/themes\fR`, and are added to the cache with
 `\fB{{PROJECT_EXECUTABLE}} cache --build`.
+
+.SH "INPUT PREPROCESSOR"
+Much like less(1) does, {{PROJECT_EXECUTABLE}} supports input preprocessors via the LESSOPEN and LESSCLOSE environment variables.
+In addition, {{PROJECT_EXECUTABLE}} attempts to be as compatible with less's preprocessor implementation as possible.
+
+To use the preprocessor, call:
+
+\fB{{PROJECT_EXECUTABLE}} --lessopen\fR
+
+Alternatively, the preprocessor may be enabled by default by adding the '\-\-lessopen' option to the configuration file. 
+
+To temporarily disable the preprocessor if it is enabled by default, call:
+
+\fB{{PROJECT_EXECUTABLE}} --no-lessopen\fR
+
+For more information, see the "INPUT PREPROCESSOR" section of less(1).  
+
 .SH "MORE INFORMATION"
 
 For more information and up-to-date documentation, visit the {{PROJECT_EXECUTABLE}} repo:

assets/patches/TodoTxt.sublime-syntax.patch

@@ -0,0 +1,13 @@
+diff --git syntaxes/02_Extra/TodoTxt/TodoTxt.sublime-syntax syntaxes/02_Extra/TodoTxt/TodoTxt.sublime-syntax
+index 6c75dbb..0115978 100644
+--- syntaxes/02_Extra/TodoTxt/TodoTxt.sublime-syntax
++++ syntaxes/02_Extra/TodoTxt/TodoTxt.sublime-syntax
+@@ -68,7 +68,7 @@ contexts:
+ 
+     - match: (\s+[^\s:]+:[^\s:]+)+\s*$
+       comment: Custom attributes
+-      scope: variable.annotation.todotxt.attribute
++      scope: variable.other.todotxt.attribute
+ 
+   comments:
+     # Comments begin with a '//' and finish at the end of the line.

assets/patches/TwoDark.tmTheme.patch

@@ -0,0 +1,20 @@
+diff --git themes/TwoDark/TwoDark.tmTheme themes/TwoDark/TwoDark.tmTheme
+index 87fd358..56376d3 100644
+--- themes/TwoDark/TwoDark.tmTheme
++++ themes/TwoDark/TwoDark.tmTheme
+@@ -533,7 +533,7 @@
+ 			<key>name</key>
+ 			<string>Json key</string>
+ 			<key>scope</key>
+-			<string>source.json                           meta.structure.dictionary.json                              string.quoted.double.json</string>
++			<string>source.json                           meta.mapping.key.json                              string.quoted.double.json</string>
+ 			<key>settings</key>
+ 			<dict>
+ 				<key>foreground</key>
+@@ -875,4 +875,4 @@
+ 	<key>comment</key>
+ 	<string>Work in progress</string>
+ </dict>
+-</plist>
+\ No newline at end of file
++</plist>

assets/syntaxes/02_Extra/DotENV.sublime-syntax

@@ -8,6 +8,7 @@ file_extensions:
   - .env.local
   - .env.sample
   - .env.example
+  - .env.template
   - .env.test
   - .env.test.local
   - .env.testing
@@ -23,6 +24,10 @@ file_extensions:
   - .env.defaults
   - .envrc
   - .flaskenv
+  - env
+  - env.example
+  - env.sample
+  - env.template
 scope: source.env
 contexts:
   main:

assets/syntaxes/02_Extra/INI.sublime-syntax

@@ -16,6 +16,9 @@ file_extensions:
   - url
   - URL
   - .editorconfig
+  - .coveragerc
+  - .pylintrc
+  - .gitlint
   - .hgrc
   - hgrc
 scope: source.ini

assets/syntaxes/02_Extra/Manpage.sublime-syntax

@@ -53,6 +53,16 @@ contexts:
       embed: synopsis
       escape: '(?={{section_heading}})'
 
+    - match: '^(?:COMMANDS)\b'
+      scope: markup.heading.commands.man
+      embed: commands-start
+      escape: '(?={{section_heading}})'
+
+    - match: '^(?:ENVIRONMENT\s+VARIABLES)'
+      scope: markup.heading.env.man
+      embed: environment-variables
+      escape: '(?={{section_heading}})'
+
     - match: '{{section_heading}}'
       scope: markup.heading.other.man
       embed: options # some man pages put command line options under the description heading
@@ -75,7 +85,7 @@ contexts:
 
   options:
     # command-line options like --option=value, --some-flag, or -x
-    - match: '^[ ]{7}(?=-)'
+    - match: '^[ ]{7}(?=-|\+)'
       push: expect-command-line-option
     - match: '(?:[^a-zA-Z0-9_-]|^|\s){{command_line_option}}'
       captures:
@@ -96,7 +106,7 @@ contexts:
     - include: env-var
 
   expect-command-line-option:
-    - match: '[A-Za-z0-9-]+'
+    - match: '[A-Za-z0-9-\.\?:#\$\+]+'
       scope: entity.name.command-line-option.man
     - match: '(\[)(=)'
       captures:
@@ -122,7 +132,7 @@ contexts:
       pop: true
 
   expect-parameter:
-    - match: '[A-Za-z0-9-]+'
+    - match: '[A-Za-z0-9-_]+'
       scope: variable.parameter.man
     - match: (?=\s+\|)
       pop: true
@@ -135,6 +145,10 @@ contexts:
           scope: punctuation.section.brackets.end.man
           pop: true
         - include: expect-parameter
+    - match: '<'
+      scope: punctuation.definition.generic.begin.man
+    - match: '>'
+      scope: punctuation.definition.generic.end.man
     - match: '$|(?=[],]|{{command_line_option}})'
       pop: true
 
@@ -169,3 +183,20 @@ contexts:
     - match: \[
       scope: punctuation.section.brackets.begin.man
       push: command-line-option-or-pipe
+
+  commands-start:
+    - match: (?=^[ ]{7}.*(?:[ ]<|[|]))
+      push: commands
+
+  commands:
+    - match: '^[ ]{7}([a-z_\-]+)(?=[ ]|$)'
+      captures:
+        1: entity.name.command.man
+      push: expect-parameter
+    - match: '^[ ]{7}(?=[\[<]|\w+[|\]])'
+      push: expect-parameter
+
+  environment-variables:
+    - match: '^[ ]{7}([A-Z_]+)\b'
+      captures:
+        1: support.constant.environment-variable.man

assets/syntaxes/02_Extra/Requirementstxt.sublime-syntax

@@ -0,0 +1,120 @@
+%YAML 1.2
+---
+# http://www.sublimetext.com/docs/syntax.html
+name: Requirements.txt
+scope: source.requirements-txt
+# https://pip.pypa.io/en/stable/reference/requirements-file-format/
+# https://github.com/raimon49/requirements.txt.vim/blob/f246bd10155fbc3b1a9e2fff6c95b21521b09116/ftdetect/requirements.vim
+file_extensions:
+  - requirements.txt
+  - requirements.in
+  - pip
+# https://github.com/sublimehq/Packages/pull/2760/files
+first_line_match: |-
+  (?xi:
+    ^ \#! .* \bpip                                        # shebang
+  | ^ \s* \# .*? -\*- .*? \bpip-requirements\b .*? -\*-   # editorconfig
+  | ^ \s* \# (vim?|ex): .*? \brequirements\b              # modeline
+  )
+# pip install -r
+# pip-compile
+
+variables:
+  operator: '===?|<=?|>=?|~=|!='
+
+contexts:
+  main:
+    - match: '(?i)\d+[\da-z\-_\.\*]*'
+      scope: constant.other.version-control.requirements-txt
+    - match: '(?i)^\[?--?[\da-z\-]*\]?'
+      scope: entity.name.function.option.requirements-txt
+    - match: '{{operator}}'
+      scope: keyword.operator.logical.requirements-txt
+    - match: '(\[)'
+      captures:
+        1: punctuation.section.braces.begin.requirements-txt
+      push:
+        - meta_scope: variable.function.extra.requirements-txt
+        - match: ','
+          scope: punctuation.separator.requirements-txt
+        - match: '(\])'
+          captures:
+            1: punctuation.section.braces.end.requirements-txt
+          pop: true
+    - match: '(git\+?|hg\+|svn\+|bzr\+).*://.\S+'
+      scope: markup.underline.link.versioncontrols.requirements-txt
+    - match: '(@\s)?(https?|ftp|gopher)://?[^\s/$.?#].\S*'
+      scope: markup.underline.link.url.requirements-txt
+      captures:
+        1: punctuation.definition.keyword.requirements-txt
+    - match: '(?i)^[a-z\d_\-\.]*[a-z\d]'
+      scope: variable.parameter.package-name.requirements-txt
+    - match: '(;)'
+      captures:
+        1: punctuation.definition.annotation.requirements-txt
+      push:
+        - meta_scope: meta.annotation.requirements-txt
+        # https://pip.pypa.io/en/stable/reference/inspect-report/#example
+        - match: |-
+            (?x:
+              implementation_name
+            | implementation_version
+            | os_name
+            | platform_machine
+            | platform_release
+            | platform_system
+            | platform_version
+            | python_full_version
+            | platform_python_implementation
+            | python_version
+            | sys_platform
+            )
+          scope: variable.language.requirements-txt
+        - match: '{{operator}}'
+          scope: keyword.operator.logical.requirements-txt
+          # https://pip.pypa.io/en/stable/reference/requirement-specifiers/#examples
+        - match: '(")'
+          captures:
+            1: punctuation.definition.string.begin.double.requirements-txt
+          push:
+            - meta_scope: string.quoted.double.requirements-txt
+            - match: '\\"'
+              scope: constant.character.escape.double.requirements-txt
+            - match: '(")'
+              captures:
+                1: punctuation.definition.string.end.double.requirements-txt
+              pop: true
+        - match: "(')"
+          captures:
+            1: punctuation.definition.string.begin.single.requirements-txt
+          push:
+            - meta_scope: string.quoted.single.requirements-txt
+            - match: '\\'''
+              scope: constant.character.escape.single.requirements-txt
+            - match: "(')"
+              captures:
+                1: punctuation.definition.string.end.single.requirements-txt
+              pop: true
+        - match: '(.(?=#)|$)'
+          pop: true
+    - match: '(\$)(\{)'
+      captures:
+        1: punctuation.definition.keyword.requirements-txt
+        2: punctuation.definition.begin.parameter.requirements-txt
+      push:
+        - meta_scope: variable.parameter.requirements-txt
+        - match: '(\})'
+          captures:
+            1: punctuation.definition.end.parameter.requirements-txt
+          pop: true
+    - match: '(#)'
+      captures:
+        1: punctuation.definition.comment.requirements-txt
+      push:
+        - meta_scope: comment.line.requirements-txt
+        - match: '(-*-) coding: .* (-*-)'
+          captures:
+            1: punctuation.definition.begin.pep263.requirements-txt
+            2: punctuation.definition.end.pep263.requirements-txt
+        - match: '$'
+          pop: true

assets/syntaxes/02_Extra/VimHelp.sublime-syntax

@@ -0,0 +1,104 @@
+%YAML 1.2
+---
+# http://www.sublimetext.com/docs/syntax.html
+scope: source.vimhelp
+file_extensions:
+  # shortname
+  - vimhelp
+
+# $VIMRUNTIME/syntax/help.vim
+contexts:
+  main:
+    - match: '(?<=^\s*)(vim?|ex):\s*([a-z]+(=[^\s:]+)?(\s+|:))+'
+      scope: comment.line.modeline.vimhelp
+    - match: '^[-A-Z .][-A-Z0-9 .()_]*(?=\s+\*|$)'
+      scope: markup.heading.headline.vimhelp
+    - match: '^(===.*===)$'
+      captures:
+        1: punctuation.definition.heading.1.setext.vimhelp
+      push:
+        - meta_scope: markup.heading.1.setext.vimhelp
+        - match: '\t|  '
+          pop: true
+    - match: '^(---.*---)$'
+      captures:
+        1: punctuation.definition.heading.2.setext.vimhelp
+      push:
+        - meta_scope: markup.heading.2.setext.vimhelp
+        - match: '\t|  '
+          pop: true
+    - match: '(?:^| )(>)$'
+      captures:
+        1: punctuation.definition.blockquote.begin.vimhelp
+      push:
+        - meta_scope: markup.quote.vimhelp
+        - match: '^(<)'
+          captures:
+            1: punctuation.definition.blockquote.end.vimhelp
+          pop: true
+        - match: '^(?=\S)'
+          pop: true
+    - match: '(?<!\\)(\|)([#-)!+-~]+)(\|)'
+      captures:
+        1: punctuation.definition.link.begin.vimhelp
+        2: markup.underline.link.vimhelp
+        3: punctuation.definition.link.end.vimhelp
+    - match: '(\*)([#-)!+-~]+)(\*)(?:\s|$)'
+      captures:
+        1: punctuation.definition.constant.begin.vimhelp
+        2: entity.name.reference.link.vimhelp
+        3: punctuation.definition.constant.end.vimhelp
+    - match: '\bVim version [0-9][0-9.a-z]*'
+      scope: variable.language.vimhelp
+    - match: 'N?VIM REFERENCE.*'
+      scope: variable.language.vimhelp
+    - match: '('')([a-z]{2,}|t_..)('')'
+      captures:
+        1: punctuation.definition.link.option.begin.vimhelp
+        2: markup.underline.link.option.vimhelp
+        3: punctuation.definition.link.option.end.vimhelp
+    - match: '(`)([^` \t]+)(`)'
+      captures:
+        1: punctuation.definition.link.command.begin.vimhelp
+        2: markup.underline.link.command.vimhelp
+        3: punctuation.definition.link.command.end.vimhelp
+    - match: '(?<=^|[^a-z"\[])(`)([^`]+)(`)(?=[^a-z\t."'']|$)'
+      captures:
+        1: punctuation.definition.link.command.begin.vimhelp
+        2: markup.underline.link.command.vimhelp
+        3: punctuation.definition.link.command.end.vimhelp
+    - match: '(?<=\s*)(.*?)(?=\s?)(~)$'
+      captures:
+        1: markup.heading.header.vimhelp
+        2: punctuation.definition.keyword.vimhelp
+    - match: '(.*) (?=`$)'
+      captures:
+        1: variable.other.graphic.vimhelp
+        2: punctuation.definition.keyword.vimhelp
+    - match: '\b(note:?|Note:?|NOTE:?|Notes:?)\b'
+      scope: constant.other.note.vimhelp
+    - match: '\b(WARNING:?|Warning:)\b'
+      scope: constant.other.warning.vimhelp
+    - match: '\b(DEPRECATED:?|Deprecated:)\b'
+      scope: constant.other.deprecated.vimhelp
+    - match: '(\{)([-_a-zA-Z0-9''"*+/:%#=\[\]<>.,]+)(\})'
+      captures:
+        1: punctuation.definition.constant.begin.vimhelp
+        2: constant.numeric.vimhelp
+        3: punctuation.definition.constant.end.vimhelp
+    - match: '\[(range|line|count|offset|\+?cmd|(\+|-|)num|\+\+opt)\]'
+      scope: constant.numeric.vimhelp
+    - match: '\[(arg(uments)?|ident|addr|group)\]'
+      scope: constant.numeric.vimhelp
+    - match: '\[(readonly|fifo|socket|converted|crypted)\]'
+      scope: constant.numeric.vimhelp
+    - match: '<[-a-zA-Z0-9_]+>'
+      scope: markup.underline.link.key.vimhelp
+    - match: '<[SCM]-.>'
+      scope: markup.underline.link.key.vimhelp
+    - match: 'CTRL-((SHIFT-)?.|Break|PageUp|PageDown|Insert|Del|\{char\})'
+      scope: markup.underline.link.key.vimhelp
+    - match: '(META|ALT)-.'
+      scope: markup.underline.link.key.vimhelp
+    - match: '\b(((https?|ftp|gopher)://|(mailto|file|news):)[^'' 	<>"]+|(www|web|w3)[a-z0-9_-]*\.[a-z0-9._-]+\.[^'' 	<>"]+)[a-zA-Z0-9/]'
+      scope: markup.underline.link.url.vimhelp

assets/syntaxes/02_Extra/syntax_test_helphelp.txt

@@ -0,0 +1,419 @@
+# SYNTAX TEST "VimHelp.sublime-syntax"
+*helphelp.txt*	Nvim
+# <- punctuation.definition.constant.begin
+#^^^^^^^^^^^^ entity.name.reference.link
+#            ^ punctuation.definition.constant.end
+
+
+		  VIM REFERENCE MANUAL    by Bram Moolenaar
+#   ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ variable.language
+
+
+Help on help files					*helphelp*
+
+                                      Type |gO| to see the table of contents.
+#                                          ^ punctuation.definition.link.begin
+#                                           ^^ markup.underline.link
+#                                             ^ punctuation.definition.link.end
+
+==============================================================================
+#^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ punctuation.definition.heading.1.setext
+1. Help commands					*online-help*
+#^^^^^^^^^^^^^^^ markup.heading.1.setext
+
+			*help* *<Help>* *:h* *:help* *<F1>* *i_<F1>* *i_<Help>*
+<Help>		or
+#^^^^^ markup.underline.link.key
+:h[elp]			Open a window and display the help file in read-only
+			mode.  If there is a help window open already, use
+			that one.  Otherwise, if the current window uses the
+			full width of the screen or is at least 80 characters
+			wide, the help window will appear just above the
+			current window.  Otherwise the new window is put at
+			the very top.
+			The 'helplang' option is used to select a language, if
+#      ^ punctuation.definition.link.option.begin
+#       ^^^^^^^^ markup.underline.link.option
+#               ^ punctuation.definition.link.option.end
+			the main help file is available in several languages.
+
+			Type |gO| to see the table of contents.
+
+						*{subject}* *E149* *E661*
+:h[elp] {subject}	Like ":help", additionally jump to the tag {subject}.
+			For example:  >
+				:help options
+
+<			{subject} can include wildcards such as "*", "?" and
+#   ^ punctuation.definition.constant.begin
+#    ^^^^^^^ constant.numeric
+#           ^ punctuation.definition.constant.end
+			"[a-z]":
+			   :help z?	jump to help for any "z" command
+			   :help z.	jump to the help for "z."
+			But when a tag exists it is taken literally:
+			   :help :?	jump to help for ":?"
+
+			If there is no full match for the pattern, or there
+			are several matches, the "best" match will be used.
+			A sophisticated algorithm is used to decide which
+			match is better than another one.  These items are
+			considered in the computation:
+			- A match with same case is much better than a match
+			  with different case.
+			- A match that starts after a non-alphanumeric
+			  character is better than a match in the middle of a
+			  word.
+			- A match at or near the beginning of the tag is
+			  better than a match further on.
+			- The more alphanumeric characters match, the better.
+			- The shorter the length of the match, the better.
+
+			The 'helplang' option is used to select a language, if
+			the {subject} is available in several languages.
+			To find a tag in a specific language, append "@ab",
+			where "ab" is the two-letter language code.  See
+			|help-translated|.
+
+			Note that the longer the {subject} you give, the less
+			matches will be found.  You can get an idea how this
+			all works by using commandline completion (type CTRL-D
+#                                                  ^^^^^^ markup.underline.link.key
+			after ":help subject" |c_CTRL-D|).
+			If there are several matches, you can have them listed
+			by hitting CTRL-D.  Example: >
+				:help cont<Ctrl-D>
+
+<			Instead of typing ":help CTRL-V" to search for help
+			for CTRL-V you can type: >
+				:help ^V
+<			This also works together with other characters, for
+			example to find help for CTRL-V in Insert mode: >
+				:help i^V
+<
+			It is also possible to first do ":help" and then
+			use ":tag {pattern}" in the help window.  The
+			":tnext" command can then be used to jump to other
+			matches, "tselect" to list matches and choose one. >
+				:help index
+				:tselect /.*mode
+
+<			When there is no argument you will see matches for
+			"help", to avoid listing all possible matches (that
+			would be very slow).
+			The number of matches displayed is limited to 300.
+
+			The `:help` command can be followed by '|' and another
+			command, but you don't need to escape the '|' inside a
+			help command.  So these both work: >
+				:help |
+				:help k| only
+<			Note that a space before the '|' is seen as part of
+#   ^^^^ constant.other.note
+			the ":help" argument.
+			You can also use <NL> or <CR> to separate the help
+			command from a following command.  You need to type
+			CTRL-V first to insert the <NL> or <CR>.  Example: >
+				:help so<C-V><CR>only
+<
+
+:h[elp]! [subject]	Like ":help", but in non-English help files prefer to
+			find a tag in a file with the same language as the
+			current file.  See |help-translated|.
+
+							*:helpc* *:helpclose*
+:helpc[lose]		Close one help window, if there is one.
+			Vim will try to restore the window layout (including
+			cursor position) to the same layout it was before
+			opening the help window initially.  This might cause
+			triggering several autocommands.
+
+							*:helpg* *:helpgrep*
+:helpg[rep] {pattern}[@xx]
+			Search all help text files and make a list of lines
+			in which {pattern} matches.  Jumps to the first match.
+			The optional [@xx] specifies that only matches in the
+			"xx" language are to be found.
+			You can navigate through the matches with the
+			|quickfix| commands, e.g., |:cnext| to jump to the
+			next one.  Or use |:cwindow| to get the list of
+			matches in the quickfix window.
+			{pattern} is used as a Vim regexp |pattern|.
+			'ignorecase' is not used, add "\c" to ignore case.
+			Example for case sensitive search: >
+				:helpgrep Uganda
+<			Example for case ignoring search: >
+				:helpgrep uganda\c
+<			Example for searching in French help: >
+				:helpgrep backspace@fr
+<			The pattern does not support line breaks, it must
+			match within one line.  You can use |:grep| instead,
+			but then you need to get the list of help files in a
+			complicated way.
+			Cannot be followed by another command, everything is
+			used as part of the pattern.  But you can use
+			|:execute| when needed.
+			Compressed help files will not be searched (Fedora
+			compresses the help files).
+
+							*:lh* *:lhelpgrep*
+:lh[elpgrep] {pattern}[@xx]
+			Same as ":helpgrep", except the location list is used
+			instead of the quickfix list.  If the help window is
+			already opened, then the location list for that window
+			is used.  Otherwise, a new help window is opened and
+			the location list for that window is set.  The
+			location list for the current window is not changed
+			then.
+
+							*:exu* *:exusage*
+:exu[sage]		Show help on Ex commands.  Added to simulate the Nvi
+			command.
+
+							*:viu* *:viusage*
+:viu[sage]		Show help on Normal mode commands.  Added to simulate
+			the Nvi command.
+
+When no argument is given to |:help| the file given with the 'helpfile' option
+will be opened.  Otherwise the specified tag is searched for in all "doc/tags"
+files in the directories specified in the 'runtimepath' option.
+
+If you would like to open the help in the current window, see this tip:
+|help-curwin|.
+
+The initial height of the help window can be set with the 'helpheight' option
+(default 20).
+						*help-buffer-options*
+When the help buffer is created, several local options are set to make sure
+the help text is displayed as it was intended:
+    'iskeyword'		nearly all ASCII chars except ' ', '*', '"' and '|'
+    'foldmethod'	"manual"
+    'tabstop'		8
+    'arabic'		off
+    'binary'		off
+    'buflisted'		off
+    'cursorbind'	off
+    'diff'		off
+    'foldenable'	off
+    'list'		off
+    'modifiable'	off
+    'number'		off
+    'relativenumber'	off
+    'rightleft'		off
+    'scrollbind'	off
+    'spell'		off
+
+Jump to specific subjects by using tags.  This can be done in two ways:
+- Use the "CTRL-]" command while standing on the name of a command or option.
+  This only works when the tag is a keyword.  "<C-Leftmouse>" and
+  "g<LeftMouse>" work just like "CTRL-]".
+- use the ":ta {subject}" command.  This also works with non-keyword
+  characters.
+
+Use CTRL-T or CTRL-O to jump back.
+Use ":q" to close the help window.
+
+If there are several matches for an item you are looking for, this is how you
+can jump to each one of them:
+1. Open a help window
+2. Use the ":tag" command with a slash prepended to the tag.  E.g.: >
+	:tag /min
+3. Use ":tnext" to jump to the next matching tag.
+
+It is possible to add help files for plugins and other items.  You don't need
+to change the distributed help files for that.  See |add-local-help|.
+
+To write a local help file, see |write-local-help|.
+
+Note that the title lines from the local help files are automagically added to
+the "LOCAL ADDITIONS" section in the "help.txt" help file |local-additions|.
+This is done when viewing the file in Vim, the file itself is not changed.  It
+is done by going through all help files and obtaining the first line of each
+file.  The files in $VIMRUNTIME/doc are skipped.
+
+							*help-xterm-window*
+If you want to have the help in another xterm window, you could use this
+command: >
+	:!xterm -e vim +help &
+<
+
+					*:helpt* *:helptags*
+			*E150* *E151* *E152* *E153* *E154* *E670* *E856*
+:helpt[ags] [++t] {dir}
+			Generate the help tags file(s) for directory {dir}.
+			When {dir} is ALL then all "doc" directories in
+			'runtimepath' will be used.
+
+			All "*.txt" and "*.??x" files in the directory and
+			sub-directories are scanned for a help tag definition
+			in between stars.  The "*.??x" files are for
+			translated docs, they generate the "tags-??" file, see
+			|help-translated|.  The generated tags files are
+			sorted.
+			When there are duplicates an error message is given.
+			An existing tags file is silently overwritten.
+
+			The optional "++t" argument forces adding the
+			"help-tags" tag.  This is also done when the {dir} is
+			equal to $VIMRUNTIME/doc.
+
+			To rebuild the help tags in the runtime directory
+			(requires write permission there): >
+				:helptags $VIMRUNTIME/doc
+<
+
+
+==============================================================================
+2. Translated help files				*help-translated*
+
+It is possible to add translated help files, next to the original English help
+files.  Vim will search for all help in "doc" directories in 'runtimepath'.
+
+At this moment translations are available for:
+	Chinese  - multiple authors
+	French   - translated by David Blanchet
+	Italian  - translated by Antonio Colombo
+	Japanese - multiple authors
+	Polish   - translated by Mikolaj Machowski
+	Russian  - translated by Vassily Ragosin
+See the Vim website to find them: http://www.vim.org/translations.php
+
+A set of translated help files consists of these files:
+
+	help.abx
+	howto.abx
+	...
+	tags-ab
+
+"ab" is the two-letter language code.  Thus for Italian the names are:
+
+	help.itx
+	howto.itx
+	...
+	tags-it
+
+The 'helplang' option can be set to the preferred language(s).  The default is
+set according to the environment.  Vim will first try to find a matching tag
+in the preferred language(s).  English is used when it cannot be found.
+
+To find a tag in a specific language, append "@ab" to a tag, where "ab" is the
+two-letter language code.  Example: >
+	:he user-manual@it
+	:he user-manual@en
+The first one finds the Italian user manual, even when 'helplang' is empty.
+The second one finds the English user manual, even when 'helplang' is set to
+"it".
+
+When using command-line completion for the ":help" command, the "@en"
+extension is only shown when a tag exists for multiple languages.  When the
+tag only exists for English "@en" is omitted.  When the first candidate has an
+"@ab" extension and it matches the first language in 'helplang' "@ab" is also
+omitted.
+
+When using |CTRL-]| or ":help!" in a non-English help file Vim will try to
+find the tag in the same language.  If not found then 'helplang' will be used
+to select a language.
+
+Help files must use latin1 or utf-8 encoding.  Vim assumes the encoding is
+utf-8 when finding non-ASCII characters in the first line.  Thus you must
+translate the header with "For Vim version".
+
+The same encoding must be used for the help files of one language in one
+directory.  You can use a different encoding for different languages and use
+a different encoding for help files of the same language but in a different
+directory.
+
+Hints for translators:
+- Do not translate the tags.  This makes it possible to use 'helplang' to
+  specify the preferred language.  You may add new tags in your language.
+- When you do not translate a part of a file, add tags to the English version,
+  using the "tag@en" notation.
+- Make a package with all the files and the tags file available for download.
+  Users can drop it in one of the "doc" directories and start use it.
+  Report this to Bram, so that he can add a link on www.vim.org.
+- Use the |:helptags| command to generate the tags files.  It will find all
+  languages in the specified directory.
+
+==============================================================================
+3. Writing help files					*help-writing*
+
+For ease of use, a Vim help file for a plugin should follow the format of the
+standard Vim help files, except for the first line.  If you are writing a new
+help file it's best to copy one of the existing files and use it as a
+template.
+
+The first line in a help file should have the following format:
+
+*plugin_name.txt*	{short description of the plugin}
+
+The first field is a help tag where ":help plugin_name" will jump to.  The
+remainder of the line, after a Tab, describes the plugin purpose in a short
+way.  This will show up in the "LOCAL ADDITIONS" section of the main help
+file.  Check there that it shows up properly: |local-additions|.
+
+If you want to add a version number or last modification date, put it in the
+second line, right aligned.
+
+At the bottom of the help file, place a Vim modeline to set the 'textwidth'
+and 'tabstop' options and the 'filetype' to "help".  Never set a global option
+in such a modeline, that can have undesired consequences.
+
+
+TAGS
+
+To define a help tag, place the name between asterisks (*tag-name*).  The
+tag-name should be different from all the Vim help tag names and ideally
+should begin with the name of the Vim plugin.  The tag name is usually right
+aligned on a line.
+
+When referring to an existing help tag and to create a hot-link, place the
+name between two bars (|) eg. |help-writing|.
+
+When referring to a Vim command and to create a hot-link, place the
+name between two backticks, eg. inside `:filetype`.  You will see this is
+highlighted as a command, like a code block (see below).
+
+When referring to a Vim option in the help file, place the option name between
+two single quotes, eg. 'statusline'
+
+When referring to any other technical term, such as a filename or function
+parameter, surround it in backticks, eg. `~/.path/to/init.vim`.
+
+
+HIGHLIGHTING
+
+To define a column heading, use a tilde character at the end of the line.
+This will highlight the column heading in a different color.  E.g.
+
+Column heading~
+#^^^^^^^^^^^^^ markup.heading.header
+#             ^ punctuation.definition.keyword
+
+To separate sections in a help file, place a series of '=' characters in a
+line starting from the first column.  The section separator line is highlighted
+differently.
+
+To quote a block of ex-commands verbatim, place a greater than (>) character
+at the end of the line before the block and a less than (<) character as the
+first non-blank on a line following the block.  Any line starting in column 1
+also implicitly stops the block of ex-commands before it.  E.g. >
+    function Example_Func()
+	echo "Example"
+    endfunction
+<
+
+The following are highlighted differently in a Vim help file:
+  - a special key name expressed either in <> notation as in <PageDown>, or
+    as a Ctrl character as in CTRL-X
+  - anything between {braces}, e.g. {lhs} and {rhs}
+
+The word "Note", "Notes" and similar automagically receive distinctive
+highlighting.  So do these:
+	*Todo	something to do
+	*Error	something wrong
+
+You can find the details in $VIMRUNTIME/syntax/help.vim
+
+
+ vim:tw=78:ts=8:noet:ft=help:norl:
+#^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ comment.line.modeline

assets/syntaxes/02_Extra/syntax_test_man.man

@@ -157,6 +157,108 @@ ENVIRONMENT
            systemd reads the log level from this environment variable. This
            can be overridden with --log-level=.
 
+ENVIRONMENT VARIABLES
+       Various Git commands use the following environment variables:
+
+   The Git Repository
+       These environment variables apply to all core Git commands. Nb: it is
+       worth noting that they may be used/overridden by SCMS sitting above Git
+       so take care if using a foreign front-end.
+
+       GIT_INDEX_FILE
+#      ^^^^^^^^^^^^^^ support.constant.environment-variable
+           This environment allows the specification of an alternate index
+           file. If not specified, the default of $GIT_DIR/index is used.
+
+       GIT_INDEX_VERSION
+#      ^^^^^^^^^^^^^^^^^ support.constant.environment-variable
+           This environment variable allows the specification of an index
+           version for new repositories. It won’t affect existing index files.
+           By default index file version 2 or 3 is used. See git-update-
+           index(1) for more information.
+
+COMMANDS
+       This section only lists general commands. For input and output com‐
+       mands, refer to sway-input(5) and sway-output(5).
+
+       The following commands may only be used in the configuration file.
+
+       bar [<bar-id>] <bar-subcommands...>
+#      ^^^ entity.name.command
+#          ^ punctuation.section.brackets.begin
+#           ^ punctuation.definition.generic.begin
+#            ^^^^^^ variable.parameter
+#                  ^ punctuation.definition.generic.end
+#                   ^ punctuation.section.brackets.end
+#                     ^ punctuation.definition.generic.begin
+#                      ^^^^^^^^^^^^^^^ variable.parameter
+#                                        ^ punctuation.definition.generic.end
+           For details on bar subcommands, see sway-bar(5).
+
+       default_orientation horizontal|vertical|auto
+#      ^^^^^^^^^^^^^^^^^^^ entity.name.command
+#                          ^^^^^^^^^^ variable.parameter
+#                                    ^ keyword.operator.logical
+#                                     ^^^^^^^^ variable.parameter
+#                                             ^ keyword.operator.logical
+#                                              ^^^^ variable.parameter
+           Sets the default container layout for tiled containers.
+
+       include <path>
+           Includes another file from path. path can be either a full path or
+           a path relative to the parent config, and expands shell syntax (see
+           wordexp(3) for details). The same include file can only be included
+           once; subsequent attempts will be ignored.
+
+       The following commands cannot be used directly in the configuration
+#      ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - variable - entity
+       file. They are expected to be used with bindsym or at runtime through
+#      ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - variable - entity
+       swaymsg(1).
+
+       border none|normal|csd|pixel [<n>]
+           Set border style for focused window. normal includes a border of
+           thickness n and a title bar. pixel is a border without title bar n
+           pixels thick. Default is normal with border thickness 2. csd is
+           short for client-side-decorations, which allows the client to draw
+           its own decorations.
+
+       border toggle
+#      ^^^^^^ entity.name.command
+           Cycles through the available border styles.
+
+       exit
+#      ^^^^ entity.name.command
+           Exit sway and end your Wayland session.
+
+       floating enable|disable|toggle
+           Make focused view floating, non-floating, or the opposite of what
+           it is now.
+
+       <criteria> focus
+#      ^ punctuation.definition.generic.begin
+#       ^^^^^^^^ variable.parameter
+#               ^ punctuation.definition.generic.end
+#                 ^^^^^ variable.parameter
+           Moves focus to the container that matches the specified criteria.
+
+       gaps inner|outer|horizontal|vertical|top|right|bottom|left all|current
+       set|plus|minus|toggle <amount>
+#      ^^^ variable.parameter
+#         ^ keyword.operator.logical
+           Changes the inner or outer gaps for either all workspaces or the
+           current workspace. outer gaps can be altered per side with top,
+           right, bottom, and left or per direction with horizontal and verti‐
+           cal.
+
+       layout toggle [split|tabbed|stacking|splitv|splith]
+       [split|tabbed|stacking|splitv|splith]...
+#      ^ punctuation.section.brackets.begin
+#       ^^^^^ variable.parameter
+#            ^ keyword.operator.logical
+           Cycles the layout mode of the focused container through a list of
+           layouts.
+
 SEE ALSO
        The systemd Homepage[11], systemd-system.conf(5), locale.conf(5)
 #                                ^^^^^^^^^^^^^^^^^^^ entity.name.function

assets/syntaxes/02_Extra/syntax_test_requirements.txt

@@ -0,0 +1,82 @@
+# SYNTAX TEST "Requirementstxt.sublime-syntax"
+# Options
+# <- punctuation.definition.comment
+# ^^^^^^^ comment.line
+--allow-external
+#^^^^^^^^^^^^^^^ entity.name.function.option
+--allow-unverified
+
+# Freeze packages
+alabaster==0.7.6
+Babel>=2.9.1
+docutils==0.12
+gevent_subprocess==0.1.2
+gitpython==3.0.7
+hg-diff==1.2.4
+#^^^^^^ variable.parameter.package-name
+#      ^^ keyword.operator.logical
+#        ^^^^^ constant.other
+Jinja2>=2.8.1
+MarkupSafe==0.23
+Pygments==2.7.4
+pytz==2015.7
+six==1.10.0
+snowballstemmer==1.2.0
+Sphinx==1.3.3
+sphinx-rtd-theme==0.1.9
+svn==1.0.1
+zope.interface==4.2.0
+
+# Examples from PEP508
+# c.f. https://www.python.org/dev/peps/pep-0508/
+requests [security,tests] >= 2.8.1, == 2.8.* ; python_version < "2.7" # Comment
+#^^^^^^^ variable.parameter.package-name
+#        ^^^^^^^^^^^^^^^^ variable.function.extra
+#        ^ punctuation.section.braces.begin
+#                 ^ punctuation.separator
+#                       ^ punctuation.section.braces.end
+#                         ^^ keyword.operator.logical
+#                            ^^^^^ constant.other
+#                                   ^^ keyword.operator.logical
+#                                      ^^^^^ constant.other
+#                                            ^ punctuation.definition.annotation
+#                                            ^^^^^^^^^^^^^^^^^^^^^^^^ meta.annotation
+#                                              ^^^^^^^^^^^^^^ variable.language
+#                                                             ^ keyword.operator.logical
+#                                                               ^ punctuation.definition.string.begin.double
+#                                                               ^^^^^ string.quoted.double.requirements-txt
+#                                                                   ^ punctuation.definition.string.end.double
+#                                                                     ^^^^^^^^^ comment.line
+pip @ https://github.com/pypa/pip/archive/1.3.1.zip#sha1=da9234ee9982d4bbb3c72346a6de940a148ea686
+#   ^ punctuation.definition.keyword
+#   ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ markup.underline.link.url
+name @ gopher:/foo/com"
+foobar[quux]<2,>=3; os_name=='a'
+
+# VCS repositories
+-e git+git://git.myproject.org/MyProject#egg=MyProject # Git
+# <- entity.name.function.option
+#^ entity.name.function.option
+#  ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ markup.underline.link.versioncontrols
+#                                       ^^^^^^^^^^^^^^^ - comment.line
+#                                                      ^^^^^ comment.line
+-e git://git.myproject.org/MyProject.git@v1.0#egg=MyProject
+#  ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ markup.underline.link.versioncontrols
+-e hg+https://hg.myproject.org/MyProject#egg=MyProject # Mercurial
+#  ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ markup.underline.link.versioncontrols
+#                                                      ^^^^^^^^^^^ comment.line
+-e hg+http://hg.myproject.org/MyProject@da39a3ee5e6b#egg=MyProject
+#  ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ markup.underline.link.versioncontrols
+-e svn+http://svn.myproject.org/svn/MyProject/trunk@2019#egg=MyProject # Subversion
+#  ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ markup.underline.link.versioncontrols
+#                                                                      ^^^^^^^^^^^^ comment.line
+-e bzr+ssh://user@myproject.org/MyProject/trunk#egg=MyProject # Bazaar
+#  ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ markup.underline.link.versioncontrols
+#                                                             ^^^^^^^^ comment.line
+-e bzr+https://bzr.myproject.org/MyProject/trunk@2019#egg=MyProject
+#  ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ markup.underline.link.versioncontrols
+
+# Project or archive URL
+https://github.com/pallets/click/archive/7.0.zip#egg=click
+#^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ markup.underline.link.url
+#                                               ^^^^^^^^^^ - comment.line

assets/syntaxes/02_Extra/wgsl.sublime-syntax

@@ -0,0 +1,198 @@
+%YAML 1.2
+---
+# http://www.sublimetext.com/docs/syntax.html
+name: WGSL
+file_extensions:
+  - wgsl
+scope: source.wgsl
+contexts:
+  main:
+    - include: line_comments
+    - include: block_comments
+    - include: keywords
+    - include: attributes
+    - include: functions
+    - include: function_calls
+    - include: constants
+    - include: types
+    - include: variables
+    - include: punctuation
+  attributes:
+    - match: '(@)([A-Za-z_]+)'
+      comment: attribute declaration
+      scope: meta.attribute.wgsl
+      captures:
+        1: keyword.operator.attribute.at
+        2: entity.name.attribute.wgsl
+  block_comments:
+    - match: /\*\*/
+      comment: empty block comments
+      scope: comment.block.wgsl
+    - match: /\*\*
+      comment: block documentation comments
+      push:
+        - meta_scope: comment.block.documentation.wgsl
+        - match: \*/
+          pop: true
+        - include: block_comments
+    - match: /\*(?!\*)
+      comment: block comments
+      push:
+        - meta_scope: comment.block.wgsl
+        - match: \*/
+          pop: true
+        - include: block_comments
+  constants:
+    - match: '(-?\b[0-9][0-9]*\.[0-9][0-9]*)([eE][+-]?[0-9]+)?\b'
+      comment: decimal float literal
+      scope: constant.numeric.float.wgsl
+    - match: '-?\b0x[0-9a-fA-F]+\b|\b0\b|-?\b[1-9][0-9]*\b'
+      comment: int literal
+      scope: constant.numeric.decimal.wgsl
+    - match: '\b0x[0-9a-fA-F]+u\b|\b0u\b|\b[1-9][0-9]*u\b'
+      comment: uint literal
+      scope: constant.numeric.decimal.wgsl
+    - match: \b(true|false)\b
+      comment: boolean constant
+      scope: constant.language.boolean.wgsl
+  function_calls:
+    - match: '([A-Za-z0-9_]+)(\()'
+      comment: function/method calls
+      captures:
+        1: entity.name.function.wgsl
+        2: punctuation.brackets.round.wgsl
+      push:
+        - meta_scope: meta.function.call.wgsl
+        - match: \)
+          captures:
+            0: punctuation.brackets.round.wgsl
+          pop: true
+        - include: line_comments
+        - include: block_comments
+        - include: keywords
+        - include: attributes
+        - include: function_calls
+        - include: constants
+        - include: types
+        - include: variables
+        - include: punctuation
+  functions:
+    - match: '\b(fn)\s+([A-Za-z0-9_]+)((\()|(<))'
+      comment: function definition
+      captures:
+        1: keyword.other.fn.wgsl
+        2: entity.name.function.wgsl
+        4: punctuation.brackets.round.wgsl
+      push:
+        - meta_scope: meta.function.definition.wgsl
+        - match: '\{'
+          captures:
+            0: punctuation.brackets.curly.wgsl
+          pop: true
+        - include: line_comments
+        - include: block_comments
+        - include: keywords
+        - include: attributes
+        - include: function_calls
+        - include: constants
+        - include: types
+        - include: variables
+        - include: punctuation
+  keywords:
+    - match: \b(bitcast|block|break|case|continue|continuing|default|discard|else|elseif|enable|fallthrough|for|function|if|loop|private|read|read_write|return|storage|switch|uniform|while|workgroup|write)\b
+      comment: other keywords
+      scope: keyword.control.wgsl
+    - match: \b(asm|const|do|enum|handle|mat|premerge|regardless|typedef|unless|using|vec|void)\b
+      comment: reserved keywords
+      scope: keyword.control.wgsl
+    - match: \b(let|var)\b
+      comment: storage keywords
+      scope: keyword.other.wgsl storage.type.wgsl
+    - match: \b(type)\b
+      comment: type keyword
+      scope: keyword.declaration.type.wgsl storage.type.wgsl
+    - match: \b(enum)\b
+      comment: enum keyword
+      scope: keyword.declaration.enum.wgsl storage.type.wgsl
+    - match: \b(struct)\b
+      comment: struct keyword
+      scope: keyword.declaration.struct.wgsl storage.type.wgsl
+    - match: \bfn\b
+      comment: fn
+      scope: keyword.other.fn.wgsl
+    - match: (\^|\||\|\||&&|<<|>>|!)(?!=)
+      comment: logical operators
+      scope: keyword.operator.logical.wgsl
+    - match: '&(?![&=])'
+      comment: logical AND, borrow references
+      scope: keyword.operator.borrow.and.wgsl
+    - match: (\+=|-=|\*=|/=|%=|\^=|&=|\|=|<<=|>>=)
+      comment: assignment operators
+      scope: keyword.operator.assignment.wgsl
+    - match: '(?<![<>])=(?!=|>)'
+      comment: single equal
+      scope: keyword.operator.assignment.equal.wgsl
+    - match: (=(=)?(?!>)|!=|<=|(?<!=)>=)
+      comment: comparison operators
+      scope: keyword.operator.comparison.wgsl
+    - match: '(([+%]|(\*(?!\w)))(?!=))|(-(?!>))|(/(?!/))'
+      comment: math operators
+      scope: keyword.operator.math.wgsl
+    - match: \.(?!\.)
+      comment: dot access
+      scope: keyword.operator.access.dot.wgsl
+    - match: '->'
+      comment: dashrocket, skinny arrow
+      scope: keyword.operator.arrow.skinny.wgsl
+  line_comments:
+    - match: \s*//.*
+      comment: single line comment
+      scope: comment.line.double-slash.wgsl
+  punctuation:
+    - match: ','
+      comment: comma
+      scope: punctuation.comma.wgsl
+    - match: '[{}]'
+      comment: curly braces
+      scope: punctuation.brackets.curly.wgsl
+    - match: '[()]'
+      comment: parentheses, round brackets
+      scope: punctuation.brackets.round.wgsl
+    - match: ;
+      comment: semicolon
+      scope: punctuation.semi.wgsl
+    - match: '[\[\]]'
+      comment: square brackets
+      scope: punctuation.brackets.square.wgsl
+    - match: '(?<![=-])[<>]'
+      comment: angle brackets
+      scope: punctuation.brackets.angle.wgsl
+  types:
+    - match: \b(bool|i32|u32|f32)\b
+      comment: scalar Types
+      scope: storage.type.wgsl
+    - match: \b(i64|u64|f64)\b
+      comment: reserved scalar Types
+      scope: storage.type.wgsl
+    - match: \b(vec2i|vec3i|vec4i|vec2u|vec3u|vec4u|vec2f|vec3f|vec4f|vec2h|vec3h|vec4h)\b
+      comment: vector type aliasses
+      scope: storage.type.wgsl
+    - match: \b(mat2x2f|mat2x3f|mat2x4f|mat3x2f|mat3x3f|mat3x4f|mat4x2f|mat4x3f|mat4x4f|mat2x2h|mat2x3h|mat2x4h|mat3x2h|mat3x3h|mat3x4h|mat4x2h|mat4x3h|mat4x4h)\b
+      comment: matrix type aliasses
+      scope: storage.type.wgsl
+    - match: '\b(vec[2-4]|mat[2-4]x[2-4])\b'
+      comment: vector/matrix types
+      scope: storage.type.wgsl
+    - match: \b(atomic)\b
+      comment: atomic types
+      scope: storage.type.wgsl
+    - match: \b(array)\b
+      comment: array types
+      scope: storage.type.wgsl
+    - match: '\b([A-Z][A-Za-z0-9]*)\b'
+      comment: Custom type
+      scope: entity.name.type.wgsl
+  variables:
+    - match: '\b(?<!(?<!\.)\.)(?:r#(?!(crate|[Ss]elf|super)))?[a-z0-9_]+\b'
+      comment: variables
+      scope: variable.other.wgsl

build.rs

@@ -43,7 +43,9 @@ fn main() -> Result<(), Box<dyn std::error::Error>> {
     variables.insert("PROJECT_EXECUTABLE_UPPERCASE", &executable_name_uppercase);
     variables.insert("PROJECT_VERSION", PROJECT_VERSION);
 
-    let out_dir_env = std::env::var_os("OUT_DIR").expect("OUT_DIR to be set in build.rs");
+    let out_dir_env = std::env::var_os("BAT_ASSETS_GEN_DIR")
+        .or_else(|| std::env::var_os("OUT_DIR"))
+        .expect("BAT_ASSETS_GEN_DIR or OUT_DIR to be set in build.rs");
     let out_dir = Path::new(&out_dir_env);
 
     fs::create_dir_all(out_dir.join("assets/manual")).unwrap();

doc/README-ja.md

@@ -186,7 +186,7 @@ man 2 select
 ###  On Ubuntu (`apt` を使用)
 *... や他のDebianベースのLinuxディストリビューション*
 
-Ubuntu Eoan 19.10 または Debian 不安定版 sid 以降の [the Ubuntu `bat` package](https://packages.ubuntu.com/eoan/bat) または [the Debian `bat` package](https://packages.debian.org/sid/bat) からインストールできます:
+[20.04 ("Focal") 以降の Ubuntu](https://packages.ubuntu.com/search?keywords=bat&exact=1) または [2021 年 8 月以降の Debian (Debian 11 - "Bullseye")](https://packages.debian.org/bullseye/bat) では `bat` パッケージが利用できます。
 
 ```bash
 apt install bat
@@ -366,7 +366,7 @@ ansible-galaxy install aeimer.install_bat
 ### From source
 
 
-`bat` をソースからビルドしたいならば、Rust 1.60.0 以上の環境が必要です。
+`bat` をソースからビルドしたいならば、Rust 1.70.0 以上の環境が必要です。
 `cargo` を使用してビルドすることができます:
 
 ```bash

doc/README-ko.md

@@ -416,7 +416,7 @@ scoop install bat
 
 ### 소스에서
 
-`bat`의 소스를 빌드하기 위해서는, Rust 1.60.0 이상이 필요합니다.
+`bat`의 소스를 빌드하기 위해서는, Rust 1.70.0 이상이 필요합니다.
 `cargo`를 이용해 전부 빌드할 수 있습니다:
 
 ```bash

doc/README-ru.md

@@ -130,8 +130,8 @@ git show v0.6.0:src/main.rs | bat -l rs
 
 #### `xclip`
 
-Нумерация стро и отображение изменений затрудняет копирование содержимого файлов в буфер обмена.
-Чтобы спроваиться с этим, используйте флаг `-p`/`--plain` или просто перенаправьте стандартный вывод в `xclip`:
+Нумерация строк и отображение изменений затрудняет копирование содержимого файлов в буфер обмена.
+Чтобы справиться с этим, используйте флаг `-p`/`--plain` или просто перенаправьте стандартный вывод в `xclip`:
 ```bash
 bat main.cpp | xclip
 ```
@@ -344,7 +344,7 @@ ansible-galaxy install aeimer.install_bat
 
 ### Из исходников
 
-Если вы желаете установить `bat` из исходников, вам понадобится Rust 1.60.0 или выше. После этого используйте `cargo`, чтобы все скомпилировать:
+Если вы желаете установить `bat` из исходников, вам понадобится Rust 1.70.0 или выше. После этого используйте `cargo`, чтобы все скомпилировать:
 
 ```bash
 cargo install --locked bat
@@ -487,7 +487,7 @@ bat --generate-config-file
 # Использовать синтаксис C++ для всех Arduino .ino файлов
 --map-syntax "*.ino:C++"
 
-# Использовать синтаксик Git Ignore для всех файлов .ignore
+# Использовать синтаксис Git Ignore для всех файлов .ignore
 --map-syntax ".ignore:Git Ignore"
 ```
 
@@ -535,7 +535,7 @@ bat() {
 `bat` поддерживает терминалы *с* и *без* поддержки truecolor. Однако подсветка синтаксиса не оптимизирована для терминалов с 8-битными цветами, и рекомендуется использовать терминалы с поддержкой 24-битных цветов (`terminator`, `konsole`, `iTerm2`, ...).
 Смотрите [эту статью](https://gist.github.com/XVilka/8346728) для полного списка терминалов.
 
-Удостовертесь, что переменная `COLORTERM` равна `truecolor` или
+Удостоверьтесь, что переменная `COLORTERM` равна `truecolor` или
 `24bit`. Иначе `bat` не сможет определить поддержку 24-битных цветов (и будет использовать 8-битные).
 
 ### Текст и номера строк плохо видны
@@ -550,7 +550,7 @@ bat() {
 ``` bash
 iconv -f ISO-8859-1 -t UTF-8 my-file.php | bat
 ```
-Внимание: вам может понадобится флаг `-l`/`--language`, если `bat` не сможет автоматически определить синтаксис.
+Внимание: вам может понадобиться флаг `-l`/`--language`, если `bat` не сможет автоматически определить синтаксис.
 
 ## Разработка
 
@@ -568,7 +568,7 @@ cargo test
 # Установка (релизная версия)
 cargo install --locked
 
-# Компилирование исполняего файла bat с другим синтаксисом и темами
+# Компилирование исполняемого файла bat с другим синтаксисом и темами
 bash assets/create.sh
 cargo install --locked --force
 ```
@@ -592,6 +592,6 @@ cargo install --locked --force
 ## Лицензия
 Copyright (c) 2018-2021 [Разработчики bat](https://github.com/sharkdp/bat).
 
-`bat` распостраняется под лицензями MIT License и Apache License 2.0 (на выбор пользователя).
+`bat` распространяется под лицензиями MIT License и Apache License 2.0 (на выбор пользователя).
 
 Смотрите [LICENSE-APACHE](LICENSE-APACHE) и [LICENSE-MIT](LICENSE-MIT) для более подробного ознакомления.

doc/README-zh.md

@@ -372,7 +372,7 @@ scoop install bat
 
 ### 从源码编译
 
-如果你想要自己构建`bat`，那么你需要安装有高于1.58.0版本的 Rust。
+如果你想要自己构建`bat`，那么你需要安装有高于1.70.0版本的 Rust。
 
 使用以下命令编译。
 

doc/assets.md

@@ -16,6 +16,9 @@ in the `.sublime-syntax` format.
 2. If the Sublime Text syntax is only available as a `.tmLanguage` file, open the file in
    Sublime Text and convert it to a `.sublime-syntax` file via *Tools* -> *Developer* ->
    *New Syntax from XXX.tmLanguage...*. Save the new file in the `assets/syntaxes` folder.
+   If only `.tmLanguage.json` or `.tmLanguage.yml` file is available, use
+   [PackageDev](https://packagecontrol.io/packages/PackageDev) to convert it to `.tmLanguage.plist`
+   format and then rename the converted file to `.tmLanguage` file.
 
 3. Run the `assets/create.sh` script. It calls `bat cache --build` to parse all available
    `.sublime-syntax` files and serialize them to a `syntaxes.bin` file.
@@ -77,12 +80,14 @@ themes (`bat cache --clear`).
 
 The following files have been manually modified after converting from a `.tmLanguage` file:
 
-* `Apache.sublime_syntax`=> removed `.conf` and `.CONF` file types.
+* `Apache.sublime_syntax`=> removed `conf` and `CONF` file types.
 * `Dart.sublime-syntax` => removed `#regex.dart` include.
-* `INI.sublime-syntax` => added `.hgrc`, `hgrc`, and `desktop` file types and support for comments after section headers
+* `DotENV.sublime-syntax` => added `.env.template`, `env` and `env.*` file types ([upstream PR](https://github.com/zaynali53/DotENV/pull/17)).
+* `INI.sublime-syntax` => added `.coveragerc`, `.pylintrc`, `.gitlint`, `.hgrc`, `hgrc`, and `desktop` file types and support for comments after section headers.
 * `Org mode.sublime-syntax` => removed `task` file type.
+* `Robot.sublime_syntax` => changed name to "Robot Framework", added `.resource` extension.
 * `SML.sublime_syntax` => removed `ml` file type.
-* `Robot.sublime_syntax` => changed name to "Robot Framework", added `.resource` extension
+* `wgsl.sublime-syntax` => added `wgsl` file extension.
 
 ### Non-submodule additions
 

doc/long-help.txt

@@ -0,0 +1,167 @@
+A cat(1) clone with syntax highlighting and Git integration.
+
+Usage: bat [OPTIONS] [FILE]...
+       bat <COMMAND>
+
+Arguments:
+  [FILE]...
+          File(s) to print / concatenate. Use a dash ('-') or no argument at all to read from
+          standard input.
+
+Options:
+  -A, --show-all
+          Show non-printable characters like space, tab or newline. This option can also be used to
+          print binary files. Use '--tabs' to control the width of the tab-placeholders.
+
+      --nonprintable-notation <notation>
+          Set notation for non-printable characters.
+          
+          Possible values:
+            * unicode (␇, ␊, ␀, ..)
+            * caret   (^G, ^J, ^@, ..)
+
+  -p, --plain...
+          Only show plain style, no decorations. This is an alias for '--style=plain'. When '-p' is
+          used twice ('-pp'), it also disables automatic paging (alias for '--style=plain
+          --paging=never').
+
+  -l, --language <language>
+          Explicitly set the language for syntax highlighting. The language can be specified as a
+          name (like 'C++' or 'LaTeX') or possible file extension (like 'cpp', 'hpp' or 'md'). Use
+          '--list-languages' to show all supported language names and file extensions.
+
+  -H, --highlight-line <N:M>
+          Highlight the specified line ranges with a different background color For example:
+            '--highlight-line 40' highlights line 40
+            '--highlight-line 30:40' highlights lines 30 to 40
+            '--highlight-line :40' highlights lines 1 to 40
+            '--highlight-line 40:' highlights lines 40 to the end of the file
+            '--highlight-line 30:+10' highlights lines 30 to 40
+
+      --file-name <name>
+          Specify the name to display for a file. Useful when piping data to bat from STDIN when bat
+          does not otherwise know the filename. Note that the provided file name is also used for
+          syntax detection.
+
+  -d, --diff
+          Only show lines that have been added/removed/modified with respect to the Git index. Use
+          --diff-context=N to control how much context you want to see.
+
+      --diff-context <N>
+          Include N lines of context around added/removed/modified lines when using '--diff'.
+
+      --tabs <T>
+          Set the tab width to T spaces. Use a width of 0 to pass tabs through directly
+
+      --wrap <mode>
+          Specify the text-wrapping mode (*auto*, never, character). The '--terminal-width' option
+          can be used in addition to control the output width.
+
+  -S, --chop-long-lines
+          Truncate all lines longer than screen width. Alias for '--wrap=never'.
+
+      --terminal-width <width>
+          Explicitly set the width of the terminal instead of determining it automatically. If
+          prefixed with '+' or '-', the value will be treated as an offset to the actual terminal
+          width. See also: '--wrap'.
+
+  -n, --number
+          Only show line numbers, no other decorations. This is an alias for '--style=numbers'
+
+      --color <when>
+          Specify when to use colored output. The automatic mode only enables colors if an
+          interactive terminal is detected - colors are automatically disabled if the output goes to
+          a pipe.
+          Possible values: *auto*, never, always.
+
+      --italic-text <when>
+          Specify when to use ANSI sequences for italic text in the output. Possible values: always,
+          *never*.
+
+      --decorations <when>
+          Specify when to use the decorations that have been specified via '--style'. The automatic
+          mode only enables decorations if an interactive terminal is detected. Possible values:
+          *auto*, never, always.
+
+  -f, --force-colorization
+          Alias for '--decorations=always --color=always'. This is useful if the output of bat is
+          piped to another program, but you want to keep the colorization/decorations.
+
+      --paging <when>
+          Specify when to use the pager. To disable the pager, use --paging=never' or its
+          alias,'-P'. To disable the pager permanently, set BAT_PAGING to 'never'. To control which
+          pager is used, see the '--pager' option. Possible values: *auto*, never, always.
+
+      --pager <command>
+          Determine which pager is used. This option will override the PAGER and BAT_PAGER
+          environment variables. The default pager is 'less'. To control when the pager is used, see
+          the '--paging' option. Example: '--pager "less -RF"'.
+
+  -m, --map-syntax <glob:syntax>
+          Map a glob pattern to an existing syntax name. The glob pattern is matched on the full
+          path and the filename. For example, to highlight *.build files with the Python syntax, use
+          -m '*.build:Python'. To highlight files named '.myignore' with the Git Ignore syntax, use
+          -m '.myignore:Git Ignore'. Note that the right-hand side is the *name* of the syntax, not
+          a file extension.
+
+      --ignored-suffix <ignored-suffix>
+          Ignore extension. For example:
+            'bat --ignored-suffix ".dev" my_file.json.dev' will use JSON syntax, and ignore '.dev'
+
+      --theme <theme>
+          Set the theme for syntax highlighting. Use '--list-themes' to see all available themes. To
+          set a default theme, add the '--theme="..."' option to the configuration file or export
+          the BAT_THEME environment variable (e.g.: export BAT_THEME="...").
+
+      --list-themes
+          Display a list of supported themes for syntax highlighting.
+
+      --style <components>
+          Configure which elements (line numbers, file headers, grid borders, Git modifications, ..)
+          to display in addition to the file contents. The argument is a comma-separated list of
+          components to display (e.g. 'numbers,changes,grid') or a pre-defined style ('full'). To
+          set a default style, add the '--style=".."' option to the configuration file or export the
+          BAT_STYLE environment variable (e.g.: export BAT_STYLE="..").
+          
+          Possible values:
+          
+            * default: enables recommended style components (default).
+            * full: enables all available components.
+            * auto: same as 'default', unless the output is piped.
+            * plain: disables all available components.
+            * changes: show Git modification markers.
+            * header: alias for 'header-filename'.
+            * header-filename: show filenames before the content.
+            * header-filesize: show file sizes before the content.
+            * grid: vertical/horizontal lines to separate side bar
+                    and the header from the content.
+            * rule: horizontal lines to delimit files.
+            * numbers: show line numbers in the side bar.
+            * snip: draw separation lines between distinct line ranges.
+
+  -r, --line-range <N:M>
+          Only print the specified range of lines for each file. For example:
+            '--line-range 30:40' prints lines 30 to 40
+            '--line-range :40' prints lines 1 to 40
+            '--line-range 40:' prints lines 40 to the end of the file
+            '--line-range 40' only prints line 40
+            '--line-range 30:+10' prints lines 30 to 40
+
+  -L, --list-languages
+          Display a list of supported languages for syntax highlighting.
+
+  -u, --unbuffered
+          This option exists for POSIX-compliance reasons ('u' is for 'unbuffered'). The output is
+          always unbuffered - this option is simply ignored.
+
+      --diagnostic
+          Show diagnostic information for bug reports.
+
+      --acknowledgements
+          Show acknowledgements.
+
+  -h, --help
+          Print help (see a summary with '-h')
+
+  -V, --version
+          Print version

doc/release-checklist.md

@@ -5,7 +5,7 @@
 - [ ] Update version in `Cargo.toml`. Run `cargo build` to update `Cargo.lock`.
       Make sure to `git add` the `Cargo.lock` changes as well.
 - [ ] Find the current min. supported Rust version by running
-      `grep '^\s*MIN_SUPPORTED_RUST_VERSION' .github/workflows/CICD.yml`.
+      `cargo metadata --no-deps --format-version 1 | jq -r '.packages[0].rust_version'`.
 - [ ] Update the version and the min. supported Rust version in `README.md` and
       `doc/README-*.md`. Check with
       `git grep -i -e 'rust.*1\.' -e '1\..*rust' | grep README | grep -v tests/`.
@@ -20,7 +20,7 @@
 
 ## Documentation
 
-- [ ] Review `-h`, `--help`, and the `man` page. All of these are shown in
+- [ ] Review [`-h`](./short-help.txt), [`--help`](./long-help.txt), and the `man` page. The `man` page is shown in
       the output of the CI job called *Documentation*, so look there.
       The CI workflow corresponding to the tip of the master branch is a good place to look.
 
@@ -70,4 +70,4 @@
 ## `bat` as a library
 
 
-```
+```

doc/short-help.txt

@@ -0,0 +1,56 @@
+A cat(1) clone with wings.
+
+Usage: bat [OPTIONS] [FILE]...
+       bat <COMMAND>
+
+Arguments:
+  [FILE]...  File(s) to print / concatenate. Use '-' for standard input.
+
+Options:
+  -A, --show-all
+          Show non-printable characters (space, tab, newline, ..).
+      --nonprintable-notation <notation>
+          Set notation for non-printable characters.
+  -p, --plain...
+          Show plain style (alias for '--style=plain').
+  -l, --language <language>
+          Set the language for syntax highlighting.
+  -H, --highlight-line <N:M>
+          Highlight lines N through M.
+      --file-name <name>
+          Specify the name to display for a file.
+  -d, --diff
+          Only show lines that have been added/removed/modified.
+      --tabs <T>
+          Set the tab width to T spaces.
+      --wrap <mode>
+          Specify the text-wrapping mode (*auto*, never, character).
+  -S, --chop-long-lines
+          Truncate all lines longer than screen width. Alias for '--wrap=never'.
+  -n, --number
+          Show line numbers (alias for '--style=numbers').
+      --color <when>
+          When to use colors (*auto*, never, always).
+      --italic-text <when>
+          Use italics in output (always, *never*)
+      --decorations <when>
+          When to show the decorations (*auto*, never, always).
+      --paging <when>
+          Specify when to use the pager, or use `-P` to disable (*auto*, never, always).
+  -m, --map-syntax <glob:syntax>
+          Use the specified syntax for files matching the glob pattern ('*.cpp:C++').
+      --theme <theme>
+          Set the color theme for syntax highlighting.
+      --list-themes
+          Display all supported highlighting themes.
+      --style <components>
+          Comma-separated list of style elements to display (*default*, auto, full, plain, changes,
+          header, header-filename, header-filesize, grid, rule, numbers, snip).
+  -r, --line-range <N:M>
+          Only print the lines from N to M.
+  -L, --list-languages
+          Display all supported languages.
+  -h, --help
+          Print help (see more with '--help')
+  -V, --version
+          Print version

examples/buffer.rs

@@ -0,0 +1,17 @@
+use bat::{assets::HighlightingAssets, config::Config, controller::Controller, Input};
+
+fn main() {
+    let mut buffer = String::new();
+    let config = Config {
+        colored_output: true,
+        ..Default::default()
+    };
+    let assets = HighlightingAssets::from_binary();
+    let controller = Controller::new(&config, &assets);
+    let input = Input::from_file(file!());
+    controller
+        .run(vec![input.into()], Some(&mut buffer))
+        .unwrap();
+
+    println!("{buffer}");
+}

examples/yaml.rs

@@ -23,7 +23,8 @@ fn main() {
         }],
     };
 
-    let bytes = serde_yaml::to_vec(&person).unwrap();
+    let mut bytes = Vec::with_capacity(128);
+    serde_yaml::to_writer(&mut bytes, &person).unwrap();
     PrettyPrinter::new()
         .language("yaml")
         .line_numbers(true)

src/assets.rs

@@ -84,7 +84,7 @@ impl HighlightingAssets {
     /// platform, the default theme depends on
     /// ```bash
     /// defaults read -globalDomain AppleInterfaceStyle
-    /// ````
+    /// ```
     /// To avoid the overhead of the check on macOS, simply specify a theme
     /// explicitly via `--theme`, `BAT_THEME`, or `~/.config/bat`.
     ///
@@ -401,11 +401,21 @@ fn asset_from_cache<T: serde::de::DeserializeOwned>(
 
 #[cfg(target_os = "macos")]
 fn macos_dark_mode_active() -> bool {
-    let mut defaults_cmd = std::process::Command::new("defaults");
-    defaults_cmd.args(&["read", "-globalDomain", "AppleInterfaceStyle"]);
-    match defaults_cmd.output() {
-        Ok(output) => output.stdout == b"Dark\n",
-        Err(_) => true,
+    const PREFERENCES_FILE: &str = "Library/Preferences/.GlobalPreferences.plist";
+    const STYLE_KEY: &str = "AppleInterfaceStyle";
+
+    let preferences_file = home::home_dir()
+        .map(|home| home.join(PREFERENCES_FILE))
+        .expect("Could not get home directory");
+
+    match plist::Value::from_file(preferences_file).map(|file| file.into_dictionary()) {
+        Ok(Some(preferences)) => match preferences.get(STYLE_KEY).and_then(|val| val.as_string()) {
+            Some(value) => value == "Dark",
+            // If the key does not exist, then light theme is currently in use.
+            None => false,
+        },
+        // Unreachable, in theory. All macOS users have a home directory and preferences file setup.
+        Ok(None) | Err(_) => true,
     }
 }
 

src/bin/bat/app.rs

@@ -1,13 +1,11 @@
 use std::collections::HashSet;
 use std::env;
+use std::io::IsTerminal;
 use std::path::{Path, PathBuf};
-use std::str::FromStr;
-
-use atty::{self, Stream};
 
 use crate::{
     clap_app,
-    config::{get_args_from_config_file, get_args_from_env_var},
+    config::{get_args_from_config_file, get_args_from_env_opts_var, get_args_from_env_vars},
 };
 use clap::ArgMatches;
 
@@ -22,7 +20,7 @@ use bat::{
     input::Input,
     line_range::{HighlightedLineRanges, LineRange, LineRanges},
     style::{StyleComponent, StyleComponents},
-    MappingTarget, PagingMode, SyntaxMapping, WrappingMode,
+    MappingTarget, NonprintableNotation, PagingMode, SyntaxMapping, WrappingMode,
 };
 
 fn is_truecolor_terminal() -> bool {
@@ -39,9 +37,9 @@ pub struct App {
 impl App {
     pub fn new() -> Result<Self> {
         #[cfg(windows)]
-        let _ = ansi_term::enable_ansi_support();
+        let _ = nu_ansi_term::enable_ansi_support();
 
-        let interactive_output = atty::is(Stream::Stdout);
+        let interactive_output = std::io::stdout().is_terminal();
 
         Ok(App {
             matches: Self::matches(interactive_output)?,
@@ -50,20 +48,34 @@ impl App {
     }
 
     fn matches(interactive_output: bool) -> Result<ArgMatches> {
-        let args = if wild::args_os().nth(1) == Some("cache".into())
-            || wild::args_os().any(|arg| arg == "--no-config")
-        {
-            // Skip the arguments in bats config file
+        let args = if wild::args_os().nth(1) == Some("cache".into()) {
+            // Skip the config file and env vars
 
             wild::args_os().collect::<Vec<_>>()
+        } else if wild::args_os().any(|arg| arg == "--no-config") {
+            // Skip the arguments in bats config file
+
+            let mut cli_args = wild::args_os();
+            let mut args = get_args_from_env_vars();
+
+            // Put the zero-th CLI argument (program name) first
+            args.insert(0, cli_args.next().unwrap());
+
+            // .. and the rest at the end
+            cli_args.for_each(|a| args.push(a));
+
+            args
         } else {
             let mut cli_args = wild::args_os();
 
             // Read arguments from bats config file
-            let mut args = get_args_from_env_var()
+            let mut args = get_args_from_env_opts_var()
                 .unwrap_or_else(get_args_from_config_file)
                 .map_err(|_| "Could not parse configuration file")?;
 
+            // Selected env vars supersede config vars
+            args.extend(get_args_from_env_vars());
+
             // Put the zero-th CLI argument (program name) first
             args.insert(0, cli_args.next().unwrap());
 
@@ -91,7 +103,7 @@ impl App {
                     // If we are reading from stdin, only enable paging if we write to an
                     // interactive terminal and if we do not *read* from an interactive
                     // terminal.
-                    if self.interactive_output && !atty::is(Stream::Stdin) {
+                    if self.interactive_output && !std::io::stdin().is_terminal() {
                         PagingMode::QuitIfOneScreen
                     } else {
                         PagingMode::Never
@@ -160,18 +172,31 @@ impl App {
                     }
                 }),
             show_nonprintable: self.matches.get_flag("show-all"),
+            nonprintable_notation: match self
+                .matches
+                .get_one::<String>("nonprintable-notation")
+                .map(|s| s.as_str())
+            {
+                Some("unicode") => NonprintableNotation::Unicode,
+                Some("caret") => NonprintableNotation::Caret,
+                _ => unreachable!("other values for --nonprintable-notation are not allowed"),
+            },
             wrapping_mode: if self.interactive_output || maybe_term_width.is_some() {
-                match self.matches.get_one::<String>("wrap").map(|s| s.as_str()) {
-                    Some("character") => WrappingMode::Character,
-                    Some("never") => WrappingMode::NoWrapping(true),
-                    Some("auto") | None => {
-                        if style_components.plain() {
-                            WrappingMode::NoWrapping(false)
-                        } else {
-                            WrappingMode::Character
+                if !self.matches.get_flag("chop-long-lines") {
+                    match self.matches.get_one::<String>("wrap").map(|s| s.as_str()) {
+                        Some("character") => WrappingMode::Character,
+                        Some("never") => WrappingMode::NoWrapping(true),
+                        Some("auto") | None => {
+                            if style_components.plain() {
+                                WrappingMode::NoWrapping(false)
+                            } else {
+                                WrappingMode::Character
+                            }
                         }
+                        _ => unreachable!("other values for --wrap are not allowed"),
                     }
-                    _ => unreachable!("other values for --wrap are not allowed"),
+                } else {
+                    WrappingMode::NoWrapping(true)
                 }
             } else {
                 // We don't have the tty width when piping to another program.
@@ -199,7 +224,6 @@ impl App {
                 .matches
                 .get_one::<String>("tabs")
                 .map(String::from)
-                .or_else(|| env::var("BAT_TABS").ok())
                 .and_then(|t| t.parse().ok())
                 .unwrap_or(
                     if style_components.plain() && paging_mode == PagingMode::Never {
@@ -212,7 +236,6 @@ impl App {
                 .matches
                 .get_one::<String>("theme")
                 .map(String::from)
-                .or_else(|| env::var("BAT_THEME").ok())
                 .map(|s| {
                     if s == "default" {
                         String::from(HighlightingAssets::default_theme())
@@ -221,7 +244,9 @@ impl App {
                     }
                 })
                 .unwrap_or_else(|| String::from(HighlightingAssets::default_theme())),
-            visible_lines: match self.matches.contains_id("diff") && self.matches.get_flag("diff") {
+            visible_lines: match self.matches.try_contains_id("diff").unwrap_or_default()
+                && self.matches.get_flag("diff")
+            {
                 #[cfg(feature = "git")]
                 true => VisibleLines::DiffContext(
                     self.matches
@@ -256,6 +281,8 @@ impl App {
                 .map(HighlightedLineRanges)
                 .unwrap_or_default(),
             use_custom_assets: !self.matches.get_flag("no-custom-assets"),
+            #[cfg(feature = "lessopen")]
+            use_lessopen: self.matches.get_flag("lessopen"),
         })
     }
 
@@ -315,16 +342,6 @@ impl App {
             } else if 0 < matches.get_count("plain") {
                 [StyleComponent::Plain].iter().cloned().collect()
             } else {
-                let env_style_components: Option<Vec<StyleComponent>> = env::var("BAT_STYLE")
-                    .ok()
-                    .map(|style_str| {
-                        style_str
-                            .split(',')
-                            .map(StyleComponent::from_str)
-                            .collect::<Result<Vec<StyleComponent>>>()
-                    })
-                    .transpose()?;
-
                 matches
                     .get_one::<String>("style")
                     .map(|styles| {
@@ -334,7 +351,6 @@ impl App {
                             .filter_map(|style| style.ok())
                             .collect::<Vec<_>>()
                     })
-                    .or(env_style_components)
                     .unwrap_or_else(|| vec![StyleComponent::Default])
                     .into_iter()
                     .map(|style| style.components(self.interactive_output))

src/bin/bat/assets.rs

@@ -1,31 +1,24 @@
-use std::borrow::Cow;
 use std::fs;
 use std::io;
+use std::path::Path;
+use std::path::PathBuf;
 
 use clap::crate_version;
 
-use crate::directories::PROJECT_DIRS;
-
 use bat::assets::HighlightingAssets;
 use bat::assets_metadata::AssetsMetadata;
 use bat::error::*;
 
-pub fn config_dir() -> Cow<'static, str> {
-    PROJECT_DIRS.config_dir().to_string_lossy()
+pub fn clear_assets(cache_dir: &Path) {
+    clear_asset(cache_dir.join("themes.bin"), "theme set cache");
+    clear_asset(cache_dir.join("syntaxes.bin"), "syntax set cache");
+    clear_asset(cache_dir.join("metadata.yaml"), "metadata file");
 }
 
-pub fn cache_dir() -> Cow<'static, str> {
-    PROJECT_DIRS.cache_dir().to_string_lossy()
-}
-
-pub fn clear_assets() {
-    clear_asset("themes.bin", "theme set cache");
-    clear_asset("syntaxes.bin", "syntax set cache");
-    clear_asset("metadata.yaml", "metadata file");
-}
-
-pub fn assets_from_cache_or_binary(use_custom_assets: bool) -> Result<HighlightingAssets> {
-    let cache_dir = PROJECT_DIRS.cache_dir();
+pub fn assets_from_cache_or_binary(
+    use_custom_assets: bool,
+    cache_dir: &Path,
+) -> Result<HighlightingAssets> {
     if let Some(metadata) = AssetsMetadata::load_from_folder(cache_dir)? {
         if !metadata.is_compatible_with(crate_version!()) {
             return Err(format!(
@@ -50,9 +43,8 @@ pub fn assets_from_cache_or_binary(use_custom_assets: bool) -> Result<Highlighti
     Ok(custom_assets.unwrap_or_else(HighlightingAssets::from_binary))
 }
 
-fn clear_asset(filename: &str, description: &str) {
+fn clear_asset(path: PathBuf, description: &str) {
     print!("Clearing {} ... ", description);
-    let path = PROJECT_DIRS.cache_dir().join(filename);
     match fs::remove_file(&path) {
         Err(err) if err.kind() == io::ErrorKind::NotFound => {
             println!("skipped (not present)");

src/bin/bat/clap_app.rs

@@ -1,6 +1,5 @@
 use clap::{
-    crate_name, crate_version, value_parser, AppSettings, Arg, ArgAction, ArgGroup, ColorChoice,
-    Command,
+    crate_name, crate_version, value_parser, Arg, ArgAction, ArgGroup, ColorChoice, Command,
 };
 use once_cell::sync::Lazy;
 use std::env;
@@ -19,7 +18,7 @@ static VERSION: Lazy<String> = Lazy::new(|| {
     }
 });
 
-pub fn build_app(interactive_output: bool) -> Command<'static> {
+pub fn build_app(interactive_output: bool) -> Command {
     let color_when = if interactive_output && env::var_os("NO_COLOR").is_none() {
         ColorChoice::Auto
     } else {
@@ -29,20 +28,12 @@ pub fn build_app(interactive_output: bool) -> Command<'static> {
     let mut app = Command::new(crate_name!())
         .version(VERSION.as_str())
         .color(color_when)
-        .global_setting(AppSettings::DeriveDisplayOrder)
         .hide_possible_values(true)
         .args_conflicts_with_subcommands(true)
         .allow_external_subcommands(true)
         .disable_help_subcommand(true)
         .max_term_width(100)
-        .about(
-            "A cat(1) clone with wings.\n\n\
-             Use '--help' instead of '-h' to see a more detailed version of the help text.",
-        )
-        .after_help(
-            "Note: `bat -h` prints a short and concise overview while `bat --help` gives all \
-                 details.",
-        )
+        .about("A cat(1) clone with wings.")
         .long_about("A cat(1) clone with syntax highlighting and Git integration.")
         .arg(
             Arg::new("FILE")
@@ -51,8 +42,7 @@ pub fn build_app(interactive_output: bool) -> Command<'static> {
                     "File(s) to print / concatenate. Use a dash ('-') or no argument at all \
                      to read from standard input.",
                 )
-                .takes_value(true)
-                .multiple_values(true)
+                .num_args(1..)
                 .value_parser(value_parser!(PathBuf)),
         )
         .arg(
@@ -69,10 +59,27 @@ pub fn build_app(interactive_output: bool) -> Command<'static> {
                      Use '--tabs' to control the width of the tab-placeholders.",
                 ),
         )
+        .arg(
+            Arg::new("nonprintable-notation")
+                .long("nonprintable-notation")
+                .action(ArgAction::Set)
+                .default_value("unicode")
+                .value_parser(["unicode", "caret"])
+                .value_name("notation")
+                .hide_default_value(true)
+                .help("Set notation for non-printable characters.")
+                .long_help(
+                    "Set notation for non-printable characters.\n\n\
+                    Possible values:\n  \
+                    * unicode (␇, ␊, ␀, ..)\n  \
+                    * caret   (^G, ^J, ^@, ..)",
+                ),
+        )
         .arg(
             Arg::new("plain")
                 .overrides_with("plain")
                 .overrides_with("number")
+                .overrides_with("paging")
                 .short('p')
                 .long("plain")
                 .action(ArgAction::Count)
@@ -94,14 +101,12 @@ pub fn build_app(interactive_output: bool) -> Command<'static> {
                      specified as a name (like 'C++' or 'LaTeX') or possible file extension \
                      (like 'cpp', 'hpp' or 'md'). Use '--list-languages' to show all supported \
                      language names and file extensions.",
-                )
-                .takes_value(true),
+                ),
         )
         .arg(
             Arg::new("highlight-line")
                 .long("highlight-line")
                 .short('H')
-                .takes_value(true)
                 .action(ArgAction::Append)
                 .value_name("N:M")
                 .help("Highlight lines N through M.")
@@ -118,7 +123,6 @@ pub fn build_app(interactive_output: bool) -> Command<'static> {
         .arg(
             Arg::new("file-name")
                 .long("file-name")
-                .takes_value(true)
                 .action(ArgAction::Append)
                 .value_name("name")
                 .value_parser(value_parser!(PathBuf))
@@ -150,7 +154,6 @@ pub fn build_app(interactive_output: bool) -> Command<'static> {
                     Arg::new("diff-context")
                         .long("diff-context")
                         .overrides_with("diff-context")
-                        .takes_value(true)
                         .value_name("N")
                         .value_parser(
                             |n: &str| {
@@ -171,7 +174,6 @@ pub fn build_app(interactive_output: bool) -> Command<'static> {
         Arg::new("tabs")
             .long("tabs")
             .overrides_with("tabs")
-            .takes_value(true)
             .value_name("T")
             .value_parser(
                 |t: &str| {
@@ -191,7 +193,6 @@ pub fn build_app(interactive_output: bool) -> Command<'static> {
             Arg::new("wrap")
                 .long("wrap")
                 .overrides_with("wrap")
-                .takes_value(true)
                 .value_name("mode")
                 .value_parser(["auto", "never", "character"])
                 .default_value("auto")
@@ -201,10 +202,16 @@ pub fn build_app(interactive_output: bool) -> Command<'static> {
                            The '--terminal-width' option can be used in addition to \
                            control the output width."),
         )
+        .arg(
+            Arg::new("chop-long-lines")
+                .long("chop-long-lines")
+                .short('S')
+                .action(ArgAction::SetTrue)
+                .help("Truncate all lines longer than screen width. Alias for '--wrap=never'."),
+        )
         .arg(
             Arg::new("terminal-width")
                 .long("terminal-width")
-                .takes_value(true)
                 .value_name("width")
                 .hide_short_help(true)
                 .allow_hyphen_values(true)
@@ -242,7 +249,6 @@ pub fn build_app(interactive_output: bool) -> Command<'static> {
             Arg::new("color")
                 .long("color")
                 .overrides_with("color")
-                .takes_value(true)
                 .value_name("when")
                 .value_parser(["auto", "never", "always"])
                 .hide_default_value(true)
@@ -258,7 +264,6 @@ pub fn build_app(interactive_output: bool) -> Command<'static> {
         .arg(
             Arg::new("italic-text")
                 .long("italic-text")
-                .takes_value(true)
                 .value_name("when")
                 .value_parser(["always", "never"])
                 .default_value("never")
@@ -270,7 +275,6 @@ pub fn build_app(interactive_output: bool) -> Command<'static> {
             Arg::new("decorations")
                 .long("decorations")
                 .overrides_with("decorations")
-                .takes_value(true)
                 .value_name("when")
                 .value_parser(["auto", "never", "always"])
                 .default_value("auto")
@@ -300,7 +304,7 @@ pub fn build_app(interactive_output: bool) -> Command<'static> {
                 .long("paging")
                 .overrides_with("paging")
                 .overrides_with("no-paging")
-                .takes_value(true)
+                .overrides_with("plain")
                 .value_name("when")
                 .value_parser(["auto", "never", "always"])
                 .default_value("auto")
@@ -309,7 +313,7 @@ pub fn build_app(interactive_output: bool) -> Command<'static> {
                 .long_help(
                     "Specify when to use the pager. To disable the pager, use \
                     --paging=never' or its alias,'-P'. To disable the pager permanently, \
-                    set BAT_PAGER to an empty string. To control which pager is used, see the \
+                    set BAT_PAGING to 'never'. To control which pager is used, see the \
                     '--pager' option. Possible values: *auto*, never, always."
                 ),
         )
@@ -328,7 +332,6 @@ pub fn build_app(interactive_output: bool) -> Command<'static> {
             Arg::new("pager")
                 .long("pager")
                 .overrides_with("pager")
-                .takes_value(true)
                 .value_name("command")
                 .hide_short_help(true)
                 .help("Determine which pager to use.")
@@ -344,7 +347,6 @@ pub fn build_app(interactive_output: bool) -> Command<'static> {
                 .short('m')
                 .long("map-syntax")
                 .action(ArgAction::Append)
-                .takes_value(true)
                 .value_name("glob:syntax")
                 .help("Use the specified syntax for files matching the glob pattern ('*.cpp:C++').")
                 .long_help(
@@ -354,12 +356,10 @@ pub fn build_app(interactive_output: bool) -> Command<'static> {
                      '.myignore' with the Git Ignore syntax, use -m '.myignore:Git Ignore'. Note \
                      that the right-hand side is the *name* of the syntax, not a file extension.",
                 )
-                .takes_value(true),
         )
         .arg(
             Arg::new("ignored-suffix")
                 .action(ArgAction::Append)
-                .takes_value(true)
                 .long("ignored-suffix")
                 .hide_short_help(true)
                 .help(
@@ -371,7 +371,6 @@ pub fn build_app(interactive_output: bool) -> Command<'static> {
             Arg::new("theme")
                 .long("theme")
                 .overrides_with("theme")
-                .takes_value(true)
                 .help("Set the color theme for syntax highlighting.")
                 .long_help(
                     "Set the theme for syntax highlighting. Use '--list-themes' to \
@@ -392,10 +391,6 @@ pub fn build_app(interactive_output: bool) -> Command<'static> {
             Arg::new("style")
                 .long("style")
                 .value_name("components")
-                // Need to turn this off for overrides_with to work as we want. See the bottom most
-                // example at https://docs.rs/clap/2.32.0/clap/struct.Arg.html#method.overrides_with
-                .use_value_delimiter(false)
-                .takes_value(true)
                 .overrides_with("style")
                 .overrides_with("plain")
                 .overrides_with("number")
@@ -458,7 +453,6 @@ pub fn build_app(interactive_output: bool) -> Command<'static> {
                 .long("line-range")
                 .short('r')
                 .action(ArgAction::Append)
-                .takes_value(true)
                 .value_name("N:M")
                 .help("Only print the lines from N to M.")
                 .long_help(
@@ -484,6 +478,7 @@ pub fn build_app(interactive_output: bool) -> Command<'static> {
             Arg::new("unbuffered")
                 .short('u')
                 .long("unbuffered")
+                .action(ArgAction::SetTrue)
                 .hide_short_help(true)
                 .long_help(
                     "This option exists for POSIX-compliance reasons ('u' is for \
@@ -494,6 +489,7 @@ pub fn build_app(interactive_output: bool) -> Command<'static> {
         .arg(
             Arg::new("no-config")
                 .long("no-config")
+                .action(ArgAction::SetTrue)
                 .hide(true)
                 .help("Do not use the configuration file"),
         )
@@ -503,7 +499,28 @@ pub fn build_app(interactive_output: bool) -> Command<'static> {
                 .action(ArgAction::SetTrue)
                 .hide(true)
                 .help("Do not load custom assets"),
-        )
+        );
+
+    #[cfg(feature = "lessopen")]
+    {
+        app = app
+            .arg(
+                Arg::new("lessopen")
+                    .long("lessopen")
+                    .action(ArgAction::SetTrue)
+                    .help("Enable the $LESSOPEN preprocessor"),
+            )
+            .arg(
+                Arg::new("no-lessopen")
+                    .long("no-lessopen")
+                    .action(ArgAction::SetTrue)
+                    .overrides_with("lessopen")
+                    .hide(true)
+                    .help("Disable the $LESSOPEN preprocessor if enabled (overrides --lessopen)"),
+            )
+    }
+
+    app = app
         .arg(
             Arg::new("config-file")
                 .long("config-file")
@@ -542,7 +559,7 @@ pub fn build_app(interactive_output: bool) -> Command<'static> {
                 .alias("diagnostics")
                 .action(ArgAction::SetTrue)
                 .hide_short_help(true)
-                .help("Show diagnostic information for bug reports.")
+                .help("Show diagnostic information for bug reports."),
         )
         .arg(
             Arg::new("acknowledgements")
@@ -550,8 +567,7 @@ pub fn build_app(interactive_output: bool) -> Command<'static> {
                 .action(ArgAction::SetTrue)
                 .hide_short_help(true)
                 .help("Show acknowledgements."),
-        )
-        .mut_arg("help", |arg| arg.help("Print this help message."));
+        );
 
     // Check if the current directory contains a file name cache. Otherwise,
     // enable the 'bat cache' subcommand.
@@ -560,6 +576,7 @@ pub fn build_app(interactive_output: bool) -> Command<'static> {
     } else {
         app.subcommand(
             Command::new("cache")
+                .hide(true)
                 .about("Modify the syntax-definition and theme cache")
                 .arg(
                     Arg::new("build")
@@ -581,14 +598,13 @@ pub fn build_app(interactive_output: bool) -> Command<'static> {
                 )
                 .group(
                     ArgGroup::new("cache-actions")
-                        .args(&["build", "clear"])
+                        .args(["build", "clear"])
                         .required(true),
                 )
                 .arg(
                     Arg::new("source")
                         .long("source")
                         .requires("build")
-                        .takes_value(true)
                         .value_name("dir")
                         .help("Use a different directory to load syntaxes and themes from."),
                 )
@@ -596,7 +612,6 @@ pub fn build_app(interactive_output: bool) -> Command<'static> {
                     Arg::new("target")
                         .long("target")
                         .requires("build")
-                        .takes_value(true)
                         .value_name("dir")
                         .help(
                             "Use a different directory to store the cached syntax and theme set.",
@@ -620,6 +635,10 @@ pub fn build_app(interactive_output: bool) -> Command<'static> {
                         .help("Build acknowledgements.bin."),
                 ),
         )
+        .after_long_help(
+            "You can use 'bat cache' to customize syntaxes and themes. \
+            See 'bat cache --help' for more information",
+        )
     }
 }
 

src/bin/bat/config.rs

@@ -117,7 +117,7 @@ pub fn get_args_from_config_file() -> Result<Vec<OsString>, shell_words::ParseEr
     get_args_from_str(&config)
 }
 
-pub fn get_args_from_env_var() -> Option<Result<Vec<OsString>, shell_words::ParseError>> {
+pub fn get_args_from_env_opts_var() -> Option<Result<Vec<OsString>, shell_words::ParseError>> {
     env::var("BAT_OPTS").ok().map(|s| get_args_from_str(&s))
 }
 
@@ -137,6 +137,21 @@ fn get_args_from_str(content: &str) -> Result<Vec<OsString>, shell_words::ParseE
         .collect())
 }
 
+pub fn get_args_from_env_vars() -> Vec<OsString> {
+    [
+        ("--tabs", "BAT_TABS"),
+        ("--theme", "BAT_THEME"),
+        ("--pager", "BAT_PAGER"),
+        ("--paging", "BAT_PAGING"),
+        ("--style", "BAT_STYLE"),
+    ]
+    .iter()
+    .filter_map(|(flag, key)| env::var(key).ok().map(|var| [flag.to_string(), var]))
+    .flatten()
+    .map(|a| a.into())
+    .collect()
+}
+
 #[test]
 fn empty() {
     let args = get_args_from_str("").unwrap();

src/bin/bat/directories.rs

@@ -1,12 +1,11 @@
 use std::env;
 use std::path::{Path, PathBuf};
 
+use etcetera::BaseStrategy;
 use once_cell::sync::Lazy;
 
-/// Wrapper for 'dirs' that treats MacOS more like Linux, by following the XDG specification.
-/// The `XDG_CACHE_HOME` environment variable is checked first. `BAT_CONFIG_DIR`
-///  is then checked before the `XDG_CONFIG_HOME` environment variable.
-///  The fallback directories are `~/.cache/bat` and `~/.config/bat`, respectively.
+/// Wrapper for 'etcetera' that checks BAT_CACHE_PATH and BAT_CONFIG_DIR and falls back to the
+/// Windows known folder locations on Windows & the XDG Base Directory Specification everywhere else.
 pub struct BatProjectDirs {
     cache_dir: PathBuf,
     config_dir: PathBuf,
@@ -14,25 +13,24 @@ pub struct BatProjectDirs {
 
 impl BatProjectDirs {
     fn new() -> Option<BatProjectDirs> {
-        let cache_dir = BatProjectDirs::get_cache_dir()?;
+        let basedirs = etcetera::choose_base_strategy().ok()?;
 
-        // Checks whether or not $BAT_CONFIG_DIR exists. If it doesn't, set our config dir
-        // to our system's default configuration home.
-        let config_dir =
-            if let Some(config_dir_op) = env::var_os("BAT_CONFIG_DIR").map(PathBuf::from) {
-                config_dir_op
-            } else {
-                #[cfg(target_os = "macos")]
-                let config_dir_op = env::var_os("XDG_CONFIG_HOME")
-                    .map(PathBuf::from)
-                    .filter(|p| p.is_absolute())
-                    .or_else(|| dirs_next::home_dir().map(|d| d.join(".config")));
+        // Checks whether or not `$BAT_CACHE_PATH` exists. If it doesn't, set the cache dir to our
+        // system's default cache home.
+        let cache_dir = if let Some(cache_dir) = env::var_os("BAT_CACHE_PATH").map(PathBuf::from) {
+            cache_dir
+        } else {
+            basedirs.cache_dir().join("bat")
+        };
 
-                #[cfg(not(target_os = "macos"))]
-                let config_dir_op = dirs_next::config_dir();
-
-                config_dir_op.map(|d| d.join("bat"))?
-            };
+        // Checks whether or not `$BAT_CONFIG_DIR` exists. If it doesn't, set the config dir to our
+        // system's default configuration home.
+        let config_dir = if let Some(config_dir) = env::var_os("BAT_CONFIG_DIR").map(PathBuf::from)
+        {
+            config_dir
+        } else {
+            basedirs.config_dir().join("bat")
+        };
 
         Some(BatProjectDirs {
             cache_dir,
@@ -40,25 +38,6 @@ impl BatProjectDirs {
         })
     }
 
-    fn get_cache_dir() -> Option<PathBuf> {
-        // on all OS prefer BAT_CACHE_PATH if set
-        let cache_dir_op = env::var_os("BAT_CACHE_PATH").map(PathBuf::from);
-        if cache_dir_op.is_some() {
-            return cache_dir_op;
-        }
-
-        #[cfg(target_os = "macos")]
-        let cache_dir_op = env::var_os("XDG_CACHE_HOME")
-            .map(PathBuf::from)
-            .filter(|p| p.is_absolute())
-            .or_else(|| dirs_next::home_dir().map(|d| d.join(".cache")));
-
-        #[cfg(not(target_os = "macos"))]
-        let cache_dir_op = dirs_next::cache_dir();
-
-        cache_dir_op.map(|d| d.join("bat"))
-    }
-
     pub fn cache_dir(&self) -> &Path {
         &self.cache_dir
     }

src/bin/bat/main.rs

@@ -14,8 +14,8 @@ use std::io::{BufReader, Write};
 use std::path::Path;
 use std::process;
 
-use ansi_term::Colour::Green;
-use ansi_term::Style;
+use nu_ansi_term::Color::Green;
+use nu_ansi_term::Style;
 
 use crate::{
     app::App,
@@ -25,7 +25,7 @@ use crate::{
 #[cfg(feature = "bugreport")]
 use crate::config::system_config_file;
 
-use assets::{assets_from_cache_or_binary, cache_dir, clear_assets, config_dir};
+use assets::{assets_from_cache_or_binary, clear_assets};
 use directories::PROJECT_DIRS;
 use globset::GlobMatcher;
 
@@ -41,33 +41,38 @@ use bat::{
 const THEME_PREVIEW_DATA: &[u8] = include_bytes!("../../../assets/theme_preview.rs");
 
 #[cfg(feature = "build-assets")]
-fn build_assets(matches: &clap::ArgMatches) -> Result<()> {
+fn build_assets(matches: &clap::ArgMatches, config_dir: &Path, cache_dir: &Path) -> Result<()> {
     let source_dir = matches
         .get_one::<String>("source")
         .map(Path::new)
-        .unwrap_or_else(|| PROJECT_DIRS.config_dir());
-    let target_dir = matches
-        .get_one::<String>("target")
-        .map(Path::new)
-        .unwrap_or_else(|| PROJECT_DIRS.cache_dir());
+        .unwrap_or_else(|| config_dir);
 
     bat::assets::build(
         source_dir,
         !matches.get_flag("blank"),
         matches.get_flag("acknowledgements"),
-        target_dir,
+        cache_dir,
         clap::crate_version!(),
     )
 }
 
-fn run_cache_subcommand(matches: &clap::ArgMatches) -> Result<()> {
+fn run_cache_subcommand(
+    matches: &clap::ArgMatches,
+    #[cfg(feature = "build-assets")] config_dir: &Path,
+    default_cache_dir: &Path,
+) -> Result<()> {
+    let cache_dir = matches
+        .get_one::<String>("target")
+        .map(Path::new)
+        .unwrap_or_else(|| default_cache_dir);
+
     if matches.get_flag("build") {
         #[cfg(feature = "build-assets")]
-        build_assets(matches)?;
+        build_assets(matches, config_dir, cache_dir)?;
         #[cfg(not(feature = "build-assets"))]
         println!("bat has been built without the 'build-assets' feature. The 'cache --build' option is not available.");
     } else if matches.get_flag("clear") {
-        clear_assets();
+        clear_assets(cache_dir);
     }
 
     Ok(())
@@ -86,10 +91,10 @@ fn get_syntax_mapping_to_paths<'a>(
     map
 }
 
-pub fn get_languages(config: &Config) -> Result<String> {
+pub fn get_languages(config: &Config, cache_dir: &Path) -> Result<String> {
     let mut result: String = String::new();
 
-    let assets = assets_from_cache_or_binary(config.use_custom_assets)?;
+    let assets = assets_from_cache_or_binary(config.use_custom_assets, cache_dir)?;
     let mut languages = assets
         .get_syntaxes()?
         .iter()
@@ -181,8 +186,8 @@ fn theme_preview_file<'a>() -> Input<'a> {
     Input::from_reader(Box::new(BufReader::new(THEME_PREVIEW_DATA)))
 }
 
-pub fn list_themes(cfg: &Config) -> Result<()> {
-    let assets = assets_from_cache_or_binary(cfg.use_custom_assets)?;
+pub fn list_themes(cfg: &Config, config_dir: &Path, cache_dir: &Path) -> Result<()> {
+    let assets = assets_from_cache_or_binary(cfg.use_custom_assets, cache_dir)?;
     let mut config = cfg.clone();
     let mut style = HashSet::new();
     style.insert(StyleComponent::Plain);
@@ -201,7 +206,7 @@ pub fn list_themes(cfg: &Config) -> Result<()> {
             )?;
             config.theme = theme.to_string();
             Controller::new(&config, &assets)
-                .run(vec![theme_preview_file()])
+                .run(vec![theme_preview_file()], None)
                 .ok();
             writeln!(stdout)?;
         }
@@ -211,7 +216,7 @@ pub fn list_themes(cfg: &Config) -> Result<()> {
             and are added to the cache with `bat cache --build`. \
             For more information, see:\n\n  \
             https://github.com/sharkdp/bat#adding-new-themes",
-            PROJECT_DIRS.config_dir().join("themes").to_string_lossy()
+            config_dir.join("themes").to_string_lossy()
         )?;
     } else {
         for theme in assets.themes() {
@@ -222,21 +227,21 @@ pub fn list_themes(cfg: &Config) -> Result<()> {
     Ok(())
 }
 
-fn run_controller(inputs: Vec<Input>, config: &Config) -> Result<bool> {
-    let assets = assets_from_cache_or_binary(config.use_custom_assets)?;
+fn run_controller(inputs: Vec<Input>, config: &Config, cache_dir: &Path) -> Result<bool> {
+    let assets = assets_from_cache_or_binary(config.use_custom_assets, cache_dir)?;
     let controller = Controller::new(config, &assets);
-    controller.run(inputs)
+    controller.run(inputs, None)
 }
 
 #[cfg(feature = "bugreport")]
-fn invoke_bugreport(app: &App) {
+fn invoke_bugreport(app: &App, cache_dir: &Path) {
     use bugreport::{bugreport, collector::*, format::Markdown};
     let pager = bat::config::get_pager_executable(
         app.matches.get_one::<String>("pager").map(|s| s.as_str()),
     )
     .unwrap_or_else(|| "less".to_owned()); // FIXME: Avoid non-canonical path to "less".
 
-    let mut custom_assets_metadata = PROJECT_DIRS.cache_dir().to_path_buf();
+    let mut custom_assets_metadata = cache_dir.to_path_buf();
     custom_assets_metadata.push("metadata.yaml");
 
     let mut report = bugreport!()
@@ -250,6 +255,7 @@ fn invoke_bugreport(app: &App) {
             "LANG",
             "LC_ALL",
             "BAT_PAGER",
+            "BAT_PAGING",
             "BAT_CACHE_PATH",
             "BAT_CONFIG_PATH",
             "BAT_OPTS",
@@ -268,10 +274,7 @@ fn invoke_bugreport(app: &App) {
             "Custom assets metadata",
             custom_assets_metadata,
         ))
-        .info(DirectoryEntries::new(
-            "Custom assets",
-            PROJECT_DIRS.cache_dir(),
-        ))
+        .info(DirectoryEntries::new("Custom assets", cache_dir))
         .info(CompileTimeInformation::default());
 
     #[cfg(feature = "paging")]
@@ -290,10 +293,12 @@ fn invoke_bugreport(app: &App) {
 /// `Ok(false)` if any intermediate errors occurred (were printed).
 fn run() -> Result<bool> {
     let app = App::new()?;
+    let config_dir = PROJECT_DIRS.config_dir();
+    let cache_dir = PROJECT_DIRS.cache_dir();
 
     if app.matches.get_flag("diagnostic") {
         #[cfg(feature = "bugreport")]
-        invoke_bugreport(&app);
+        invoke_bugreport(&app, cache_dir);
         #[cfg(not(feature = "bugreport"))]
         println!("bat has been built without the 'bugreport' feature. The '--diagnostic' option is not available.");
         return Ok(true);
@@ -305,13 +310,18 @@ fn run() -> Result<bool> {
             // arguments for subcommand 'cache' are not mandatory.
             // If there are non-zero arguments, execute the subcommand cache, else, open the file cache.
             if cache_matches.args_present() {
-                run_cache_subcommand(cache_matches)?;
+                run_cache_subcommand(
+                    cache_matches,
+                    #[cfg(feature = "build-assets")]
+                    config_dir,
+                    cache_dir,
+                )?;
                 Ok(true)
             } else {
                 let inputs = vec![Input::ordinary_file("cache")];
                 let config = app.config(&inputs)?;
 
-                run_controller(inputs, &config)
+                run_controller(inputs, &config, cache_dir)
             }
         }
         _ => {
@@ -319,16 +329,16 @@ fn run() -> Result<bool> {
             let config = app.config(&inputs)?;
 
             if app.matches.get_flag("list-languages") {
-                let languages: String = get_languages(&config)?;
+                let languages: String = get_languages(&config, cache_dir)?;
                 let inputs: Vec<Input> = vec![Input::from_reader(Box::new(languages.as_bytes()))];
                 let plain_config = Config {
                     style_components: StyleComponents::new(StyleComponent::Plain.components(false)),
                     paging_mode: PagingMode::QuitIfOneScreen,
                     ..Default::default()
                 };
-                run_controller(inputs, &plain_config)
+                run_controller(inputs, &plain_config, cache_dir)
             } else if app.matches.get_flag("list-themes") {
-                list_themes(&config)?;
+                list_themes(&config, config_dir, cache_dir)?;
                 Ok(true)
             } else if app.matches.get_flag("config-file") {
                 println!("{}", config_file().to_string_lossy());
@@ -337,16 +347,16 @@ fn run() -> Result<bool> {
                 generate_config_file()?;
                 Ok(true)
             } else if app.matches.get_flag("config-dir") {
-                writeln!(io::stdout(), "{}", config_dir())?;
+                writeln!(io::stdout(), "{}", config_dir.to_string_lossy())?;
                 Ok(true)
             } else if app.matches.get_flag("cache-dir") {
-                writeln!(io::stdout(), "{}", cache_dir())?;
+                writeln!(io::stdout(), "{}", cache_dir.to_string_lossy())?;
                 Ok(true)
             } else if app.matches.get_flag("acknowledgements") {
                 writeln!(io::stdout(), "{}", bat::assets::get_acknowledgements())?;
                 Ok(true)
             } else {
-                run_controller(inputs, &config)
+                run_controller(inputs, &config, cache_dir)
             }
         }
     }

src/config.rs

@@ -1,4 +1,5 @@
 use crate::line_range::{HighlightedLineRanges, LineRanges};
+use crate::nonprintable_notation::NonprintableNotation;
 #[cfg(feature = "paging")]
 use crate::paging::PagingMode;
 use crate::style::StyleComponents;
@@ -39,6 +40,9 @@ pub struct Config<'a> {
     /// Whether or not to show/replace non-printable characters like space, tab and newline.
     pub show_nonprintable: bool,
 
+    /// The configured notation for non-printable characters
+    pub nonprintable_notation: NonprintableNotation,
+
     /// The character width of the terminal
     pub term_width: usize,
 
@@ -86,6 +90,10 @@ pub struct Config<'a> {
     /// Whether or not to allow custom assets. If this is false or if custom assets (a.k.a.
     /// cached assets) are not available, assets from the binary will be used instead.
     pub use_custom_assets: bool,
+
+    // Whether or not to use $LESSOPEN if set
+    #[cfg(feature = "lessopen")]
+    pub use_lessopen: bool,
 }
 
 #[cfg(all(feature = "minimal-application", feature = "paging"))]

src/controller.rs

@@ -6,33 +6,47 @@ use crate::config::{Config, VisibleLines};
 use crate::diff::{get_git_diff, LineChanges};
 use crate::error::*;
 use crate::input::{Input, InputReader, OpenedInput};
+#[cfg(feature = "lessopen")]
+use crate::lessopen::LessOpenPreprocessor;
 #[cfg(feature = "git")]
 use crate::line_range::LineRange;
 use crate::line_range::{LineRanges, RangeCheckResult};
 use crate::output::OutputType;
 #[cfg(feature = "paging")]
 use crate::paging::PagingMode;
-use crate::printer::{InteractivePrinter, Printer, SimplePrinter};
+use crate::printer::{InteractivePrinter, OutputHandle, Printer, SimplePrinter};
 
 use clircle::{Clircle, Identifier};
 
 pub struct Controller<'a> {
     config: &'a Config<'a>,
     assets: &'a HighlightingAssets,
+    #[cfg(feature = "lessopen")]
+    preprocessor: Option<LessOpenPreprocessor>,
 }
 
 impl<'b> Controller<'b> {
     pub fn new<'a>(config: &'a Config, assets: &'a HighlightingAssets) -> Controller<'a> {
-        Controller { config, assets }
+        Controller {
+            config,
+            assets,
+            #[cfg(feature = "lessopen")]
+            preprocessor: LessOpenPreprocessor::new().ok(),
+        }
     }
 
-    pub fn run(&self, inputs: Vec<Input>) -> Result<bool> {
-        self.run_with_error_handler(inputs, default_error_handler)
+    pub fn run(
+        &self,
+        inputs: Vec<Input>,
+        output_buffer: Option<&mut dyn std::fmt::Write>,
+    ) -> Result<bool> {
+        self.run_with_error_handler(inputs, output_buffer, default_error_handler)
     }
 
     pub fn run_with_error_handler(
         &self,
         inputs: Vec<Input>,
+        output_buffer: Option<&mut dyn std::fmt::Write>,
         handle_error: impl Fn(&Error, &mut dyn Write),
     ) -> Result<bool> {
         let mut output_type;
@@ -74,7 +88,10 @@ impl<'b> Controller<'b> {
             clircle::Identifier::stdout()
         };
 
-        let writer = output_type.handle()?;
+        let mut writer = match output_buffer {
+            Some(buf) => OutputHandle::FmtWrite(buf),
+            None => OutputHandle::IoWrite(output_type.handle()?),
+        };
         let mut no_errors: bool = true;
         let stderr = io::stderr();
 
@@ -82,16 +99,23 @@ impl<'b> Controller<'b> {
             let identifier = stdout_identifier.as_ref();
             let is_first = index == 0;
             let result = if input.is_stdin() {
-                self.print_input(input, writer, io::stdin().lock(), identifier, is_first)
+                self.print_input(input, &mut writer, io::stdin().lock(), identifier, is_first)
             } else {
                 // Use dummy stdin since stdin is actually not used (#1902)
-                self.print_input(input, writer, io::empty(), identifier, is_first)
+                self.print_input(input, &mut writer, io::empty(), identifier, is_first)
             };
             if let Err(error) = result {
-                if attached_to_pager {
-                    handle_error(&error, writer);
-                } else {
-                    handle_error(&error, &mut stderr.lock());
+                match writer {
+                    // It doesn't make much sense to send errors straight to stderr if the user
+                    // provided their own buffer, so we just return it.
+                    OutputHandle::FmtWrite(_) => return Err(error),
+                    OutputHandle::IoWrite(ref mut writer) => {
+                        if attached_to_pager {
+                            handle_error(&error, writer);
+                        } else {
+                            handle_error(&error, &mut stderr.lock());
+                        }
+                    }
                 }
                 no_errors = false;
             }
@@ -103,12 +127,23 @@ impl<'b> Controller<'b> {
     fn print_input<R: BufRead>(
         &self,
         input: Input,
-        writer: &mut dyn Write,
+        writer: &mut OutputHandle,
         stdin: R,
         stdout_identifier: Option<&Identifier>,
         is_first: bool,
     ) -> Result<()> {
-        let mut opened_input = input.open(stdin, stdout_identifier)?;
+        let mut opened_input = {
+            #[cfg(feature = "lessopen")]
+            match self.preprocessor {
+                Some(ref preprocessor) if self.config.use_lessopen => {
+                    preprocessor.open(input, stdin, stdout_identifier)?
+                }
+                _ => input.open(stdin, stdout_identifier)?,
+            }
+
+            #[cfg(not(feature = "lessopen"))]
+            input.open(stdin, stdout_identifier)?
+        };
         #[cfg(feature = "git")]
         let line_changes = if self.config.visible_lines.diff_mode()
             || (!self.config.loop_through && self.config.style_components.changes())
@@ -164,7 +199,7 @@ impl<'b> Controller<'b> {
     fn print_file(
         &self,
         printer: &mut dyn Printer,
-        writer: &mut dyn Write,
+        writer: &mut OutputHandle,
         input: &mut OpenedInput,
         add_header_padding: bool,
         #[cfg(feature = "git")] line_changes: &Option<LineChanges>,
@@ -202,7 +237,7 @@ impl<'b> Controller<'b> {
     fn print_file_ranges(
         &self,
         printer: &mut dyn Printer,
-        writer: &mut dyn Write,
+        writer: &mut OutputHandle,
         reader: &mut InputReader,
         line_ranges: &LineRanges,
     ) -> Result<()> {

src/decorations.rs

@@ -1,7 +1,7 @@
 #[cfg(feature = "git")]
 use crate::diff::LineChange;
 use crate::printer::{Colors, InteractivePrinter};
-use ansi_term::Style;
+use nu_ansi_term::Style;
 
 #[derive(Debug, Clone)]
 pub(crate) struct DecorationText {

src/diff.rs

@@ -17,11 +17,11 @@ pub enum LineChange {
 pub type LineChanges = HashMap<u32, LineChange>;
 
 pub fn get_git_diff(filename: &Path) -> Option<LineChanges> {
-    let repo = Repository::discover(&filename).ok()?;
+    let repo = Repository::discover(filename).ok()?;
 
     let repo_path_absolute = fs::canonicalize(repo.workdir()?).ok()?;
 
-    let filepath_absolute = fs::canonicalize(&filename).ok()?;
+    let filepath_absolute = fs::canonicalize(filename).ok()?;
     let filepath_relative_to_repo = filepath_absolute.strip_prefix(&repo_path_absolute).ok()?;
 
     let mut diff_options = DiffOptions::new();

src/error.rs

@@ -7,6 +7,8 @@ pub enum Error {
     #[error(transparent)]
     Io(#[from] ::std::io::Error),
     #[error(transparent)]
+    Fmt(#[from] ::std::fmt::Error),
+    #[error(transparent)]
     SyntectError(#[from] ::syntect::Error),
     #[error(transparent)]
     SyntectLoadingError(#[from] ::syntect::LoadingError),
@@ -26,6 +28,12 @@ pub enum Error {
     InvalidPagerValueBat,
     #[error("{0}")]
     Msg(String),
+    #[cfg(feature = "lessopen")]
+    #[error(transparent)]
+    VarError(#[from] ::std::env::VarError),
+    #[cfg(feature = "lessopen")]
+    #[error(transparent)]
+    CommandParseError(#[from] ::shell_words::ParseError),
 }
 
 impl From<&'static str> for Error {
@@ -43,7 +51,7 @@ impl From<String> for Error {
 pub type Result<T> = std::result::Result<T, Error>;
 
 pub fn default_error_handler(error: &Error, output: &mut dyn Write) {
-    use ansi_term::Colour::Red;
+    use nu_ansi_term::Color::Red;
 
     match error {
         Error::Io(ref io_error) if io_error.kind() == ::std::io::ErrorKind::BrokenPipe => {

src/input.rs

@@ -256,7 +256,7 @@ pub(crate) struct InputReader<'a> {
 }
 
 impl<'a> InputReader<'a> {
-    fn new<R: BufRead + 'a>(mut reader: R) -> InputReader<'a> {
+    pub(crate) fn new<R: BufRead + 'a>(mut reader: R) -> InputReader<'a> {
         let mut first_line = vec![];
         reader.read_until(b'\n', &mut first_line).ok();
 

src/lessopen.rs

@@ -0,0 +1,401 @@
+#![cfg(feature = "lessopen")]
+
+use std::convert::TryFrom;
+use std::env;
+use std::fs::File;
+use std::io::{BufRead, BufReader, Cursor, Read, Write};
+use std::path::PathBuf;
+use std::str;
+
+use clircle::{Clircle, Identifier};
+use os_str_bytes::RawOsString;
+use run_script::{IoOptions, ScriptOptions};
+
+use crate::error::Result;
+use crate::{
+    bat_warning,
+    input::{Input, InputKind, InputReader, OpenedInput, OpenedInputKind},
+};
+
+/// Preprocess files and/or stdin using $LESSOPEN and $LESSCLOSE
+pub(crate) struct LessOpenPreprocessor {
+    lessopen: String,
+    lessclose: Option<String>,
+    command_options: ScriptOptions,
+    kind: LessOpenKind,
+    /// Whether or not data piped via stdin is to be preprocessed
+    preprocess_stdin: bool,
+}
+
+enum LessOpenKind {
+    Piped,
+    PipedIgnoreExitCode,
+    TempFile,
+}
+
+impl LessOpenPreprocessor {
+    /// Create a new instance of LessOpenPreprocessor
+    /// Will return Ok if and only if $LESSOPEN is set and contains exactly one %s
+    pub(crate) fn new() -> Result<LessOpenPreprocessor> {
+        let lessopen = env::var("LESSOPEN")?;
+
+        // Ignore $LESSOPEN if it does not contains exactly one %s
+        // Note that $LESSCLOSE has no such requirement
+        if lessopen.match_indices("%s").count() != 1 {
+            let error_msg = "LESSOPEN ignored: must contain exactly one %s";
+            bat_warning!("{}", error_msg);
+            return Err(error_msg.into());
+        }
+
+        // "||" means pipe directly to bat without making a temporary file
+        // Also, if preprocessor output is empty and exit code is zero, use the empty output
+        // Otherwise, if output is empty and exit code is nonzero, use original file contents
+        let (kind, lessopen) = if lessopen.starts_with("||") {
+            (LessOpenKind::Piped, lessopen.chars().skip(2).collect())
+        // "|" means pipe, but ignore exit code, always using preprocessor output
+        } else if lessopen.starts_with('|') {
+            (
+                LessOpenKind::PipedIgnoreExitCode,
+                lessopen.chars().skip(1).collect(),
+            )
+        // If neither appear, write output to a temporary file and read from that
+        } else {
+            (LessOpenKind::TempFile, lessopen)
+        };
+
+        // "-" means that stdin is preprocessed along with files and may appear alongside "|" and "||"
+        let (stdin, lessopen) = if lessopen.starts_with('-') {
+            (true, lessopen.chars().skip(1).collect())
+        } else {
+            (false, lessopen)
+        };
+
+        let mut command_options = ScriptOptions::new();
+        command_options.runner = env::var("SHELL").ok();
+        command_options.input_redirection = IoOptions::Pipe;
+
+        Ok(Self {
+            lessopen: lessopen.replacen("%s", "$1", 1),
+            lessclose: env::var("LESSCLOSE")
+                .ok()
+                .map(|str| str.replacen("%s", "$1", 1).replacen("%s", "$2", 1)),
+            command_options,
+            kind,
+            preprocess_stdin: stdin,
+        })
+    }
+
+    pub(crate) fn open<'a, R: BufRead + 'a>(
+        &self,
+        input: Input<'a>,
+        mut stdin: R,
+        stdout_identifier: Option<&Identifier>,
+    ) -> Result<OpenedInput<'a>> {
+        let (lessopen_stdout, path_str, kind) = match input.kind {
+            InputKind::OrdinaryFile(ref path) => {
+                let path_str = match path.to_str() {
+                    Some(str) => str,
+                    None => return input.open(stdin, stdout_identifier),
+                };
+
+                let (exit_code, lessopen_stdout, _) = match run_script::run(
+                    &self.lessopen,
+                    &vec![path_str.to_string()],
+                    &self.command_options,
+                ) {
+                    Ok(output) => output,
+                    Err(_) => return input.open(stdin, stdout_identifier),
+                };
+
+                if self.fall_back_to_original_file(&lessopen_stdout, exit_code) {
+                    return input.open(stdin, stdout_identifier);
+                }
+
+                (
+                    RawOsString::from_string(lessopen_stdout),
+                    path_str.to_string(),
+                    OpenedInputKind::OrdinaryFile(path.to_path_buf()),
+                )
+            }
+            InputKind::StdIn => {
+                if self.preprocess_stdin {
+                    if let Some(stdout) = stdout_identifier {
+                        let input_identifier = Identifier::try_from(clircle::Stdio::Stdin)
+                            .map_err(|e| format!("Stdin: Error identifying file: {}", e))?;
+                        if stdout.surely_conflicts_with(&input_identifier) {
+                            return Err("IO circle detected. The input from stdin is also an output. Aborting to avoid infinite loop.".into());
+                        }
+                    }
+
+                    // stdin isn't Clone, so copy it to a cloneable buffer
+                    let mut stdin_buffer = Vec::new();
+                    stdin.read_to_end(&mut stdin_buffer).unwrap();
+
+                    let mut lessopen_handle = match run_script::spawn(
+                        &self.lessopen,
+                        &vec!["-".to_string()],
+                        &self.command_options,
+                    ) {
+                        Ok(handle) => handle,
+                        Err(_) => {
+                            return input.open(stdin, stdout_identifier);
+                        }
+                    };
+
+                    if lessopen_handle
+                        .stdin
+                        .as_mut()
+                        .unwrap()
+                        .write_all(&stdin_buffer.clone())
+                        .is_err()
+                    {
+                        return input.open(stdin, stdout_identifier);
+                    }
+
+                    let lessopen_output = match lessopen_handle.wait_with_output() {
+                        Ok(output) => output,
+                        Err(_) => {
+                            return input.open(Cursor::new(stdin_buffer), stdout_identifier);
+                        }
+                    };
+
+                    if lessopen_output.stdout.is_empty()
+                        && (!lessopen_output.status.success()
+                            || matches!(self.kind, LessOpenKind::PipedIgnoreExitCode))
+                    {
+                        return input.open(Cursor::new(stdin_buffer), stdout_identifier);
+                    }
+
+                    (
+                        RawOsString::assert_from_raw_vec(lessopen_output.stdout),
+                        "-".to_string(),
+                        OpenedInputKind::StdIn,
+                    )
+                } else {
+                    return input.open(stdin, stdout_identifier);
+                }
+            }
+            InputKind::CustomReader(_) => {
+                return input.open(stdin, stdout_identifier);
+            }
+        };
+
+        Ok(OpenedInput {
+            kind,
+            reader: InputReader::new(BufReader::new(
+                if matches!(self.kind, LessOpenKind::TempFile) {
+                    // Remove newline at end of temporary file path returned by $LESSOPEN
+                    let stdout = match lessopen_stdout.strip_suffix("\n") {
+                        Some(stripped) => stripped.to_owned(),
+                        None => lessopen_stdout,
+                    };
+
+                    let stdout = stdout.into_os_string();
+
+                    let file = match File::open(PathBuf::from(&stdout)) {
+                        Ok(file) => file,
+                        Err(_) => {
+                            return input.open(stdin, stdout_identifier);
+                        }
+                    };
+
+                    Preprocessed {
+                        kind: PreprocessedKind::TempFile(file),
+                        lessclose: self.lessclose.clone(),
+                        command_args: vec![path_str, stdout.to_str().unwrap().to_string()],
+                        command_options: self.command_options.clone(),
+                    }
+                } else {
+                    Preprocessed {
+                        kind: PreprocessedKind::Piped(Cursor::new(lessopen_stdout.into_raw_vec())),
+                        lessclose: self.lessclose.clone(),
+                        command_args: vec![path_str, "-".to_string()],
+                        command_options: self.command_options.clone(),
+                    }
+                },
+            )),
+            metadata: input.metadata,
+            description: input.description,
+        })
+    }
+
+    fn fall_back_to_original_file(&self, lessopen_output: &str, exit_code: i32) -> bool {
+        lessopen_output.is_empty()
+            && (exit_code != 0 || matches!(self.kind, LessOpenKind::PipedIgnoreExitCode))
+    }
+
+    #[cfg(test)]
+    /// For testing purposes only
+    /// Create an instance of LessOpenPreprocessor with specified valued for $LESSOPEN and $LESSCLOSE
+    fn mock_new(lessopen: Option<&str>, lessclose: Option<&str>) -> Result<LessOpenPreprocessor> {
+        if let Some(command) = lessopen {
+            env::set_var("LESSOPEN", command)
+        } else {
+            env::remove_var("LESSOPEN")
+        }
+
+        if let Some(command) = lessclose {
+            env::set_var("LESSCLOSE", command)
+        } else {
+            env::remove_var("LESSCLOSE")
+        }
+
+        Self::new()
+    }
+}
+
+enum PreprocessedKind {
+    Piped(Cursor<Vec<u8>>),
+    TempFile(File),
+}
+
+impl Read for PreprocessedKind {
+    fn read(&mut self, buf: &mut [u8]) -> std::result::Result<usize, std::io::Error> {
+        match self {
+            PreprocessedKind::Piped(data) => data.read(buf),
+            PreprocessedKind::TempFile(data) => data.read(buf),
+        }
+    }
+}
+
+pub struct Preprocessed {
+    kind: PreprocessedKind,
+    lessclose: Option<String>,
+    command_args: Vec<String>,
+    command_options: ScriptOptions,
+}
+
+impl Read for Preprocessed {
+    fn read(&mut self, buf: &mut [u8]) -> std::result::Result<usize, std::io::Error> {
+        self.kind.read(buf)
+    }
+}
+
+impl Drop for Preprocessed {
+    fn drop(&mut self) {
+        if let Some(ref command) = self.lessclose {
+            self.command_options.output_redirection = IoOptions::Inherit;
+
+            run_script::run(command, &self.command_args, &self.command_options)
+                .expect("failed to run $LESSCLOSE to clean up file");
+        }
+    }
+}
+
+#[cfg(test)]
+mod tests {
+    // All tests here are serial because they all involve reading and writing environment variables
+    // Running them in parallel causes these tests and some others to randomly fail
+    use serial_test::serial;
+
+    use super::*;
+
+    /// Reset environment variables after each test as a precaution
+    fn reset_env_vars() {
+        env::remove_var("LESSOPEN");
+        env::remove_var("LESSCLOSE");
+    }
+
+    #[test]
+    #[serial]
+    fn test_just_lessopen() -> Result<()> {
+        let preprocessor = LessOpenPreprocessor::mock_new(Some("|batpipe %s"), None)?;
+
+        assert_eq!(preprocessor.lessopen, "batpipe $1");
+        assert!(preprocessor.lessclose.is_none());
+
+        reset_env_vars();
+
+        Ok(())
+    }
+
+    #[test]
+    #[serial]
+    fn test_just_lessclose() -> Result<()> {
+        let preprocessor = LessOpenPreprocessor::mock_new(None, Some("lessclose.sh %s %s"));
+
+        assert!(preprocessor.is_err());
+
+        reset_env_vars();
+
+        Ok(())
+    }
+
+    #[test]
+    #[serial]
+    fn test_both_lessopen_and_lessclose() -> Result<()> {
+        let preprocessor =
+            LessOpenPreprocessor::mock_new(Some("lessopen.sh %s"), Some("lessclose.sh %s %s"))?;
+
+        assert_eq!(preprocessor.lessopen, "lessopen.sh $1");
+        assert_eq!(preprocessor.lessclose.unwrap(), "lessclose.sh $1 $2");
+
+        reset_env_vars();
+
+        Ok(())
+    }
+
+    #[test]
+    #[serial]
+    fn test_lessopen_prefixes() -> Result<()> {
+        let preprocessor = LessOpenPreprocessor::mock_new(Some("batpipe %s"), None)?;
+
+        assert_eq!(preprocessor.lessopen, "batpipe $1");
+        assert!(matches!(preprocessor.kind, LessOpenKind::TempFile));
+        assert!(!preprocessor.preprocess_stdin);
+
+        let preprocessor = LessOpenPreprocessor::mock_new(Some("|batpipe %s"), None)?;
+
+        assert_eq!(preprocessor.lessopen, "batpipe $1");
+        assert!(matches!(
+            preprocessor.kind,
+            LessOpenKind::PipedIgnoreExitCode
+        ));
+        assert!(!preprocessor.preprocess_stdin);
+
+        let preprocessor = LessOpenPreprocessor::mock_new(Some("||batpipe %s"), None)?;
+
+        assert_eq!(preprocessor.lessopen, "batpipe $1");
+        assert!(matches!(preprocessor.kind, LessOpenKind::Piped));
+        assert!(!preprocessor.preprocess_stdin);
+
+        let preprocessor = LessOpenPreprocessor::mock_new(Some("-batpipe %s"), None)?;
+
+        assert_eq!(preprocessor.lessopen, "batpipe $1");
+        assert!(matches!(preprocessor.kind, LessOpenKind::TempFile));
+        assert!(preprocessor.preprocess_stdin);
+
+        let preprocessor = LessOpenPreprocessor::mock_new(Some("|-batpipe %s"), None)?;
+
+        assert_eq!(preprocessor.lessopen, "batpipe $1");
+        assert!(matches!(
+            preprocessor.kind,
+            LessOpenKind::PipedIgnoreExitCode
+        ));
+        assert!(preprocessor.preprocess_stdin);
+
+        let preprocessor = LessOpenPreprocessor::mock_new(Some("||-batpipe %s"), None)?;
+
+        assert_eq!(preprocessor.lessopen, "batpipe $1");
+        assert!(matches!(preprocessor.kind, LessOpenKind::Piped));
+        assert!(preprocessor.preprocess_stdin);
+
+        reset_env_vars();
+
+        Ok(())
+    }
+
+    #[test]
+    #[serial]
+    fn replace_part_of_argument() -> Result<()> {
+        let preprocessor =
+            LessOpenPreprocessor::mock_new(Some("|echo File:%s"), Some("echo File:%s Temp:%s"))?;
+
+        assert_eq!(preprocessor.lessopen, "echo File:$1");
+        assert_eq!(preprocessor.lessclose.unwrap(), "echo File:$1 Temp:$2");
+
+        reset_env_vars();
+
+        Ok(())
+    }
+}

src/lib.rs

@@ -34,7 +34,10 @@ mod diff;
 pub mod error;
 pub mod input;
 mod less;
+#[cfg(feature = "lessopen")]
+mod lessopen;
 pub mod line_range;
+pub(crate) mod nonprintable_notation;
 mod output;
 #[cfg(feature = "paging")]
 mod pager;
@@ -46,8 +49,10 @@ pub(crate) mod printer;
 pub mod style;
 pub(crate) mod syntax_mapping;
 mod terminal;
+mod vscreen;
 pub(crate) mod wrapping;
 
+pub use nonprintable_notation::NonprintableNotation;
 pub use pretty_printer::{Input, PrettyPrinter, Syntax};
 pub use syntax_mapping::{MappingTarget, SyntaxMapping};
 pub use wrapping::WrappingMode;

src/line_range.rs

@@ -53,7 +53,7 @@ impl LineRange {
                     let more_lines = &line_numbers[1][1..]
                         .parse()
                         .map_err(|_| "Invalid character after +")?;
-                    new_range.lower + more_lines
+                    new_range.lower.saturating_add(*more_lines)
                 } else if first_byte == Some(b'-') {
                     // this will prevent values like "-+5" even though "+5" is valid integer
                     if line_numbers[1][1..].bytes().next() == Some(b'+') {
@@ -128,6 +128,13 @@ fn test_parse_plus() {
     assert_eq!(50, range.upper);
 }
 
+#[test]
+fn test_parse_plus_overflow() {
+    let range = LineRange::from(&format!("{}:+1", usize::MAX)).expect("Shouldn't fail on test!");
+    assert_eq!(usize::MAX, range.lower);
+    assert_eq!(usize::MAX, range.upper);
+}
+
 #[test]
 fn test_parse_plus_fail() {
     let range = LineRange::from("40:+z");

src/macros.rs

@@ -1,7 +1,7 @@
 #[macro_export]
 macro_rules! bat_warning {
     ($($arg:tt)*) => ({
-        use ansi_term::Colour::Yellow;
+        use nu_ansi_term::Color::Yellow;
         eprintln!("{}: {}", Yellow.paint("[bat warning]"), format!($($arg)*));
     })
 }

src/nonprintable_notation.rs

@@ -0,0 +1,12 @@
+/// How to print non-printable characters with
+/// [crate::config::Config::show_nonprintable]
+#[derive(Debug, Default, Clone, Copy, PartialEq, Eq)]
+#[non_exhaustive]
+pub enum NonprintableNotation {
+    /// Use caret notation (^G, ^J, ^@, ..)
+    Caret,
+
+    /// Use unicode notation (␇, ␊, ␀, ..)
+    #[default]
+    Unicode,
+}

src/output.rs

@@ -114,6 +114,10 @@ impl OutputType {
                 p.args(args);
             }
             p.env("LESSCHARSET", "UTF-8");
+
+            #[cfg(feature = "lessopen")]
+            // Ensures that 'less' does not preprocess input again if '$LESSOPEN' is set.
+            p.arg("--no-lessopen");
         } else {
             p.args(args);
         };

src/paging.rs

@@ -1,12 +1,7 @@
-#[derive(Debug, Clone, Copy, PartialEq, Eq)]
+#[derive(Debug, Default, Clone, Copy, PartialEq, Eq)]
 pub enum PagingMode {
     Always,
     QuitIfOneScreen,
+    #[default]
     Never,
 }
-
-impl Default for PagingMode {
-    fn default() -> Self {
-        PagingMode::Never
-    }
-}

src/preprocessor.rs

@@ -1,28 +1,39 @@
 use std::fmt::Write;
 
+use console::AnsiCodeIterator;
+
+use crate::nonprintable_notation::NonprintableNotation;
+
 /// Expand tabs like an ANSI-enabled expand(1).
-pub fn expand_tabs(mut text: &str, width: usize, cursor: &mut usize) -> String {
-    let mut buffer = String::with_capacity(text.len() * 2);
+pub fn expand_tabs(line: &str, width: usize, cursor: &mut usize) -> String {
+    let mut buffer = String::with_capacity(line.len() * 2);
 
-    while let Some(index) = text.find('\t') {
-        // Add previous text.
-        if index > 0 {
-            *cursor += index;
-            buffer.push_str(&text[0..index]);
+    for chunk in AnsiCodeIterator::new(line) {
+        match chunk {
+            (text, true) => buffer.push_str(text),
+            (mut text, false) => {
+                while let Some(index) = text.find('\t') {
+                    // Add previous text.
+                    if index > 0 {
+                        *cursor += index;
+                        buffer.push_str(&text[0..index]);
+                    }
+
+                    // Add tab.
+                    let spaces = width - (*cursor % width);
+                    *cursor += spaces;
+                    buffer.push_str(&" ".repeat(spaces));
+
+                    // Next.
+                    text = &text[index + 1..text.len()];
+                }
+
+                *cursor += text.len();
+                buffer.push_str(text);
+            }
         }
-
-        // Add tab.
-        let spaces = width - (*cursor % width);
-        *cursor += spaces;
-        buffer.push_str(&*" ".repeat(spaces));
-
-        // Next.
-        text = &text[index + 1..text.len()];
     }
 
-    *cursor += text.len();
-    buffer.push_str(text);
-
     buffer
 }
 
@@ -40,7 +51,11 @@ fn try_parse_utf8_char(input: &[u8]) -> Option<(char, usize)> {
     decoded.map(|(seq, n)| (seq.chars().next().unwrap(), n))
 }
 
-pub fn replace_nonprintable(input: &[u8], tab_width: usize) -> String {
+pub fn replace_nonprintable(
+    input: &[u8],
+    tab_width: usize,
+    nonprintable_notation: NonprintableNotation,
+) -> String {
     let mut output = String::new();
 
     let tab_width = if tab_width == 0 { 4 } else { tab_width };
@@ -70,19 +85,37 @@ pub fn replace_nonprintable(input: &[u8], tab_width: usize) -> String {
                 }
                 // line feed
                 '\x0A' => {
-                    output.push_str("␊\x0A");
+                    output.push_str(match nonprintable_notation {
+                        NonprintableNotation::Caret => "^J\x0A",
+                        NonprintableNotation::Unicode => "␊\x0A",
+                    });
                     line_idx = 0;
                 }
                 // carriage return
-                '\x0D' => output.push('␍'),
+                '\x0D' => output.push_str(match nonprintable_notation {
+                    NonprintableNotation::Caret => "^M",
+                    NonprintableNotation::Unicode => "␍",
+                }),
                 // null
-                '\x00' => output.push('␀'),
+                '\x00' => output.push_str(match nonprintable_notation {
+                    NonprintableNotation::Caret => "^@",
+                    NonprintableNotation::Unicode => "␀",
+                }),
                 // bell
-                '\x07' => output.push('␇'),
+                '\x07' => output.push_str(match nonprintable_notation {
+                    NonprintableNotation::Caret => "^G",
+                    NonprintableNotation::Unicode => "␇",
+                }),
                 // backspace
-                '\x08' => output.push('␈'),
+                '\x08' => output.push_str(match nonprintable_notation {
+                    NonprintableNotation::Caret => "^H",
+                    NonprintableNotation::Unicode => "␈",
+                }),
                 // escape
-                '\x1B' => output.push('␛'),
+                '\x1B' => output.push_str(match nonprintable_notation {
+                    NonprintableNotation::Caret => "^[",
+                    NonprintableNotation::Unicode => "␛",
+                }),
                 // printable ASCII
                 c if c.is_ascii_alphanumeric()
                     || c.is_ascii_punctuation()

src/pretty_printer.rs

@@ -10,7 +10,7 @@ use crate::{
     error::Result,
     input,
     line_range::{HighlightedLineRanges, LineRange, LineRanges},
-    style::{StyleComponent, StyleComponents},
+    style::StyleComponent,
     SyntaxMapping, WrappingMode,
 };
 
@@ -19,7 +19,8 @@ use crate::paging::PagingMode;
 
 #[derive(Default)]
 struct ActiveStyleComponents {
-    header: bool,
+    header_filename: bool,
+    #[cfg(feature = "git")]
     vcs_modification_markers: bool,
     grid: bool,
     rule: bool,
@@ -139,7 +140,7 @@ impl<'a> PrettyPrinter<'a> {
 
     /// Whether to show a header with the file name
     pub fn header(&mut self, yes: bool) -> &mut Self {
-        self.active_style_components.header = yes;
+        self.active_style_components.header_filename = yes;
         self
     }
 
@@ -269,35 +270,37 @@ impl<'a> PrettyPrinter<'a> {
             .term_width
             .unwrap_or_else(|| Term::stdout().size().1 as usize);
 
-        let mut style_components = vec![];
+        self.config.style_components.clear();
         if self.active_style_components.grid {
-            style_components.push(StyleComponent::Grid);
+            self.config.style_components.insert(StyleComponent::Grid);
         }
         if self.active_style_components.rule {
-            style_components.push(StyleComponent::Rule);
+            self.config.style_components.insert(StyleComponent::Rule);
         }
-        if self.active_style_components.header {
-            style_components.push(StyleComponent::Header);
+        if self.active_style_components.header_filename {
+            self.config
+                .style_components
+                .insert(StyleComponent::HeaderFilename);
         }
         if self.active_style_components.line_numbers {
-            style_components.push(StyleComponent::LineNumbers);
+            self.config
+                .style_components
+                .insert(StyleComponent::LineNumbers);
         }
         if self.active_style_components.snip {
-            style_components.push(StyleComponent::Snip);
+            self.config.style_components.insert(StyleComponent::Snip);
         }
+        #[cfg(feature = "git")]
         if self.active_style_components.vcs_modification_markers {
-            #[cfg(feature = "git")]
-            style_components.push(StyleComponent::Changes);
+            self.config.style_components.insert(StyleComponent::Changes);
         }
-        self.config.style_components = StyleComponents::new(&style_components);
 
         // Collect the inputs to print
-        let mut inputs: Vec<Input> = vec![];
-        std::mem::swap(&mut inputs, &mut self.inputs);
+        let inputs = std::mem::take(&mut self.inputs);
 
         // Run the controller
         let controller = Controller::new(&self.config, &self.assets);
-        controller.run(inputs.into_iter().map(|i| i.into()).collect())
+        controller.run(inputs.into_iter().map(|i| i.into()).collect(), None)
     }
 }
 

src/printer.rs

@@ -1,11 +1,14 @@
-use std::io::Write;
+use std::fmt;
+use std::io;
 use std::vec::Vec;
 
-use ansi_term::Colour::{Fixed, Green, Red, Yellow};
-use ansi_term::Style;
+use nu_ansi_term::Color::{Fixed, Green, Red, Yellow};
+use nu_ansi_term::Style;
 
 use bytesize::ByteSize;
 
+use console::AnsiCodeIterator;
+
 use syntect::easy::HighlightLines;
 use syntect::highlighting::Color;
 use syntect::highlighting::Theme;
@@ -13,8 +16,7 @@ use syntect::parsing::SyntaxSet;
 
 use content_inspector::ContentType;
 
-use encoding::all::{UTF_16BE, UTF_16LE};
-use encoding::{DecoderTrap, Encoding};
+use encoding_rs::{UTF_16BE, UTF_16LE};
 
 use unicode_width::UnicodeWidthChar;
 
@@ -31,23 +33,38 @@ use crate::line_range::RangeCheckResult;
 use crate::preprocessor::{expand_tabs, replace_nonprintable};
 use crate::style::StyleComponent;
 use crate::terminal::{as_terminal_escaped, to_ansi_color};
+use crate::vscreen::AnsiStyle;
 use crate::wrapping::WrappingMode;
 
+pub enum OutputHandle<'a> {
+    IoWrite(&'a mut dyn io::Write),
+    FmtWrite(&'a mut dyn fmt::Write),
+}
+
+impl<'a> OutputHandle<'a> {
+    fn write_fmt(&mut self, args: fmt::Arguments<'_>) -> Result<()> {
+        match self {
+            Self::IoWrite(handle) => handle.write_fmt(args).map_err(Into::into),
+            Self::FmtWrite(handle) => handle.write_fmt(args).map_err(Into::into),
+        }
+    }
+}
+
 pub(crate) trait Printer {
     fn print_header(
         &mut self,
-        handle: &mut dyn Write,
+        handle: &mut OutputHandle,
         input: &OpenedInput,
         add_header_padding: bool,
     ) -> Result<()>;
-    fn print_footer(&mut self, handle: &mut dyn Write, input: &OpenedInput) -> Result<()>;
+    fn print_footer(&mut self, handle: &mut OutputHandle, input: &OpenedInput) -> Result<()>;
 
-    fn print_snip(&mut self, handle: &mut dyn Write) -> Result<()>;
+    fn print_snip(&mut self, handle: &mut OutputHandle) -> Result<()>;
 
     fn print_line(
         &mut self,
         out_of_range: bool,
-        handle: &mut dyn Write,
+        handle: &mut OutputHandle,
         line_number: usize,
         line_buffer: &[u8],
     ) -> Result<()>;
@@ -66,34 +83,50 @@ impl<'a> SimplePrinter<'a> {
 impl<'a> Printer for SimplePrinter<'a> {
     fn print_header(
         &mut self,
-        _handle: &mut dyn Write,
+        _handle: &mut OutputHandle,
         _input: &OpenedInput,
         _add_header_padding: bool,
     ) -> Result<()> {
         Ok(())
     }
 
-    fn print_footer(&mut self, _handle: &mut dyn Write, _input: &OpenedInput) -> Result<()> {
+    fn print_footer(&mut self, _handle: &mut OutputHandle, _input: &OpenedInput) -> Result<()> {
         Ok(())
     }
 
-    fn print_snip(&mut self, _handle: &mut dyn Write) -> Result<()> {
+    fn print_snip(&mut self, _handle: &mut OutputHandle) -> Result<()> {
         Ok(())
     }
 
     fn print_line(
         &mut self,
         out_of_range: bool,
-        handle: &mut dyn Write,
+        handle: &mut OutputHandle,
         _line_number: usize,
         line_buffer: &[u8],
     ) -> Result<()> {
         if !out_of_range {
             if self.config.show_nonprintable {
-                let line = replace_nonprintable(line_buffer, self.config.tab_width);
+                let line = replace_nonprintable(
+                    line_buffer,
+                    self.config.tab_width,
+                    self.config.nonprintable_notation,
+                );
                 write!(handle, "{}", line)?;
             } else {
-                handle.write_all(line_buffer)?
+                match handle {
+                    OutputHandle::IoWrite(handle) => handle.write_all(line_buffer)?,
+                    OutputHandle::FmtWrite(handle) => {
+                        write!(
+                            handle,
+                            "{}",
+                            std::str::from_utf8(line_buffer).map_err(|_| Error::Msg(
+                                "encountered invalid utf8 while printing to non-io buffer"
+                                    .to_string()
+                            ))?
+                        )?;
+                    }
+                }
             };
         }
         Ok(())
@@ -119,6 +152,7 @@ pub(crate) struct InteractivePrinter<'a> {
     config: &'a Config<'a>,
     decorations: Vec<Box<dyn Decoration>>,
     panel_width: usize,
+    ansi_style: AnsiStyle,
     content_type: Option<ContentType>,
     #[cfg(feature = "git")]
     pub line_changes: &'a Option<LineChanges>,
@@ -202,6 +236,7 @@ impl<'a> InteractivePrinter<'a> {
             config,
             decorations,
             content_type: input.reader.content_type,
+            ansi_style: AnsiStyle::new(),
             #[cfg(feature = "git")]
             line_changes,
             highlighter_from_set,
@@ -209,7 +244,11 @@ impl<'a> InteractivePrinter<'a> {
         })
     }
 
-    fn print_horizontal_line_term(&mut self, handle: &mut dyn Write, style: Style) -> Result<()> {
+    fn print_horizontal_line_term(
+        &mut self,
+        handle: &mut OutputHandle,
+        style: Style,
+    ) -> Result<()> {
         writeln!(
             handle,
             "{}",
@@ -218,7 +257,7 @@ impl<'a> InteractivePrinter<'a> {
         Ok(())
     }
 
-    fn print_horizontal_line(&mut self, handle: &mut dyn Write, grid_char: char) -> Result<()> {
+    fn print_horizontal_line(&mut self, handle: &mut OutputHandle, grid_char: char) -> Result<()> {
         if self.panel_width == 0 {
             self.print_horizontal_line_term(handle, self.colors.grid)?;
         } else {
@@ -248,7 +287,7 @@ impl<'a> InteractivePrinter<'a> {
         }
     }
 
-    fn print_header_component_indent(&mut self, handle: &mut dyn Write) -> std::io::Result<()> {
+    fn print_header_component_indent(&mut self, handle: &mut OutputHandle) -> Result<()> {
         if self.config.style_components.grid() {
             write!(
                 handle,
@@ -276,7 +315,7 @@ impl<'a> InteractivePrinter<'a> {
 impl<'a> Printer for InteractivePrinter<'a> {
     fn print_header(
         &mut self,
-        handle: &mut dyn Write,
+        handle: &mut OutputHandle,
         input: &OpenedInput,
         add_header_padding: bool,
     ) -> Result<()> {
@@ -375,7 +414,7 @@ impl<'a> Printer for InteractivePrinter<'a> {
         Ok(())
     }
 
-    fn print_footer(&mut self, handle: &mut dyn Write, _input: &OpenedInput) -> Result<()> {
+    fn print_footer(&mut self, handle: &mut OutputHandle, _input: &OpenedInput) -> Result<()> {
         if self.config.style_components.grid()
             && (self.content_type.map_or(false, |c| c.is_text()) || self.config.show_nonprintable)
         {
@@ -385,7 +424,7 @@ impl<'a> Printer for InteractivePrinter<'a> {
         }
     }
 
-    fn print_snip(&mut self, handle: &mut dyn Write) -> Result<()> {
+    fn print_snip(&mut self, handle: &mut OutputHandle) -> Result<()> {
         let panel = self.create_fake_panel(" ...");
         let panel_count = panel.chars().count();
 
@@ -412,33 +451,35 @@ impl<'a> Printer for InteractivePrinter<'a> {
     fn print_line(
         &mut self,
         out_of_range: bool,
-        handle: &mut dyn Write,
+        handle: &mut OutputHandle,
         line_number: usize,
         line_buffer: &[u8],
     ) -> Result<()> {
         let line = if self.config.show_nonprintable {
-            replace_nonprintable(line_buffer, self.config.tab_width)
+            replace_nonprintable(
+                line_buffer,
+                self.config.tab_width,
+                self.config.nonprintable_notation,
+            )
+            .into()
         } else {
-            let line = match self.content_type {
+            match self.content_type {
                 Some(ContentType::BINARY) | None => {
                     return Ok(());
                 }
-                Some(ContentType::UTF_16LE) => UTF_16LE
-                    .decode(line_buffer, DecoderTrap::Replace)
-                    .map_err(|_| "Invalid UTF-16LE")?,
-                Some(ContentType::UTF_16BE) => UTF_16BE
-                    .decode(line_buffer, DecoderTrap::Replace)
-                    .map_err(|_| "Invalid UTF-16BE")?,
-                _ => String::from_utf8_lossy(line_buffer).to_string(),
-            };
-            // Remove byte order mark from the first line if it exists
-            if line_number == 1 {
-                match line.strip_prefix('\u{feff}') {
-                    Some(stripped) => stripped.to_string(),
-                    None => line,
+                Some(ContentType::UTF_16LE) => UTF_16LE.decode_with_bom_removal(line_buffer).0,
+                Some(ContentType::UTF_16BE) => UTF_16BE.decode_with_bom_removal(line_buffer).0,
+                _ => {
+                    let line = String::from_utf8_lossy(line_buffer);
+                    if line_number == 1 {
+                        match line.strip_prefix('\u{feff}') {
+                            Some(stripped) => stripped.to_string().into(),
+                            None => line,
+                        }
+                    } else {
+                        line
+                    }
                 }
-            } else {
-                line
             }
         };
 
@@ -480,7 +521,7 @@ impl<'a> Printer for InteractivePrinter<'a> {
             self.config.highlighted_lines.0.check(line_number) == RangeCheckResult::InRange;
 
         if highlight_this_line && self.config.theme == "ansi" {
-            write!(handle, "\x1B[4m")?;
+            self.ansi_style.update("^[4m");
         }
 
         let background_color = self
@@ -507,37 +548,51 @@ impl<'a> Printer for InteractivePrinter<'a> {
             let italics = self.config.use_italic_text;
 
             for &(style, region) in &regions {
-                let text = &*self.preprocess(region, &mut cursor_total);
-                let text_trimmed = text.trim_end_matches(|c| c == '\r' || c == '\n');
+                let ansi_iterator = AnsiCodeIterator::new(region);
+                for chunk in ansi_iterator {
+                    match chunk {
+                        // ANSI escape passthrough.
+                        (ansi, true) => {
+                            self.ansi_style.update(ansi);
+                            write!(handle, "{}", ansi)?;
+                        }
 
-                write!(
-                    handle,
-                    "{}",
-                    as_terminal_escaped(
-                        style,
-                        text_trimmed,
-                        true_color,
-                        colored_output,
-                        italics,
-                        background_color
-                    )
-                )?;
+                        // Regular text.
+                        (text, false) => {
+                            let text = &*self.preprocess(text, &mut cursor_total);
+                            let text_trimmed = text.trim_end_matches(|c| c == '\r' || c == '\n');
 
-                if text.len() != text_trimmed.len() {
-                    if let Some(background_color) = background_color {
-                        let ansi_style = Style {
-                            background: to_ansi_color(background_color, true_color),
-                            ..Default::default()
-                        };
+                            write!(
+                                handle,
+                                "{}",
+                                as_terminal_escaped(
+                                    style,
+                                    &format!("{}{}", self.ansi_style, text_trimmed),
+                                    true_color,
+                                    colored_output,
+                                    italics,
+                                    background_color
+                                )
+                            )?;
 
-                        let width = if cursor_total <= cursor_max {
-                            cursor_max - cursor_total + 1
-                        } else {
-                            0
-                        };
-                        write!(handle, "{}", ansi_style.paint(" ".repeat(width)))?;
+                            if text.len() != text_trimmed.len() {
+                                if let Some(background_color) = background_color {
+                                    let ansi_style = Style {
+                                        background: to_ansi_color(background_color, true_color),
+                                        ..Default::default()
+                                    };
+
+                                    let width = if cursor_total <= cursor_max {
+                                        cursor_max - cursor_total + 1
+                                    } else {
+                                        0
+                                    };
+                                    write!(handle, "{}", ansi_style.paint(" ".repeat(width)))?;
+                                }
+                                write!(handle, "{}", &text[text_trimmed.len()..])?;
+                            }
+                        }
                     }
-                    write!(handle, "{}", &text[text_trimmed.len()..])?;
                 }
             }
 
@@ -546,82 +601,98 @@ impl<'a> Printer for InteractivePrinter<'a> {
             }
         } else {
             for &(style, region) in &regions {
-                let text = self.preprocess(
-                    region.trim_end_matches(|c| c == '\r' || c == '\n'),
-                    &mut cursor_total,
-                );
-
-                let mut max_width = cursor_max - cursor;
-
-                // line buffer (avoid calling write! for every character)
-                let mut line_buf = String::with_capacity(max_width * 4);
-
-                // Displayed width of line_buf
-                let mut current_width = 0;
-
-                for c in text.chars() {
-                    // calculate the displayed width for next character
-                    let cw = c.width().unwrap_or(0);
-                    current_width += cw;
-
-                    // if next character cannot be printed on this line,
-                    // flush the buffer.
-                    if current_width > max_width {
-                        // Generate wrap padding if not already generated.
-                        if panel_wrap.is_none() {
-                            panel_wrap = if self.panel_width > 0 {
-                                Some(format!(
-                                    "{} ",
-                                    self.decorations
-                                        .iter()
-                                        .map(|d| d.generate(line_number, true, self).text)
-                                        .collect::<Vec<String>>()
-                                        .join(" ")
-                                ))
-                            } else {
-                                Some("".to_string())
-                            }
+                let ansi_iterator = AnsiCodeIterator::new(region);
+                for chunk in ansi_iterator {
+                    match chunk {
+                        // ANSI escape passthrough.
+                        (ansi, true) => {
+                            self.ansi_style.update(ansi);
+                            write!(handle, "{}", ansi)?;
                         }
 
-                        // It wraps.
-                        write!(
-                            handle,
-                            "{}\n{}",
-                            as_terminal_escaped(
-                                style,
-                                &line_buf,
-                                self.config.true_color,
-                                self.config.colored_output,
-                                self.config.use_italic_text,
-                                background_color
-                            ),
-                            panel_wrap.clone().unwrap()
-                        )?;
+                        // Regular text.
+                        (text, false) => {
+                            let text = self.preprocess(
+                                text.trim_end_matches(|c| c == '\r' || c == '\n'),
+                                &mut cursor_total,
+                            );
 
-                        cursor = 0;
-                        max_width = cursor_max;
+                            let mut max_width = cursor_max - cursor;
 
-                        line_buf.clear();
-                        current_width = cw;
+                            // line buffer (avoid calling write! for every character)
+                            let mut line_buf = String::with_capacity(max_width * 4);
+
+                            // Displayed width of line_buf
+                            let mut current_width = 0;
+
+                            for c in text.chars() {
+                                // calculate the displayed width for next character
+                                let cw = c.width().unwrap_or(0);
+                                current_width += cw;
+
+                                // if next character cannot be printed on this line,
+                                // flush the buffer.
+                                if current_width > max_width {
+                                    // Generate wrap padding if not already generated.
+                                    if panel_wrap.is_none() {
+                                        panel_wrap = if self.panel_width > 0 {
+                                            Some(format!(
+                                                "{} ",
+                                                self.decorations
+                                                    .iter()
+                                                    .map(|d| d
+                                                        .generate(line_number, true, self)
+                                                        .text)
+                                                    .collect::<Vec<String>>()
+                                                    .join(" ")
+                                            ))
+                                        } else {
+                                            Some("".to_string())
+                                        }
+                                    }
+
+                                    // It wraps.
+                                    write!(
+                                        handle,
+                                        "{}\n{}",
+                                        as_terminal_escaped(
+                                            style,
+                                            &format!("{}{}", self.ansi_style, line_buf),
+                                            self.config.true_color,
+                                            self.config.colored_output,
+                                            self.config.use_italic_text,
+                                            background_color
+                                        ),
+                                        panel_wrap.clone().unwrap()
+                                    )?;
+
+                                    cursor = 0;
+                                    max_width = cursor_max;
+
+                                    line_buf.clear();
+                                    current_width = cw;
+                                }
+
+                                line_buf.push(c);
+                            }
+
+                            // flush the buffer
+                            cursor += current_width;
+                            write!(
+                                handle,
+                                "{}",
+                                as_terminal_escaped(
+                                    style,
+                                    &format!("{}{}", self.ansi_style, line_buf),
+                                    self.config.true_color,
+                                    self.config.colored_output,
+                                    self.config.use_italic_text,
+                                    background_color
+                                )
+                            )?;
+                        }
                     }
-
-                    line_buf.push(c);
                 }
-
-                // flush the buffer
-                cursor += current_width;
-                write!(
-                    handle,
-                    "{}",
-                    as_terminal_escaped(
-                        style,
-                        &line_buf,
-                        self.config.true_color,
-                        self.config.colored_output,
-                        self.config.use_italic_text,
-                        background_color
-                    )
-                )?;
             }
 
             if let Some(background_color) = background_color {
@@ -640,6 +711,7 @@ impl<'a> Printer for InteractivePrinter<'a> {
         }
 
         if highlight_this_line && self.config.theme == "ansi" {
+            self.ansi_style.update("^[24m");
             write!(handle, "\x1B[24m")?;
         }
 

src/style.rs

@@ -129,4 +129,12 @@ impl StyleComponents {
     pub fn plain(&self) -> bool {
         self.0.iter().all(|c| c == &StyleComponent::Plain)
     }
+
+    pub fn insert(&mut self, component: StyleComponent) {
+        self.0.insert(component);
+    }
+
+    pub fn clear(&mut self) {
+        self.0.clear();
+    }
 }

src/syntax_mapping.rs

@@ -63,6 +63,12 @@ impl<'a> SyntaxMapping<'a> {
                 MappingTarget::MapTo("Bourne Again Shell (bash)"),
             )
             .unwrap();
+        mapping
+            .insert(
+                "os-release",
+                MappingTarget::MapTo("Bourne Again Shell (bash)"),
+            )
+            .unwrap();
         mapping
             .insert("*.pac", MappingTarget::MapTo("JavaScript (Babel)"))
             .unwrap();
@@ -70,6 +76,10 @@ impl<'a> SyntaxMapping<'a> {
             .insert("fish_history", MappingTarget::MapTo("YAML"))
             .unwrap();
 
+        for glob in ["*.jsonl", "*.sarif"] {
+            mapping.insert(glob, MappingTarget::MapTo("JSON")).unwrap();
+        }
+
         // See #2151, https://nmap.org/book/nse-language.html
         mapping
             .insert("*.nse", MappingTarget::MapTo("Lua"))
@@ -80,6 +90,14 @@ impl<'a> SyntaxMapping<'a> {
             .insert("rails", MappingTarget::MapToUnknown)
             .unwrap();
 
+        mapping
+            .insert("Containerfile", MappingTarget::MapTo("Dockerfile"))
+            .unwrap();
+
+        mapping
+            .insert("*.ksh", MappingTarget::MapTo("Bourne Again Shell (bash)"))
+            .unwrap();
+
         // Nginx and Apache syntax files both want to style all ".conf" files
         // see #1131 and #1137
         mapping
@@ -138,19 +156,30 @@ impl<'a> SyntaxMapping<'a> {
             .insert("*.hook", MappingTarget::MapTo("INI"))
             .unwrap();
 
+        mapping
+            .insert("*.ron", MappingTarget::MapTo("Rust"))
+            .unwrap();
+
         // Global git config files rooted in `$XDG_CONFIG_HOME/git/` or `$HOME/.config/git/`
         // See e.g. https://git-scm.com/docs/git-config#FILES
-        if let Some(xdg_config_home) =
-            std::env::var_os("XDG_CONFIG_HOME").filter(|val| !val.is_empty())
-        {
-            insert_git_config_global(&mut mapping, &xdg_config_home);
-        }
-        if let Some(default_config_home) = std::env::var_os("HOME")
-            .filter(|val| !val.is_empty())
-            .map(|home| Path::new(&home).join(".config"))
-        {
-            insert_git_config_global(&mut mapping, &default_config_home);
-        }
+        match (
+            std::env::var_os("XDG_CONFIG_HOME").filter(|val| !val.is_empty()),
+            std::env::var_os("HOME")
+                .filter(|val| !val.is_empty())
+                .map(|home| Path::new(&home).join(".config")),
+        ) {
+            (Some(xdg_config_home), Some(default_config_home))
+                if xdg_config_home == default_config_home => {
+                insert_git_config_global(&mut mapping, &xdg_config_home)
+            }
+            (Some(xdg_config_home), Some(default_config_home)) /* else guard */ => {
+                insert_git_config_global(&mut mapping, &xdg_config_home);
+                insert_git_config_global(&mut mapping, &default_config_home)
+            }
+            (Some(config_home), None) => insert_git_config_global(&mut mapping, &config_home),
+            (None, Some(config_home)) => insert_git_config_global(&mut mapping, &config_home),
+            (None, None) => (),
+        };
 
         fn insert_git_config_global(mapping: &mut SyntaxMapping, config_home: impl AsRef<Path>) {
             let git_config_path = config_home.as_ref().join("git");
@@ -182,7 +211,7 @@ impl<'a> SyntaxMapping<'a> {
 
     pub fn insert(&mut self, from: &str, to: MappingTarget<'a>) -> Result<()> {
         let glob = GlobBuilder::new(from)
-            .case_insensitive(false)
+            .case_insensitive(true)
             .literal_separator(true)
             .build()?;
         self.mappings.push((glob.compile_matcher(), to));
@@ -220,48 +249,76 @@ impl<'a> SyntaxMapping<'a> {
     }
 }
 
-#[test]
-fn basic() {
-    let mut map = SyntaxMapping::empty();
-    map.insert("/path/to/Cargo.lock", MappingTarget::MapTo("TOML"))
-        .ok();
-    map.insert("/path/to/.ignore", MappingTarget::MapTo("Git Ignore"))
-        .ok();
+#[cfg(test)]
+mod tests {
+    use super::*;
+    #[test]
+    fn basic() {
+        let mut map = SyntaxMapping::empty();
+        map.insert("/path/to/Cargo.lock", MappingTarget::MapTo("TOML"))
+            .ok();
+        map.insert("/path/to/.ignore", MappingTarget::MapTo("Git Ignore"))
+            .ok();
 
-    assert_eq!(
-        map.get_syntax_for("/path/to/Cargo.lock"),
-        Some(MappingTarget::MapTo("TOML"))
-    );
-    assert_eq!(map.get_syntax_for("/path/to/other.lock"), None);
+        assert_eq!(
+            map.get_syntax_for("/path/to/Cargo.lock"),
+            Some(MappingTarget::MapTo("TOML"))
+        );
+        assert_eq!(map.get_syntax_for("/path/to/other.lock"), None);
 
-    assert_eq!(
-        map.get_syntax_for("/path/to/.ignore"),
-        Some(MappingTarget::MapTo("Git Ignore"))
-    );
-}
-
-#[test]
-fn user_can_override_builtin_mappings() {
-    let mut map = SyntaxMapping::builtin();
-
-    assert_eq!(
-        map.get_syntax_for("/etc/profile"),
-        Some(MappingTarget::MapTo("Bourne Again Shell (bash)"))
-    );
-    map.insert("/etc/profile", MappingTarget::MapTo("My Syntax"))
-        .ok();
-    assert_eq!(
-        map.get_syntax_for("/etc/profile"),
-        Some(MappingTarget::MapTo("My Syntax"))
-    );
-}
-
-#[test]
-fn builtin_mappings() {
-    let map = SyntaxMapping::builtin();
-
-    assert_eq!(
-        map.get_syntax_for("/path/to/build"),
-        Some(MappingTarget::MapToUnknown)
-    );
+        assert_eq!(
+            map.get_syntax_for("/path/to/.ignore"),
+            Some(MappingTarget::MapTo("Git Ignore"))
+        );
+    }
+
+    #[test]
+    fn user_can_override_builtin_mappings() {
+        let mut map = SyntaxMapping::builtin();
+
+        assert_eq!(
+            map.get_syntax_for("/etc/profile"),
+            Some(MappingTarget::MapTo("Bourne Again Shell (bash)"))
+        );
+        map.insert("/etc/profile", MappingTarget::MapTo("My Syntax"))
+            .ok();
+        assert_eq!(
+            map.get_syntax_for("/etc/profile"),
+            Some(MappingTarget::MapTo("My Syntax"))
+        );
+    }
+
+    #[test]
+    fn builtin_mappings() {
+        let map = SyntaxMapping::builtin();
+
+        assert_eq!(
+            map.get_syntax_for("/path/to/build"),
+            Some(MappingTarget::MapToUnknown)
+        );
+    }
+
+    #[test]
+    /// verifies that SyntaxMapping::builtin() doesn't repeat `Glob`-based keys
+    fn no_duplicate_builtin_keys() {
+        let mappings = SyntaxMapping::builtin().mappings;
+        for i in 0..mappings.len() {
+            let tail = mappings[i + 1..].into_iter();
+            let (dupl, _): (Vec<_>, Vec<_>) =
+                tail.partition(|item| item.0.glob() == mappings[i].0.glob());
+
+            // emit repeats on failure
+            assert_eq!(
+                dupl.len(),
+                0,
+                "Glob pattern `{}` mapped to multiple: {:?}",
+                mappings[i].0.glob().glob(),
+                {
+                    let (_, mut dupl_targets): (Vec<GlobMatcher>, Vec<MappingTarget>) =
+                        dupl.into_iter().cloned().unzip();
+                    dupl_targets.push(mappings[i].1)
+                },
+            )
+        }
+    }
 }

src/syntax_mapping/ignored_suffixes.rs

@@ -20,7 +20,9 @@ impl Default for IgnoredSuffixes<'_> {
                 ".orig",
                 // Debian and derivatives apt/dpkg/ucf backups
                 ".dpkg-dist",
+                ".dpkg-new",
                 ".dpkg-old",
+                ".dpkg-tmp",
                 ".ucf-dist",
                 ".ucf-new",
                 ".ucf-old",

src/terminal.rs

@@ -1,9 +1,9 @@
-use ansi_term::Color::{self, Fixed, RGB};
-use ansi_term::{self, Style};
+use nu_ansi_term::Color::{self, Fixed, Rgb};
+use nu_ansi_term::{self, Style};
 
 use syntect::highlighting::{self, FontStyle};
 
-pub fn to_ansi_color(color: highlighting::Color, true_color: bool) -> Option<ansi_term::Color> {
+pub fn to_ansi_color(color: highlighting::Color, true_color: bool) -> Option<nu_ansi_term::Color> {
     if color.a == 0 {
         // Themes can specify one of the user-configurable terminal colors by
         // encoding them as #RRGGBBAA with AA set to 00 (transparent) and RR set
@@ -38,7 +38,7 @@ pub fn to_ansi_color(color: highlighting::Color, true_color: bool) -> Option<ans
         // 01. The built-in theme ansi uses this.
         None
     } else if true_color {
-        Some(RGB(color.r, color.g, color.b))
+        Some(Rgb(color.r, color.g, color.b))
     } else {
         Some(Fixed(ansi_colours::ansi256_from_rgb((
             color.r, color.g, color.b,

src/vscreen.rs

@@ -0,0 +1,212 @@
+use std::fmt::{Display, Formatter};
+
+// Wrapper to avoid unnecessary branching when input doesn't have ANSI escape sequences.
+pub struct AnsiStyle {
+    attributes: Option<Attributes>,
+}
+
+impl AnsiStyle {
+    pub fn new() -> Self {
+        AnsiStyle { attributes: None }
+    }
+
+    pub fn update(&mut self, sequence: &str) -> bool {
+        match &mut self.attributes {
+            Some(a) => a.update(sequence),
+            None => {
+                self.attributes = Some(Attributes::new());
+                self.attributes.as_mut().unwrap().update(sequence)
+            }
+        }
+    }
+}
+
+impl Display for AnsiStyle {
+    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
+        match self.attributes {
+            Some(ref a) => a.fmt(f),
+            None => Ok(()),
+        }
+    }
+}
+
+struct Attributes {
+    foreground: String,
+    background: String,
+    underlined: String,
+
+    /// The character set to use.
+    /// REGEX: `\^[()][AB0-3]`
+    charset: String,
+
+    /// A buffer for unknown sequences.
+    unknown_buffer: String,
+
+    /// ON:  ^[1m
+    /// OFF: ^[22m
+    bold: String,
+
+    /// ON:  ^[2m
+    /// OFF: ^[22m
+    dim: String,
+
+    /// ON:  ^[4m
+    /// OFF: ^[24m
+    underline: String,
+
+    /// ON:  ^[3m
+    /// OFF: ^[23m
+    italic: String,
+
+    /// ON:  ^[9m
+    /// OFF: ^[29m
+    strike: String,
+}
+
+impl Attributes {
+    pub fn new() -> Self {
+        Attributes {
+            foreground: "".to_owned(),
+            background: "".to_owned(),
+            underlined: "".to_owned(),
+            charset: "".to_owned(),
+            unknown_buffer: "".to_owned(),
+            bold: "".to_owned(),
+            dim: "".to_owned(),
+            underline: "".to_owned(),
+            italic: "".to_owned(),
+            strike: "".to_owned(),
+        }
+    }
+
+    /// Update the attributes with an escape sequence.
+    /// Returns `false` if the sequence is unsupported.
+    pub fn update(&mut self, sequence: &str) -> bool {
+        let mut chars = sequence.char_indices().skip(1);
+
+        if let Some((_, t)) = chars.next() {
+            match t {
+                '(' => self.update_with_charset('(', chars.map(|(_, c)| c)),
+                ')' => self.update_with_charset(')', chars.map(|(_, c)| c)),
+                '[' => {
+                    if let Some((i, last)) = chars.last() {
+                        // SAFETY: Always starts with ^[ and ends with m.
+                        self.update_with_csi(last, &sequence[2..i])
+                    } else {
+                        false
+                    }
+                }
+                _ => self.update_with_unsupported(sequence),
+            }
+        } else {
+            false
+        }
+    }
+
+    fn sgr_reset(&mut self) {
+        self.foreground.clear();
+        self.background.clear();
+        self.underlined.clear();
+        self.bold.clear();
+        self.dim.clear();
+        self.underline.clear();
+        self.italic.clear();
+        self.strike.clear();
+    }
+
+    fn update_with_sgr(&mut self, parameters: &str) -> bool {
+        let mut iter = parameters
+            .split(';')
+            .map(|p| if p.is_empty() { "0" } else { p })
+            .map(|p| p.parse::<u16>())
+            .map(|p| p.unwrap_or(0)); // Treat errors as 0.
+
+        while let Some(p) = iter.next() {
+            match p {
+                0 => self.sgr_reset(),
+                1 => self.bold = format!("\x1B[{}m", parameters),
+                2 => self.dim = format!("\x1B[{}m", parameters),
+                3 => self.italic = format!("\x1B[{}m", parameters),
+                4 => self.underline = format!("\x1B[{}m", parameters),
+                23 => self.italic.clear(),
+                24 => self.underline.clear(),
+                22 => {
+                    self.bold.clear();
+                    self.dim.clear();
+                }
+                30..=39 => self.foreground = Self::parse_color(p, &mut iter),
+                40..=49 => self.background = Self::parse_color(p, &mut iter),
+                58..=59 => self.underlined = Self::parse_color(p, &mut iter),
+                90..=97 => self.foreground = Self::parse_color(p, &mut iter),
+                100..=107 => self.foreground = Self::parse_color(p, &mut iter),
+                _ => {
+                    // Unsupported SGR sequence.
+                    // Be compatible and pretend one just wasn't was provided.
+                }
+            }
+        }
+
+        true
+    }
+
+    fn update_with_csi(&mut self, finalizer: char, sequence: &str) -> bool {
+        if finalizer == 'm' {
+            self.update_with_sgr(sequence)
+        } else {
+            false
+        }
+    }
+
+    fn update_with_unsupported(&mut self, sequence: &str) -> bool {
+        self.unknown_buffer.push_str(sequence);
+        false
+    }
+
+    fn update_with_charset(&mut self, kind: char, set: impl Iterator<Item = char>) -> bool {
+        self.charset = format!("\x1B{}{}", kind, set.take(1).collect::<String>());
+        true
+    }
+
+    fn parse_color(color: u16, parameters: &mut dyn Iterator<Item = u16>) -> String {
+        match color % 10 {
+            8 => match parameters.next() {
+                Some(5) /* 256-color */ => format!("\x1B[{};5;{}m", color, join(";", 1, parameters)),
+                Some(2) /* 24-bit color */ => format!("\x1B[{};2;{}m", color, join(";", 3, parameters)),
+                Some(c) => format!("\x1B[{};{}m", color, c),
+                _ => "".to_owned(),
+            },
+            9 => "".to_owned(),
+            _ => format!("\x1B[{}m", color),
+        }
+    }
+}
+
+impl Display for Attributes {
+    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
+        write!(
+            f,
+            "{}{}{}{}{}{}{}{}{}",
+            self.foreground,
+            self.background,
+            self.underlined,
+            self.charset,
+            self.bold,
+            self.dim,
+            self.underline,
+            self.italic,
+            self.strike,
+        )
+    }
+}
+
+fn join(
+    delimiter: &str,
+    limit: usize,
+    iterator: &mut dyn Iterator<Item = impl ToString>,
+) -> String {
+    iterator
+        .take(limit)
+        .map(|i| i.to_string())
+        .collect::<Vec<String>>()
+        .join(delimiter)
+}

tests/examples/bat-tabs.conf

@@ -0,0 +1 @@
+--tabs=8

tests/examples/bat-theme.conf

@@ -0,0 +1 @@
+--theme=TwoDark

tests/examples/bat-windows.conf

@@ -0,0 +1,5 @@
+# Make sure that the pager gets executed
+--paging=always
+
+# Output a dummy message for the integration test and system wide config test.
+--pager="echo.bat dummy-pager-from-config"

tests/examples/cache_source/syntaxes/c.sublime-syntax

@@ -0,0 +1,10 @@
+%YAML 1.2
+---
+name: C
+file_extensions: [c, h]
+scope: source.c
+
+contexts:
+  main:
+    - match: \b(if|else|for|while)\b
+      scope: keyword.control.c

tests/examples/cache_source/themes/example.tmTheme

@@ -0,0 +1,45 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple Computer//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>name</key>
+	<string>example</string>
+	<key>settings</key>
+	<array>
+		<dict>
+			<key>settings</key>
+			<dict>
+				<key>background</key>
+				<string>#222222</string>
+				<key>caret</key>
+				<string>#979797</string>
+				<key>foreground</key>
+				<string>#F8F8F8</string>
+				<key>invisibles</key>
+				<string>#777777</string>
+				<key>lineHighlight</key>
+				<string>#000000</string>
+				<key>selection</key>
+				<string>#57CCBF</string>
+			</dict>
+		</dict>
+		<dict>
+			<key>name</key>
+			<string>Comment</string>
+			<key>scope</key>
+			<string>comment</string>
+			<key>settings</key>
+			<dict>
+				<key>foreground</key>
+				<string>#777777</string>
+			</dict>
+		</dict>
+	</array>
+	<key>uuid</key>
+	<string>0123-4567-89AB-CDEF</string>
+	<key>colorSpaceName</key>
+	<string>sRGB</string>
+	<key>semanticClass</key>
+	<string>theme</string>
+</dict>
+</plist>

tests/examples/long-single-line.txt

@@ -0,0 +1 @@
+abcdefghigklmnopqrstuvxyzabcdefghigklmnopqrstuvxyzabcdefghigklmnopqrstuvxyzabcdefghigklmnopqrstuvxyz

tests/examples/map-syntax_case.Config

@@ -0,0 +1 @@
+{"test": "value"}

tests/integration_tests.rs

@@ -34,6 +34,14 @@ use utils::mocked_pagers;
 
 const EXAMPLES_DIR: &str = "tests/examples";
 
+fn get_config() -> &'static str {
+    if cfg!(windows) {
+        "bat-windows.conf"
+    } else {
+        "bat.conf"
+    }
+}
+
 #[test]
 fn basic() {
     bat()
@@ -200,6 +208,24 @@ fn line_range_multiple() {
         .stdout("line 1\nline 2\nline 4\n");
 }
 
+#[test]
+#[cfg_attr(any(not(feature = "git"), target_os = "windows"), ignore)]
+fn short_help() {
+    test_help("-h", "../doc/short-help.txt");
+}
+
+#[test]
+#[cfg_attr(any(not(feature = "git"), target_os = "windows"), ignore)]
+fn long_help() {
+    test_help("--help", "../doc/long-help.txt");
+}
+
+fn test_help(arg: &str, expect_file: &str) {
+    let assert = bat().arg(arg).assert();
+    expect_test::expect_file![expect_file]
+        .assert_eq(&String::from_utf8_lossy(&assert.get_output().stdout));
+}
+
 #[cfg(unix)]
 fn setup_temp_file(content: &[u8]) -> io::Result<(PathBuf, tempfile::TempDir)> {
     let dir = tempfile::tempdir().expect("Couldn't create tempdir");
@@ -282,8 +308,10 @@ fn no_args_doesnt_break() {
     // this test exists.
     let OpenptyResult { master, slave } = openpty(None, None).expect("Couldn't open pty.");
     let mut master = unsafe { File::from_raw_fd(master) };
-    let stdin = unsafe { Stdio::from_raw_fd(slave) };
-    let stdout = unsafe { Stdio::from_raw_fd(slave) };
+    let stdin_file = unsafe { File::from_raw_fd(slave) };
+    let stdout_file = stdin_file.try_clone().unwrap();
+    let stdin = Stdio::from(stdin_file);
+    let stdout = Stdio::from(stdout_file);
 
     let mut child = bat_raw_command()
         .stdin(stdin)
@@ -477,6 +505,79 @@ fn tabs_8() {
         );
 }
 
+#[test]
+fn tabs_4_env_overrides_config() {
+    bat_with_config()
+        .env("BAT_CONFIG_PATH", "bat-tabs.conf")
+        .env("BAT_TABS", "4")
+        .arg("tabs.txt")
+        .arg("--style=plain")
+        .arg("--decorations=always")
+        .assert()
+        .success()
+        .stdout(
+            "    1   2   3   4
+1   ?
+22  ?
+333 ?
+4444    ?
+55555   ?
+666666  ?
+7777777 ?
+88888888    ?
+",
+        );
+}
+
+#[test]
+fn tabs_4_arg_overrides_env() {
+    bat_with_config()
+        .env("BAT_CONFIG_PATH", "bat-tabs.conf")
+        .env("BAT_TABS", "6")
+        .arg("tabs.txt")
+        .arg("--tabs=4")
+        .arg("--style=plain")
+        .arg("--decorations=always")
+        .assert()
+        .success()
+        .stdout(
+            "    1   2   3   4
+1   ?
+22  ?
+333 ?
+4444    ?
+55555   ?
+666666  ?
+7777777 ?
+88888888    ?
+",
+        );
+}
+
+#[test]
+fn tabs_4_arg_overrides_env_noconfig() {
+    bat()
+        .env("BAT_TABS", "6")
+        .arg("tabs.txt")
+        .arg("--tabs=4")
+        .arg("--style=plain")
+        .arg("--decorations=always")
+        .assert()
+        .success()
+        .stdout(
+            "    1   2   3   4
+1   ?
+22  ?
+333 ?
+4444    ?
+55555   ?
+666666  ?
+7777777 ?
+88888888    ?
+",
+        );
+}
+
 #[test]
 fn fail_non_existing() {
     bat().arg("non-existing-file").assert().failure();
@@ -498,26 +599,49 @@ fn do_not_exit_directory() {
 }
 
 #[test]
+#[serial]
 fn pager_basic() {
-    bat()
-        .env("PAGER", "echo pager-output")
-        .arg("--paging=always")
-        .arg("test.txt")
-        .assert()
-        .success()
-        .stdout(predicate::eq("pager-output\n").normalize());
+    mocked_pagers::with_mocked_versions_of_more_and_most_in_path(|| {
+        bat()
+            .env("PAGER", mocked_pagers::from("echo pager-output"))
+            .arg("--paging=always")
+            .arg("test.txt")
+            .assert()
+            .success()
+            .stdout(predicate::str::contains("pager-output\n").normalize());
+    });
 }
 
 #[test]
+#[serial]
+fn pager_basic_arg() {
+    mocked_pagers::with_mocked_versions_of_more_and_most_in_path(|| {
+        bat()
+            .arg(format!(
+                "--pager={}",
+                mocked_pagers::from("echo pager-output")
+            ))
+            .arg("--paging=always")
+            .arg("test.txt")
+            .assert()
+            .success()
+            .stdout(predicate::str::contains("pager-output\n").normalize());
+    });
+}
+
+#[test]
+#[serial]
 fn pager_overwrite() {
-    bat()
-        .env("PAGER", "echo other-pager")
-        .env("BAT_PAGER", "echo pager-output")
-        .arg("--paging=always")
-        .arg("test.txt")
-        .assert()
-        .success()
-        .stdout(predicate::eq("pager-output\n").normalize());
+    mocked_pagers::with_mocked_versions_of_more_and_most_in_path(|| {
+        bat()
+            .env("PAGER", mocked_pagers::from("echo other-pager"))
+            .env("BAT_PAGER", mocked_pagers::from("echo pager-output"))
+            .arg("--paging=always")
+            .arg("test.txt")
+            .assert()
+            .success()
+            .stdout(predicate::str::contains("pager-output\n").normalize());
+    });
 }
 
 #[test]
@@ -532,6 +656,76 @@ fn pager_disable() {
         .stdout(predicate::eq("hello world\n").normalize());
 }
 
+#[test]
+#[serial]
+fn pager_arg_override_env_withconfig() {
+    mocked_pagers::with_mocked_versions_of_more_and_most_in_path(|| {
+        bat_with_config()
+            .env("BAT_CONFIG_PATH", get_config())
+            .env("PAGER", mocked_pagers::from("echo another-pager"))
+            .env("BAT_PAGER", mocked_pagers::from("echo other-pager"))
+            .arg(format!(
+                "--pager={}",
+                mocked_pagers::from("echo pager-output")
+            ))
+            .arg("--paging=always")
+            .arg("test.txt")
+            .assert()
+            .success()
+            .stdout(predicate::str::contains("pager-output\n").normalize());
+    });
+}
+
+#[test]
+#[serial]
+fn pager_arg_override_env_noconfig() {
+    mocked_pagers::with_mocked_versions_of_more_and_most_in_path(|| {
+        bat()
+            .env("PAGER", mocked_pagers::from("echo another-pager"))
+            .env("BAT_PAGER", mocked_pagers::from("echo other-pager"))
+            .arg(format!(
+                "--pager={}",
+                mocked_pagers::from("echo pager-output")
+            ))
+            .arg("--paging=always")
+            .arg("test.txt")
+            .assert()
+            .success()
+            .stdout(predicate::str::contains("pager-output\n").normalize());
+    });
+}
+
+#[test]
+#[serial]
+fn pager_env_bat_pager_override_config() {
+    mocked_pagers::with_mocked_versions_of_more_and_most_in_path(|| {
+        bat_with_config()
+            .env("BAT_CONFIG_PATH", get_config())
+            .env("PAGER", mocked_pagers::from("echo other-pager"))
+            .env("BAT_PAGER", mocked_pagers::from("echo pager-output"))
+            .arg("--paging=always")
+            .arg("test.txt")
+            .assert()
+            .success()
+            .stdout(predicate::str::contains("pager-output\n").normalize());
+    });
+}
+
+#[test]
+#[serial]
+fn pager_env_pager_nooverride_config() {
+    mocked_pagers::with_mocked_versions_of_more_and_most_in_path(|| {
+        bat_with_config()
+            .env("BAT_CONFIG_PATH", get_config())
+            .env("PAGER", mocked_pagers::from("echo other-pager"))
+            .arg("--paging=always")
+            .arg("test.txt")
+            .assert()
+            .success()
+            .stdout(predicate::str::contains("dummy-pager-from-config\n").normalize());
+    });
+}
+
 #[test]
 fn env_var_pager_value_bat() {
     bat()
@@ -655,15 +849,18 @@ fn alias_pager_disable() {
 }
 
 #[test]
+#[serial]
 fn alias_pager_disable_long_overrides_short() {
-    bat()
-        .env("PAGER", "echo pager-output")
-        .arg("-P")
-        .arg("--paging=always")
-        .arg("test.txt")
-        .assert()
-        .success()
-        .stdout(predicate::eq("pager-output\n").normalize());
+    mocked_pagers::with_mocked_versions_of_more_and_most_in_path(|| {
+        bat()
+            .env("PAGER", mocked_pagers::from("echo pager-output"))
+            .arg("-P")
+            .arg("--paging=always")
+            .arg("test.txt")
+            .assert()
+            .success()
+            .stdout(predicate::str::contains("pager-output\n").normalize());
+    });
 }
 
 #[test]
@@ -678,6 +875,42 @@ fn disable_pager_if_disable_paging_flag_comes_after_paging() {
         .stdout(predicate::eq("hello world\n").normalize());
 }
 
+#[test]
+fn disable_pager_if_pp_flag_comes_after_paging() {
+    bat()
+        .env("PAGER", "echo pager-output")
+        .arg("--paging=always")
+        .arg("-pp")
+        .arg("test.txt")
+        .assert()
+        .success()
+        .stdout(predicate::eq("hello world\n").normalize());
+}
+
+#[test]
+fn enable_pager_if_disable_paging_flag_comes_before_paging() {
+    bat()
+        .env("PAGER", "echo pager-output")
+        .arg("-P")
+        .arg("--paging=always")
+        .arg("test.txt")
+        .assert()
+        .success()
+        .stdout(predicate::eq("pager-output\n").normalize());
+}
+
+#[test]
+fn enable_pager_if_pp_flag_comes_before_paging() {
+    bat()
+        .env("PAGER", "echo pager-output")
+        .arg("-pp")
+        .arg("--paging=always")
+        .arg("test.txt")
+        .assert()
+        .success()
+        .stdout(predicate::eq("pager-output\n").normalize());
+}
+
 #[test]
 fn pager_failed_to_parse() {
     bat()
@@ -689,6 +922,20 @@ fn pager_failed_to_parse() {
         .stderr(predicate::str::contains("Could not parse pager command"));
 }
 
+#[test]
+#[serial]
+fn env_var_bat_paging() {
+    mocked_pagers::with_mocked_versions_of_more_and_most_in_path(|| {
+        bat()
+            .env("BAT_PAGER", mocked_pagers::from("echo pager-output"))
+            .env("BAT_PAGING", "always")
+            .arg("test.txt")
+            .assert()
+            .success()
+            .stdout(predicate::str::contains("pager-output\n").normalize());
+    });
+}
+
 #[test]
 fn diagnostic_sanity_check() {
     bat()
@@ -747,13 +994,109 @@ fn config_location_from_bat_config_dir_variable() {
 }
 
 #[test]
+#[serial]
 fn config_read_arguments_from_file() {
+    mocked_pagers::with_mocked_versions_of_more_and_most_in_path(|| {
+        bat_with_config()
+            .env("BAT_CONFIG_PATH", get_config())
+            .arg("test.txt")
+            .assert()
+            .success()
+            .stdout(predicate::str::contains("dummy-pager-from-config\n").normalize());
+    });
+}
+
+#[cfg(unix)]
+#[test]
+fn cache_clear() {
+    let src_dir = "cache_source";
+    let tmp_dir = tempdir().expect("can create temporary directory");
+    let themes_filename = "themes.bin";
+    let syntaxes_filename = "syntaxes.bin";
+    let metadata_filename = "metadata.yaml";
+    [themes_filename, syntaxes_filename, metadata_filename]
+        .iter()
+        .map(|filename| {
+            let fp = tmp_dir.path().join(filename);
+            let mut file = File::create(fp).expect("can create temporary file");
+            writeln!(file, "dummy content").expect("can write to file");
+        })
+        .count();
+
+    // Clear the targeted cache
+    // Include the BAT_CONFIG_PATH and BAT_THEME environment variables to ensure that
+    // options loaded from a config or the environment are not inserted
+    // before the cache subcommand, which would break it.
     bat_with_config()
+        .current_dir(Path::new(EXAMPLES_DIR).join(src_dir))
         .env("BAT_CONFIG_PATH", "bat.conf")
-        .arg("test.txt")
+        .env("BAT_THEME", "1337")
+        .arg("cache")
+        .arg("--clear")
+        .arg("--source")
+        .arg(".")
+        .arg("--target")
+        .arg(tmp_dir.path().to_str().unwrap())
         .assert()
         .success()
-        .stdout(predicate::eq("dummy-pager-from-config\n").normalize());
+        .stdout(
+            predicate::str::is_match(
+                "Clearing theme set cache ... okay
+Clearing syntax set cache ... okay
+Clearing metadata file ... okay",
+            )
+            .unwrap(),
+        );
+
+    // We expect these files to be removed
+    assert!(!tmp_dir.path().join(themes_filename).exists());
+    assert!(!tmp_dir.path().join(syntaxes_filename).exists());
+    assert!(!tmp_dir.path().join(metadata_filename).exists());
+}
+
+#[cfg(unix)]
+#[test]
+fn cache_build() {
+    let src_dir = "cache_source";
+    let tmp_dir = tempdir().expect("can create temporary directory");
+    let tmp_themes_path = tmp_dir.path().join("themes.bin");
+    let tmp_syntaxes_path = tmp_dir.path().join("syntaxes.bin");
+    let tmp_acknowledgements_path = tmp_dir.path().join("acknowledgements.bin");
+    let tmp_metadata_path = tmp_dir.path().join("metadata.yaml");
+
+    // Build the cache
+    // Include the BAT_CONFIG_PATH and BAT_THEME environment variables to ensure that
+    // options loaded from a config or the environment are not inserted
+    // before the cache subcommand, which would break it.
+    bat_with_config()
+        .current_dir(Path::new(EXAMPLES_DIR).join(src_dir))
+        .env("BAT_CONFIG_PATH", "bat.conf")
+        .env("BAT_THEME", "1337")
+        .arg("cache")
+        .arg("--build")
+        .arg("--blank")
+        .arg("--source")
+        .arg(".")
+        .arg("--target")
+        .arg(tmp_dir.path().to_str().unwrap())
+        .arg("--acknowledgements")
+        .assert()
+        .success()
+        .stdout(
+            predicate::str::is_match(
+                "Writing theme set to .*/themes.bin ... okay
+Writing syntax set to .*/syntaxes.bin ... okay
+Writing acknowledgements to .*/acknowledgements.bin ... okay
+Writing metadata to folder .* ... okay",
+            )
+            .unwrap(),
+        );
+
+    // Now we expect the files to exist. If they exist, we assume contents are correct
+    assert!(tmp_themes_path.exists());
+    assert!(tmp_syntaxes_path.exists());
+    assert!(tmp_acknowledgements_path.exists());
+    assert!(tmp_metadata_path.exists());
 }
 
 #[test]
@@ -981,6 +1324,35 @@ fn header_full_basic() {
         .stderr("");
 }
 
+#[test]
+fn header_env_basic() {
+    bat_with_config()
+        .env("BAT_STYLE", "header-filename,header-filesize")
+        .arg("test.txt")
+        .arg("--decorations=always")
+        .arg("-r=0:0")
+        .arg("--file-name=foo")
+        .assert()
+        .success()
+        .stdout("File: foo\nSize: 12 B\n")
+        .stderr("");
+}
+
+#[test]
+fn header_arg_overrides_env() {
+    bat_with_config()
+        .env("BAT_STYLE", "header-filesize")
+        .arg("test.txt")
+        .arg("--decorations=always")
+        .arg("--style=header-filename")
+        .arg("-r=0:0")
+        .arg("--file-name=foo")
+        .assert()
+        .success()
+        .stdout("File: foo\n")
+        .stderr("");
+}
+
 #[test]
 fn header_binary() {
     bat()
@@ -1347,6 +1719,17 @@ fn show_all_extends_tab_markers_to_next_tabstop_width_8() {
         );
 }
 
+#[test]
+fn show_all_with_caret_notation() {
+    bat()
+        .arg("--show-all")
+        .arg("--nonprintable-notation=caret")
+        .arg("nonprintable.txt")
+        .assert()
+        .stdout("hello·world^J\n├──┤^M^@^G^H^[")
+        .stderr("");
+}
+
 #[test]
 fn no_paging_arg() {
     bat()
@@ -1442,6 +1825,26 @@ fn ansi_highlight_underline() {
         .stderr("");
 }
 
+// Ensure that ANSI passthrough is emitted properly for both wrapping and non-wrapping printer.
+// See https://github.com/sharkdp/bat/issues/2307 for what common use case this test tests.
+#[test]
+fn ansi_passthrough_emit() {
+    for wrapping in &["never", "character"] {
+        bat()
+            .arg("--paging=never")
+            .arg("--color=never")
+            .arg("--terminal-width=80")
+            .arg(format!("--wrap={}", wrapping))
+            .arg("--decorations=always")
+            .arg("--style=plain")
+            .write_stdin("\x1B[33mColor\nColor \x1B[m\nPlain\n")
+            .assert()
+            .success()
+            .stdout("\x1B[33m\x1B[33mColor\n\x1B[33mColor \x1B[m\nPlain\n")
+            .stderr("");
+    }
+}
+
 #[test]
 fn ignored_suffix_arg() {
     bat()
@@ -1479,6 +1882,105 @@ fn ignored_suffix_arg() {
         .stderr("");
 }
 
+fn wrapping_test(wrap_flag: &str, expect_wrap: bool) {
+    let expected = match expect_wrap {
+        true =>
+            "abcdefghigklmnopqrstuvxyzabcdefghigklmnopqrstuvxyzabcdefghigklmnopqrstuvxyzabcde\nfghigklmnopqrstuvxyz\n",
+        false =>
+            "abcdefghigklmnopqrstuvxyzabcdefghigklmnopqrstuvxyzabcdefghigklmnopqrstuvxyzabcdefghigklmnopqrstuvxyz\n",
+    };
+
+    bat()
+        .arg(wrap_flag)
+        .arg("--style=rule")
+        .arg("--color=never")
+        .arg("--decorations=always")
+        .arg("--terminal-width=80")
+        .arg("long-single-line.txt")
+        .assert()
+        .success()
+        .stdout(expected.to_owned())
+        .stderr("");
+}
+
+#[test]
+fn no_line_wrapping_when_set_to_never() {
+    wrapping_test("--wrap=never", false);
+}
+
+#[test]
+fn line_wrapping_when_auto() {
+    wrapping_test("--wrap=auto", true);
+}
+
+#[test]
+fn no_line_wrapping_with_s_flag() {
+    wrapping_test("-S", false);
+}
+
+#[test]
+fn no_wrapping_with_chop_long_lines() {
+    wrapping_test("--chop-long-lines", false);
+}
+
+#[test]
+fn theme_arg_overrides_env() {
+    bat()
+        .env("BAT_THEME", "TwoDark")
+        .arg("--paging=never")
+        .arg("--color=never")
+        .arg("--terminal-width=80")
+        .arg("--wrap=never")
+        .arg("--decorations=always")
+        .arg("--theme=ansi")
+        .arg("--style=plain")
+        .arg("--highlight-line=1")
+        .write_stdin("Ansi Underscore Test\nAnother Line")
+        .assert()
+        .success()
+        .stdout("\x1B[4mAnsi Underscore Test\n\x1B[24mAnother Line")
+        .stderr("");
+}
+
+#[test]
+fn theme_arg_overrides_env_withconfig() {
+    bat_with_config()
+        .env("BAT_CONFIG_PATH", "bat-theme.conf")
+        .env("BAT_THEME", "TwoDark")
+        .arg("--paging=never")
+        .arg("--color=never")
+        .arg("--terminal-width=80")
+        .arg("--wrap=never")
+        .arg("--decorations=always")
+        .arg("--theme=ansi")
+        .arg("--style=plain")
+        .arg("--highlight-line=1")
+        .write_stdin("Ansi Underscore Test\nAnother Line")
+        .assert()
+        .success()
+        .stdout("\x1B[4mAnsi Underscore Test\n\x1B[24mAnother Line")
+        .stderr("");
+}
+
+#[test]
+fn theme_env_overrides_config() {
+    bat_with_config()
+        .env("BAT_CONFIG_PATH", "bat-theme.conf")
+        .env("BAT_THEME", "ansi")
+        .arg("--paging=never")
+        .arg("--color=never")
+        .arg("--terminal-width=80")
+        .arg("--wrap=never")
+        .arg("--decorations=always")
+        .arg("--style=plain")
+        .arg("--highlight-line=1")
+        .write_stdin("Ansi Underscore Test\nAnother Line")
+        .assert()
+        .success()
+        .stdout("\x1B[4mAnsi Underscore Test\n\x1B[24mAnother Line")
+        .stderr("");
+}
+
 #[test]
 fn highlighting_is_skipped_on_long_lines() {
     let expected = "\u{1b}[38;5;231m{\u{1b}[0m\u{1b}[38;5;208m\"\u{1b}[0m\u{1b}[38;5;208mapi\u{1b}[0m\u{1b}[38;5;208m\"\u{1b}[0m\u{1b}[38;5;231m:\u{1b}[0m\n".to_owned() +
@@ -1608,3 +2110,304 @@ fn acknowledgements() {
         )
         .stderr("");
 }
+
+#[cfg(unix)] // Expected output assumed that tests are run on a Unix-like system
+#[cfg(feature = "lessopen")]
+#[test]
+fn lessopen_file_piped() {
+    bat()
+        .env("LESSOPEN", "|echo File is %s")
+        .arg("--lessopen")
+        .arg("test.txt")
+        .assert()
+        .success()
+        .stdout("File is test.txt\n");
+}
+
+#[cfg(unix)] // Expected output assumed that tests are run on a Unix-like system
+#[cfg(feature = "lessopen")]
+#[test]
+fn lessopen_stdin_piped() {
+    bat()
+        .env("LESSOPEN", "|cat")
+        .arg("--lessopen")
+        .write_stdin("hello world\n")
+        .assert()
+        .success()
+        .stdout("hello world\n");
+}
+
+#[cfg(unix)] // Expected output assumed that tests are run on a Unix-like system
+#[cfg(feature = "lessopen")]
+#[test]
+#[serial] // Randomly fails otherwise
+fn lessopen_and_lessclose_file_temp() {
+    // This is mainly to test that $LESSCLOSE gets passed the correct file paths
+    // In this case, the original file and the temporary file returned by $LESSOPEN
+    bat()
+        // Need a %s for $LESSOPEN to be valid
+        .env("LESSOPEN", "echo empty.txt && echo %s >/dev/null")
+        .env("LESSCLOSE", "echo lessclose: %s %s")
+        .arg("--lessopen")
+        .arg("test.txt")
+        .assert()
+        .success()
+        .stdout("lessclose: test.txt empty.txt\n");
+}
+
+#[cfg(unix)] // Expected output assumed that tests are run on a Unix-like system
+#[cfg(feature = "lessopen")]
+#[test]
+#[serial] // Randomly fails otherwise
+fn lessopen_and_lessclose_file_piped() {
+    // This is mainly to test that $LESSCLOSE gets passed the correct file paths
+    // In these cases, the original file and a dash
+    bat()
+        // This test will not work properly if $LESSOPEN does not output anything
+        .env("LESSOPEN", "|cat %s")
+        .env("LESSCLOSE", "echo lessclose: %s %s")
+        .arg("--lessopen")
+        .arg("test.txt")
+        .assert()
+        .success()
+        .stdout("hello world\nlessclose: test.txt -\n");
+
+    bat()
+        .env("LESSOPEN", "||cat %s")
+        .env("LESSCLOSE", "echo lessclose: %s %s")
+        .arg("--lessopen")
+        .arg("empty.txt")
+        .assert()
+        .success()
+        .stdout("lessclose: empty.txt -\n");
+}
+
+#[cfg(unix)] // Expected output assumed that tests are run on a Unix-like system
+#[cfg(feature = "lessopen")]
+#[test]
+#[serial] // Randomly fails otherwise
+#[ignore = "randomly failing on some systems"]
+fn lessopen_and_lessclose_stdin_temp() {
+    // This is mainly to test that $LESSCLOSE gets passed the correct file paths
+    // In this case, a dash and the temporary file returned by $LESSOPEN
+    bat()
+        // Need a %s for $LESSOPEN to be valid
+        .env("LESSOPEN", "-echo empty.txt && echo %s >/dev/null")
+        .env("LESSCLOSE", "echo lessclose: %s %s")
+        .arg("--lessopen")
+        .write_stdin("test.txt")
+        .assert()
+        .success()
+        .stdout("lessclose: - empty.txt\n");
+}
+
+#[cfg(unix)] // Expected output assumed that tests are run on a Unix-like system
+#[cfg(feature = "lessopen")]
+#[test]
+#[serial] // Randomly fails otherwise
+fn lessopen_and_lessclose_stdin_piped() {
+    // This is mainly to test that $LESSCLOSE gets passed the correct file paths
+    // In these cases, two dashes
+    bat()
+        // This test will not work properly if $LESSOPEN does not output anything
+        // Need a %s for $LESSOPEN to be valid
+        .env("LESSOPEN", "|-cat test.txt && echo %s >/dev/null")
+        .env("LESSCLOSE", "echo lessclose: %s %s")
+        .arg("--lessopen")
+        .write_stdin("empty.txt")
+        .assert()
+        .success()
+        .stdout("hello world\nlessclose: - -\n");
+
+    bat()
+        // Need a %s for $LESSOPEN to be valid
+        .env("LESSOPEN", "||-cat empty.txt && echo %s >/dev/null")
+        .env("LESSCLOSE", "echo lessclose: %s %s")
+        .arg("--lessopen")
+        .write_stdin("empty.txt")
+        .assert()
+        .success()
+        .stdout("lessclose: - -\n");
+}
+
+#[cfg(unix)] // Expected output assumed that tests are run on a Unix-like system
+#[cfg(feature = "lessopen")]
+#[test]
+fn lessopen_handling_empty_output_file() {
+    bat()
+        // Need a %s for $LESSOPEN to be valid
+        .env("LESSOPEN", "|cat empty.txt && echo %s >/dev/null")
+        .arg("--lessopen")
+        .arg("test.txt")
+        .assert()
+        .success()
+        .stdout("hello world\n");
+
+    bat()
+        // Need a %s for $LESSOPEN to be valid
+        .env("LESSOPEN", "|cat nonexistent.txt && echo %s >/dev/null")
+        .arg("--lessopen")
+        .arg("test.txt")
+        .assert()
+        .success()
+        .stdout("hello world\n");
+
+    bat()
+        // Need a %s for $LESSOPEN to be valid
+        .env("LESSOPEN", "||cat empty.txt && echo %s >/dev/null")
+        .arg("--lessopen")
+        .arg("test.txt")
+        .assert()
+        .success()
+        .stdout("");
+
+    bat()
+        // Need a %s for $LESSOPEN to be valid
+        .env("LESSOPEN", "||cat nonexistent.txt && echo %s >/dev/null")
+        .arg("--lessopen")
+        .arg("test.txt")
+        .assert()
+        .success()
+        .stdout("hello world\n");
+}
+
+#[cfg(unix)] // Expected output assumed that tests are run on a Unix-like system
+#[cfg(feature = "lessopen")]
+#[test]
+// FIXME
+fn lessopen_handling_empty_output_stdin() {
+    bat()
+        // Need a %s for $LESSOPEN to be valid
+        .env("LESSOPEN", "|-cat empty.txt && echo %s >/dev/null")
+        .arg("--lessopen")
+        .write_stdin("hello world\n")
+        .assert()
+        .success()
+        .stdout("hello world\n");
+
+    bat()
+        // Need a %s for $LESSOPEN to be valid
+        .env("LESSOPEN", "|-cat nonexistent.txt && echo %s >/dev/null")
+        .arg("--lessopen")
+        .write_stdin("hello world\n")
+        .assert()
+        .success()
+        .stdout("hello world\n");
+
+    bat()
+        // Need a %s for $LESSOPEN to be valid
+        .env("LESSOPEN", "||-cat empty.txt && echo %s >/dev/null")
+        .arg("--lessopen")
+        .write_stdin("hello world\n")
+        .assert()
+        .success()
+        .stdout("");
+
+    bat()
+        // Need a %s for $LESSOPEN to be valid
+        .env("LESSOPEN", "||-cat nonexistent.txt && echo %s >/dev/null")
+        .arg("--lessopen")
+        .write_stdin("hello world\n")
+        .assert()
+        .success()
+        .stdout("hello world\n");
+}
+
+#[cfg(unix)] // Expected output assumed that tests are run on a Unix-like system
+#[cfg(feature = "lessopen")]
+#[test]
+fn lessopen_uses_shell() {
+    bat()
+        .env("LESSOPEN", "|cat < %s")
+        .arg("--lessopen")
+        .arg("test.txt")
+        .assert()
+        .success()
+        .stdout("hello world\n");
+}
+
+#[cfg(unix)]
+#[cfg(feature = "lessopen")]
+#[test]
+fn do_not_use_lessopen_by_default() {
+    bat()
+        .env("LESSOPEN", "|echo File is %s")
+        .arg("test.txt")
+        .assert()
+        .success()
+        .stdout("hello world\n");
+}
+
+#[cfg(unix)]
+#[cfg(feature = "lessopen")]
+#[test]
+fn do_not_use_lessopen_if_overridden() {
+    bat()
+        .env("LESSOPEN", "|echo File is %s")
+        .arg("--lessopen")
+        .arg("--no-lessopen")
+        .arg("test.txt")
+        .assert()
+        .success()
+        .stdout("hello world\n");
+}
+
+#[cfg(unix)]
+#[cfg(feature = "lessopen")]
+#[test]
+fn lessopen_validity() {
+    bat()
+        .env("LESSOPEN", "|echo File is test.txt")
+        .arg("--lessopen")
+        .arg("test.txt")
+        .assert()
+        .success()
+        .stdout("hello world\n")
+        .stderr(
+            "\u{1b}[33m[bat warning]\u{1b}[0m: LESSOPEN ignored: must contain exactly one %s\n",
+        );
+
+    bat()
+        .env("LESSOPEN", "|echo File is %s")
+        .arg("--lessopen")
+        .arg("test.txt")
+        .assert()
+        .success()
+        .stdout("File is test.txt\n")
+        .stderr("");
+
+    bat()
+        .env("LESSOPEN", "|echo %s is %s")
+        .arg("--lessopen")
+        .arg("test.txt")
+        .assert()
+        .success()
+        .stdout("hello world\n")
+        .stderr(
+            "\u{1b}[33m[bat warning]\u{1b}[0m: LESSOPEN ignored: must contain exactly one %s\n",
+        );
+}
+
+// Regression test for issue #2520 and PR #2650
+// Syntax highlighting should be the same regardless of
+// --map-syntax' case or file extension's case
+#[test]
+fn highlighting_independant_from_map_syntax_case() {
+    let expected = bat()
+        .arg("-f")
+        .arg("--map-syntax=*.config:JSON")
+        .arg("map-syntax_case.Config")
+        .assert()
+        .get_output()
+        .stdout
+        .clone();
+
+    bat()
+        .arg("-f")
+        .arg("--map-syntax=*.Config:JSON")
+        .arg("map-syntax_case.Config")
+        .assert()
+        .success()
+        .stdout(expected)
+        .stderr("");
+}

tests/mocked-pagers/echo.bat

@@ -0,0 +1 @@
+ECHO %*

tests/syntax-tests/create_highlighted_versions.py

@@ -8,11 +8,13 @@ import os
 import argparse
 from multiprocessing import Pool
 
+# Avoid 'default' theme because it can choose a different theme based on
+# the appearance settings on macOS.
 BAT_OPTIONS = [
     "--no-config",
     "--style=plain",
     "--color=always",
-    "--theme=default",
+    "--theme=Monokai Extended",
     "--italic-text=always",
 ]
 

tests/syntax-tests/highlighted/Ada/click.adb

@@ -0,0 +1,308 @@
+with Chests.Ring_Buffers;
+with USB.Device.HID.Keyboard;
+
+package body Click is
+   ----------------
+   --  DEBOUNCE  --
+   ----------------
+
+   --  Ideally, in a separate package.
+
+   --  should be [], but not fixed yet in GCC 11.
+   Current_Status : Key_Matrix := [others => [others => False]];
+   New_Status : Key_Matrix := [others => [others => False]];
+   Since : Natural := 0;
+   --   Nb_Bounce : Natural := 5;
+
+   function Update (NewS : Key_Matrix) return Boolean is
+   begin
+      --  The new state is the same as the current stable state => Do nothing.
+      if Current_Status = NewS then
+         Since := 0;
+         return False;
+      end if;
+
+      if New_Status /= NewS then
+         --  The new state differs from the previous
+         --  new state (bouncing) => reset
+         New_Status := NewS;
+         Since := 1;
+      else
+         --  The new state hasn't changed since last
+         --  update => towards stabilization.
+         Since := Since + 1;
+      end if;
+
+      if Since > Nb_Bounce then
+         declare
+            Tmp : constant Key_Matrix := Current_Status;
+         begin
+            --  New state has been stable enough.
+            --  Latch it and notifies caller.
+            Current_Status := New_Status;
+            New_Status := Tmp;
+            Since := 0;
+         end;
+
+         return True;
+      else
+         --  Not there yet
+         return False;
+      end if;
+   end Update;
+
+   procedure Get_Matrix;
+   --  Could use := []; but GNAT 12 has a bug (fixed in upcoming 13)
+   Read_Status : Key_Matrix := [others => [others => False]];
+
+   function Get_Events return Events is
+      Num_Evt : Natural := 0;
+      New_S : Key_Matrix renames Read_Status;
+   begin
+      Get_Matrix;
+      if Update (New_S) then
+         for I in Current_Status'Range (1) loop
+            for J in Current_Status'Range (2) loop
+               if (not New_Status (I, J) and then Current_Status (I, J))
+                 or else (New_Status (I, J) and then not Current_Status (I, J))
+               then
+                  Num_Evt := Num_Evt + 1;
+               end if;
+            end loop;
+         end loop;
+
+         declare
+            Evts : Events (Natural range 1 .. Num_Evt);
+            Cursor : Natural range 1 .. Num_Evt + 1 := 1;
+         begin
+            for I in Current_Status'Range (1) loop
+               for J in Current_Status'Range (2) loop
+                  if not New_Status (I, J)
+                    and then Current_Status (I, J)
+                  then
+                     --  Pressing I, J
+                     Evts (Cursor) := [
+                                       Evt => Press,
+                                       Col => I,
+                                       Row => J
+                                      ];
+                     Cursor := Cursor + 1;
+                  elsif New_Status (I, J)
+                    and then not Current_Status (I, J)
+                  then
+                     --  Release I, J
+                     Evts (Cursor) := [
+                                       Evt => Release,
+                                       Col => I,
+                                       Row => J
+                                      ];
+                     Cursor := Cursor + 1;
+                  end if;
+               end loop;
+            end loop;
+            return Evts;
+         end;
+      end if;
+
+      return [];
+   end Get_Events;
+
+   procedure Get_Matrix  is -- return Key_Matrix is
+   begin
+      for Row in Keys.Rows'Range loop
+         Keys.Rows (Row).Clear;
+
+         for Col in Keys.Cols'Range loop
+            Read_Status (Col, Row) := not Keys.Cols (Col).Set;
+         end loop;
+         Keys.Rows (Row).Set;
+      end loop;
+   end Get_Matrix;
+
+   --  End of DEBOUNCE
+
+   --------------
+   --  Layout  --
+   --------------
+
+   package Events_Ring_Buffers is new Chests.Ring_Buffers
+     (Element_Type => Event,
+      Capacity     => 16);
+
+   Queued_Events : Events_Ring_Buffers.Ring_Buffer;
+
+   type Statet is (Normal_Key, Layer_Mod, None);
+   type State is record
+      Typ : Statet;
+      Code : Key_Code_T;
+      Layer_Value : Natural;
+      --  Col : ColR;
+      --  Row : RowR;
+   end record;
+
+   type State_Array is array (ColR, RowR) of State;
+   States : State_Array := [others => [others => (Typ => None, Code => No, Layer_Value => 0)]];
+
+   function Kw (Code : Key_Code_T) return Action is
+   begin
+      return (T => Key, C => Code, L => 0);
+   end Kw;
+
+   function Lw (V : Natural) return Action is
+   begin
+      return (T => Layer, C => No, L => V);
+   end Lw;
+
+   --  FIXME: hardcoded max number of events
+   subtype Events_Range is Natural range 0 .. 60;
+   type Array_Of_Reg_Events is array (Events_Range) of Event;
+
+   Stamp : Natural := 0;
+
+   procedure Register_Events (L : Layout; Es : Events) is
+   begin
+      Stamp := Stamp + 1;
+
+      Log ("Reg events: " & Stamp'Image);
+      Log (Es'Length'Image);
+      for E of Es loop
+         declare
+         begin
+            if Events_Ring_Buffers.Is_Full (Queued_Events) then
+               raise Program_Error;
+            end if;
+
+            Events_Ring_Buffers.Append (Queued_Events, E);
+         end;
+         --         Log ("Reg'ed events:" &  Events_Mark'Image);
+         Log ("Reg'ed events:" &  Events_Ring_Buffers.Length (Queued_Events)'Image);
+      end loop;
+   end Register_Events;
+
+   procedure Release (Col: Colr; Row: Rowr) is
+   begin
+      if States (Col, Row).Typ = None then
+         raise Program_Error;
+      end if;
+      States (Col, Row) := (Typ => None, Code => No, Layer_Value => 0);
+   end Release;
+
+   function Get_Current_Layer return Natural is
+      L : Natural := 0;
+   begin
+      for S of States loop
+         if S.Typ = Layer_Mod then
+            L := L + S.Layer_Value;
+         end if;
+      end loop;
+
+      return L;
+   end Get_Current_Layer;
+
+   --  Tick the event.
+   --  Returns TRUE if it needs to stay in the queued events
+   --  FALSE if the event has been consumed.
+
+   function Tick (L: Layout; E : in out Event) return Boolean is
+      Current_Layer : Natural := Get_Current_Layer;
+      A : Action renames L (Current_Layer, E.Row, E.Col);
+   begin
+      case E.Evt is
+         when Press =>
+            case A.T is
+               when Key =>
+                  States (E.Col, E.Row) :=
+                    (Typ => Normal_Key,
+                     Code => A.C,
+                     Layer_Value => 0);
+               when Layer =>
+                  States (E.Col, E.Row) := (Typ => Layer_Mod, Layer_Value => A.L, Code => No);
+               when others =>
+                  raise Program_Error;
+            end case;
+
+         when Release =>
+            Release (E.Col, E.Row);
+      end case;
+      return False;
+   end Tick;
+
+   Last_Was_Empty_Log : Boolean := False;
+
+   procedure Tick (L : Layout) is
+   begin
+      for I in 1 .. Events_Ring_Buffers.Length(Queued_Events) loop
+         declare
+            E : Event := Events_Ring_Buffers.Last_Element (Queued_Events);
+         begin
+            Events_Ring_Buffers.Delete_Last (Queued_Events);
+            if Tick (L, E) then
+               Events_Ring_Buffers.Prepend (Queued_Events, E);
+            end if;
+         end;
+      end loop;
+      if not Last_Was_Empty_Log or else Events_Ring_Buffers.Length(Queued_Events) /= 0 then
+         Log ("End Tick layout, events: " & Events_Ring_Buffers.Length(Queued_Events)'Image);
+         Last_Was_Empty_Log := Events_Ring_Buffers.Length(Queued_Events) = 0;
+      end if;
+   end Tick;
+
+   function Get_Key_Codes return Key_Codes_T is
+      Codes : Key_Codes_T (0 .. 10);
+      Wm: Natural := 0;
+   begin
+      for S of States loop
+         if S.Typ = Normal_Key and then
+            (S.Code < LCtrl or else S.Code > RGui)
+         then
+            Codes (Wm) := S.Code;
+            Wm := Wm + 1;
+         end if;
+      end loop;
+
+      if Wm = 0 then
+         return [];
+      else
+         return Codes (0 .. Wm - 1);
+      end if;
+   end Get_Key_Codes;
+
+   function Get_Modifiers return Key_Modifiers is
+      use USB.Device.HID.Keyboard;
+      KM : Key_Modifiers (1..8);
+      I : Natural := 0;
+   begin
+      for S of States loop
+         if S.Typ = Normal_Key then
+            I := I + 1;
+            case S.Code is
+              when LCtrl =>
+                 KM(I) := Ctrl_Left;
+              when RCtrl =>
+                 KM(I) := Ctrl_Right;
+              when LShift =>
+                 KM(I) := Shift_Left;
+              when RShift =>
+                 KM(I) := Shift_Right;
+              when LAlt =>
+                 KM(I) := Alt_Left;
+              when RAlt =>
+                 KM(I) := Alt_Right;
+              when LGui =>
+                 KM(I) := Meta_Left;
+              when RGui =>
+                 KM(I) := Meta_Right;
+              when others =>
+                 I := I - 1;
+            end case;
+         end if;
+      end loop;
+      return KM (1..I);
+   end Get_Modifiers;
+
+   procedure Init is
+   begin
+      Events_Ring_Buffers.Clear (Queued_Events);
+   end Init;
+
+end Click;

tests/syntax-tests/highlighted/Ada/click.ads

@@ -0,0 +1,339 @@
+with HAL.GPIO;
+with USB.Device.HID.Keyboard;
+
+generic
+   Nb_Bounce : Natural;
+   type ColR is (<>);
+   type RowR is (<>);
+
+   type GPIOP is new HAL.GPIO.GPIO_Point with private;
+
+   type Cols_T is array (ColR) of GPIOP;
+   type Rows_T is array (RowR) of GPIOP;
+
+   Cols : Cols_T;
+   Rows : Rows_T;
+   Num_Layers : Natural;
+
+   with procedure Log (S : String; L :  Integer := 1; Deindent : Integer := 0);
+package Click is
+
+   type Keys_T is record
+      Cols : Cols_T;
+      Rows : Rows_T;
+   end record;
+
+   Keys : Keys_T :=
+     (Rows => Rows, Cols => Cols);
+
+   type Key_Matrix is array (ColR, RowR) of Boolean;
+
+   --------------------------
+   --  Events & Debouncing --
+   --------------------------
+
+   MaxEvents : constant Positive := 20;
+
+   type EventT is (Press, Release);
+   type Event is record
+      Evt : EventT;
+      Col : ColR;
+      Row : RowR;
+   end record;
+
+   type Events is array (Natural range <>) of Event;
+
+   function Get_Events return Events;
+   function Update (NewS : Key_Matrix) return Boolean;
+
+   -------------
+   --  Layout --
+   -------------
+   ---------------
+   --  Keycodes --
+   ---------------
+
+   --  Keycodes copy/pasted from the excelent Keyberon Rust firmware:
+   --  https://github.com/TeXitoi/keyberon/
+
+   type Key_Code_T is
+     (
+      --   The "no" key, a placeholder to express nothing.
+      No, --  = 0x00,
+          --  / Error if too much keys are pressed at
+          --  the same time.
+      ErrorRollOver,
+      --  / The POST fail error.
+      PostFail,
+      --  / An undefined error occured.
+      ErrorUndefined,
+      --  / `a` and `A`.
+      A,
+      B,
+      C,
+      D,
+      E,
+      F,
+      G,
+      H,
+      I,
+      J,
+      K,
+      L,
+      M, --  0x10
+      N,
+      O,
+      P,
+      Q,
+      R,
+      S,
+      T,
+      U,
+      V,
+      W,
+      X,
+      Y,
+      Z,
+      --   `1` and `!`.
+      Kb1,
+      --   `2` and `@`.
+      Kb2,
+      --   `3` and `#`.
+      Kb3, --  0x20
+      --  / `4` and `$`.
+      Kb4,
+      --   `5` and `%`.
+      Kb5,
+      --   `6` and `^`.
+      Kb6,
+      --   `7` and `&`.
+      Kb7,
+      --   `8` and `*`.
+      Kb8,
+      --   `9` and `(`.
+      Kb9,
+      --   `0` and `)`.
+      Kb0,
+      Enter,
+      Escape,
+      BSpace,
+      Tab,
+      Space,
+      --   `-` and `_`.
+      Minus,
+      --   `=` and `+`.
+      Equal,
+      --   `[` and `{`.
+      LBracket,
+      --   `]` and `}`.
+      RBracket, --  0x30
+      --  / `\` and `|`.
+      Bslash,
+      --   Non-US `#` and `~` (Typically near the Enter key).
+      NonUsHash,
+      --   `;` and `:`.
+      SColon,
+      --   `'` and `"`.
+      Quote,
+      --  How to have ` as code?
+      --   \` and `~`.
+      Grave,
+      --   `,` and `<`.
+      Comma,
+      --   `.` and `>`.
+      Dot,
+      --   `/` and `?`.
+      Slash,
+      CapsLock,
+      F1,
+      F2,
+      F3,
+      F4,
+      F5,
+      F6,
+      F7, --  0x40
+      F8,
+      F9,
+      F10,
+      F11,
+      F12,
+      PScreen,
+      ScrollLock,
+      Pause,
+      Insert,
+      Home,
+      PgUp,
+      Delete,
+      Endd,
+      PgDown,
+      Right,
+      Left, --  0x50
+      Down,
+      Up,
+      NumLock,
+      --   Keypad `/`
+      KpSlash,
+      --   Keypad `*`
+      KpAsterisk,
+      --   Keypad `-`.
+      KpMinus,
+      --   Keypad `+`.
+      KpPlus,
+      --   Keypad enter.
+      KpEnter,
+      --   Keypad 1.
+      Kp1,
+      Kp2,
+      Kp3,
+      Kp4,
+      Kp5,
+      Kp6,
+      Kp7,
+      Kp8, --  0x60
+      Kp9,
+      Kp0,
+      KpDot,
+      --   Non-US `\` and `|` (Typically near the Left-Shift key)
+      NonUsBslash,
+      Application, --  0x65
+      --  / not a key, used for errors
+      Power,
+      --   Keypad `=`.
+      KpEqual,
+      F13,
+      F14,
+      F15,
+      F16,
+      F17,
+      F18,
+      F19,
+      F20,
+      F21, --  0x70
+      F22,
+      F23,
+      F24,
+      Execute,
+      Help,
+      Menu,
+      Selectt,
+      Stop,
+      Again,
+      Undo,
+      Cut,
+      Copy,
+      Paste,
+      Find,
+      Mute,
+      VolUp, --  0x80
+      VolDown,
+      --   Deprecated.
+      LockingCapsLock,
+      --   Deprecated.
+      LockingNumLock,
+      --   Deprecated.
+      LockingScrollLock,
+      --  / Keypad `,`, also used for the
+      --  brazilian keypad period (.) key.
+      KpComma,
+      --   Used on AS/400 keyboard
+      KpEqualSign,
+      Intl1,
+      Intl2,
+      Intl3,
+      Intl4,
+      Intl5,
+      Intl6,
+      Intl7,
+      Intl8,
+      Intl9,
+      Lang1, --  0x90
+      Lang2,
+      Lang3,
+      Lang4,
+      Lang5,
+      Lang6,
+      Lang7,
+      Lang8,
+      Lang9,
+      AltErase,
+      SysReq,
+      Cancel,
+      Clear,
+      Prior,
+      Returnn,
+      Separator,
+      Outt, --  0xA0
+      Oper,
+      ClearAgain,
+      CrSel,
+      ExSel,
+
+      --  According to QMK, 0xA5-0xDF are not
+      --  usable on modern keyboards
+
+      --  Modifiers
+      --   Left Control.
+      LCtrl, --  = 0xE0,
+      --  / Left Shift.
+      LShift,
+      --   Left Alt.
+      LAlt,
+      --   Left GUI (the Windows key).
+      LGui,
+      --   Right Control.
+      RCtrl,
+      --   Right Shift.
+      RShift,
+      --   Right Alt (or Alt Gr). 
+      RAlt,
+      --   Right GUI (the Windows key).
+      RGui, --  0xE7
+
+      --  Unofficial
+      MediaPlayPause, --   0xE8,
+      MediaStopCD,
+      MediaPreviousSong,
+      MediaNextSong,
+      MediaEjectCD,
+      MediaVolUp,
+      MediaVolDown,
+      MediaMute,
+      MediaWWW, --  0xF0
+      MediaBack,
+      MediaForward,
+      MediaStop,
+      MediaFind,
+      MediaScrollUp,
+      MediaScrollDown,
+      MediaEdit,
+      MediaSleep,
+      MediaCoffee,
+      MediaRefresh,
+      MediaCalc --  0xFB
+     );
+
+   type Action_Type is (Key, No_Op, Trans, Layer, Multiple_Actions);
+
+   --   Should be a discriminated type
+   type Action is record
+      T : Action_Type; --  hould be the discriminant
+      C : Key_Code_T;
+      L : Natural;
+   end record;
+
+   function Kw (Code : Key_Code_T) return Action;
+   function Lw (V : Natural) return Action;
+
+   type Key_Modifiers is array (Natural range <>) of USB.Device.HID.Keyboard.Modifiers;
+
+   type Key_Codes_T is array (Natural range <>) of Key_Code_T;
+
+   subtype Ac is Action;
+   type Layout is array (0 .. Num_Layers - 1, RowR, ColR) of Action;
+   procedure Register_Events (L : Layout; Es : Events);
+   procedure Tick (L : Layout);
+
+   function Get_Key_Codes return Key_Codes_T;
+   function Get_Modifiers return Key_Modifiers;
+   procedure Init;
+end Click;

tests/syntax-tests/highlighted/Ada/click.gpr

@@ -0,0 +1,29 @@
+with "config/click_config.gpr";
+project Click is
+
+   for Library_Name use "Click";
+   for Library_Version use Project'Library_Name & ".so." & Click_Config.Crate_Version;
+
+   for Source_Dirs use ("src/", "config/");
+   for Object_Dir use "obj/" & Click_Config.Build_Profile;
+   for Create_Missing_Dirs use "True";
+   for Library_Dir use "lib";
+
+   type Library_Type_Type is ("relocatable", "static", "static-pic");
+   Library_Type : Library_Type_Type :=
+     external ("CLICK_LIBRARY_TYPE", external ("LIBRARY_TYPE", "static"));
+   for Library_Kind use Library_Type;
+
+   package Compiler is
+      for Default_Switches ("Ada") use Click_Config.Ada_Compiler_Switches & ("-gnatX", "-gnat2022");
+   end Compiler;
+
+   package Binder is
+      for Switches ("Ada") use ("-Es"); --  Symbolic traceback
+   end Binder;
+
+   package Install is
+      for Artifacts (".") use ("share");
+   end Install;
+
+end Click;

tests/syntax-tests/highlighted/Crontab/crontab.tab

@@ -0,0 +1,8 @@
+0 2 * * * /bin/sh backup.sh
+*/10 * * * * /home/maverick/check-disk-space
+0 5,17 * * * /scripts/script.sh
+0 2 * * sun  [ $(date +%d) -le 07 ] && /script/script.sh
+@daily /scripts/script.sh
+@reboot /scripts/script.sh
+
+MAIL=bob

tests/syntax-tests/highlighted/Manpage/bat-0.16.man

@@ -40,7 +40,7 @@
               ables    automatic    paging    (alias    for     '--style=plain
               --pager=never').
 
-       -l, --language <language>
+       -l, --language <language>
 
               Explicitly  set  the  language for syntax highlighting. The lan‐
               guage can be specified as a name (like 'C++' or 'LaTeX') or pos‐
@@ -65,18 +65,18 @@
               --highlight-line 40:
                      highlights lines 40 to the end of the file
 
-       --tabs <T>
+       --tabs <T>
 
               Set the tab width to T spaces. Use a width of  0  to  pass  tabs
               through directly
 
-       --wrap <mode>
+       --wrap <mode>
 
               Specify  the  text-wrapping mode (*auto*, never, character). The
               '--terminal-width' option can be used in addition to control the
               output width.
 
-       --terminal-width <width>
+       --terminal-width <width>
 
               Explicitly  set the width of the terminal instead of determining
               it automatically. If prefixed with '+' or '-', the value will be
@@ -88,18 +88,18 @@
               Only show line numbers, no other decorations. This is  an  alias
               for '--style=numbers'
 
-       --color <when>
+       --color <when>
 
               Specify  when to use colored output. The automatic mode only en‐
               ables colors if an interactive terminal  is  detected.  Possible
               values: *auto*, never, always.
 
-       --italic-text <when>
+       --italic-text <when>
 
               Specify  when  to use ANSI sequences for italic text in the out‐
               put. Possible values: always, *never*.
 
-       --decorations <when>
+       --decorations <when>
 
               Specify when to use the decorations that have been specified via
               '--style'. The automatic mode only enables decorations if an in‐
@@ -112,7 +112,7 @@
               if the output of bat is piped to another program, but  you  want
               to keep the colorization/decorations.
 
-       --paging <when>
+       --paging <when>
 
               Specify when to use the pager. To disable the pager, use '--pag‐
               ing=never' or its alias, -P. To disable the  pager  permanently,
@@ -120,7 +120,7 @@
               used, see the '--pager' option. Possible values: *auto*,  never,
               always.
 
-       --pager <command>
+       --pager <command>
 
               Determine  which  pager  is  used. This option will override the
               PAGER and BAT_PAGER environment variables. The default pager  is
@@ -135,7 +135,7 @@
               '*.build:Python'.  To highlight files named '.myignore' with the
               Git Ignore syntax, use -m '.myignore:Git Ignore'.
 
-       --theme <theme>
+       --theme <theme>
 
               Set the theme for syntax highlighting.  Use  '--list-themes'  to
               see  all  available  themes.   To  set  a default theme, add the
@@ -146,7 +146,7 @@
 
               Display a list of supported themes for syntax highlighting.
 
-       --style <style-components>
+       --style <style-components>
 
               Configure  which elements (line numbers, file headers, grid bor‐
               ders, Git modifications, ..) to display in addition to the  file

tests/syntax-tests/highlighted/Manpage/fzf-0.33.0.man

@@ -0,0 +1,773 @@
+fzf(1)                                                                         fzf - a command-line fuzzy finder                                                                         fzf(1)
+
+NAME
+       fzf - a command-line fuzzy finder
+
+SYNOPSIS
+       fzf [options]
+
+DESCRIPTION
+       fzf is a general-purpose command-line fuzzy finder.
+
+OPTIONS
+   Search mode
+       -x, --extended
+              Extended-search mode. Since 0.10.9, this is enabled by default. You can disable it with +x or --no-extended.
+
+       -e, --exact
+              Enable exact-match
+
+       -i     Case-insensitive match (default: smart-case match)
+
+       +i     Case-sensitive match
+
+       --literal
+              Do not normalize latin script letters for matching.
+
+       --scheme=SCHEME
+              Choose scoring scheme tailored for different types of input.
+
+              default  Generic scoring scheme designed to work well with any type of input
+              path     Scoring scheme for paths (additional bonus point only after path separator)
+              history  Scoring scheme for command history (no additional bonus points).
+                       Sets --tiebreak=index as well.
+
+       --algo=TYPE
+              Fuzzy matching algorithm (default: v2)
+
+              v2     Optimal scoring algorithm (quality)
+              v1     Faster but not guaranteed to find the optimal result (performance)
+
+       -n, --nth=N[,..]
+              Comma-separated list of field index expressions for limiting search scope.  See FIELD INDEX EXPRESSION for the details.
+
+       --with-nth=N[,..]
+              Transform the presentation of each line using field index expressions
+
+       -d, --delimiter=STR
+              Field delimiter regex for --nth and --with-nth (default: AWK-style)
+
+       --disabled
+              Do  not  perform  search.  With this option, fzf becomes a simple selector interface rather than a "fuzzy finder". You can later enable the search using enable-search or toggle-
+              search action.
+
+   Search result
+       +s, --no-sort
+              Do not sort the result
+
+       --tac  Reverse the order of the input
+
+              e.g.
+                   history | fzf --tac --no-sort
+
+       --tiebreak=CRI[,..]
+              Comma-separated list of sort criteria to apply when the scores are tied.
+
+              length  Prefers line with shorter length
+              chunk   Prefers line with shorter matched chunk (delimited by whitespaces)
+              begin   Prefers line with matched substring closer to the beginning
+              end     Prefers line with matched substring closer to the end
+              index   Prefers line that appeared earlier in the input stream
+
+              - Each criterion should appear only once in the list
+              - index is only allowed at the end of the list
+              - index is implicitly appended to the list when not specified
+              - Default is length (or equivalently length,index)
+              - If end is found in the list, fzf will scan each line backwards
+
+   Interface
+       -m, --multi
+              Enable multi-select with tab/shift-tab. It optionally takes an integer argument which denotes the maximum number of items that can be selected.
+
+       +m, --no-multi
+              Disable multi-select
+
+       --no-mouse
+              Disable mouse
+
+       --bind=KEYBINDS
+              Comma-separated list of custom key bindings. See KEY/EVENT BINDINGS for the details.
+
+       --cycle
+              Enable cyclic scroll
+
+       --keep-right
+              Keep the right end of the line visible when it's too long. Effective only when the query string is empty.
+
+       --scroll-off=LINES
+              Number of screen lines to keep above or below when scrolling to the top or to the bottom (default: 0).
+
+       --no-hscroll
+              Disable horizontal scroll
+
+       --hscroll-off=COLS
+              Number of screen columns to keep to the right of the highlighted substring (default: 10). Setting it to a large value will cause the text to be positioned on the center  of  the
+              screen.
+
+       --filepath-word
+              Make word-wise movements and actions respect path separators. The following actions are affected:
+
+              backward-kill-word
+              backward-word
+              forward-word
+              kill-word
+
+       --jump-labels=CHARS
+              Label characters for jump and jump-accept
+
+   Layout
+       --height=HEIGHT[%]
+              Display fzf window below the cursor with the given height instead of using the full screen.
+
+       --min-height=HEIGHT
+              Minimum height when --height is given in percent (default: 10).  Ignored when --height is not specified.
+
+       --layout=LAYOUT
+              Choose the layout (default: default)
+
+              default       Display from the bottom of the screen
+              reverse       Display from the top of the screen
+              reverse-list  Display from the top of the screen, prompt at the bottom
+
+       --reverse
+              A synonym for --layout=reverse
+
+       --border[=BORDER_OPT]
+              Draw border around the finder
+
+              rounded       Border with rounded corners (default)
+              sharp         Border with sharp corners
+              horizontal    Horizontal lines above and below the finder
+              vertical      Vertical lines on each side of the finder
+              top (up)
+              bottom (down)
+              left
+              right
+              none
+
+       --no-unicode
+              Use ASCII characters instead of Unicode box drawing characters to draw border
+
+       --margin=MARGIN
+              Comma-separated expression for margins around the finder.
+
+              TRBL     Same margin for top, right, bottom, and left
+              TB,RL    Vertical, horizontal margin
+              T,RL,B   Top, horizontal, bottom margin
+              T,R,B,L  Top, right, bottom, left margin
+
+              Each part can be given in absolute number or in percentage relative to the terminal size with % suffix.
+
+              e.g.
+                   fzf --margin 10%
+                   fzf --margin 1,5%
+
+       --padding=PADDING
+              Comma-separated expression for padding inside the border. Padding is distinguishable from margin only when --border option is used.
+
+              e.g.
+                   fzf --margin 5% --padding 5% --border --preview 'cat {}' \
+                       --color bg:#222222,preview-bg:#333333
+
+              TRBL     Same padding for top, right, bottom, and left
+              TB,RL    Vertical, horizontal padding
+              T,RL,B   Top, horizontal, bottom padding
+              T,R,B,L  Top, right, bottom, left padding
+
+       --info=STYLE
+              Determines the display style of finder info.
+
+              default       Display on the next line to the prompt
+              inline        Display on the same line
+              hidden        Do not display finder info
+
+       --no-info
+              A synonym for --info=hidden
+
+       --prompt=STR
+              Input prompt (default: '> ')
+
+       --pointer=STR
+              Pointer to the current line (default: '>')
+
+       --marker=STR
+              Multi-select marker (default: '>')
+
+       --header=STR
+              The  given  string  will  be  printed  as the sticky header. The lines are displayed in the given order from top to bottom regardless of --layout option, and are not affected by
+              --with-nth. ANSI color codes are processed even when --ansi is not set.
+
+       --header-lines=N
+              The first N lines of the input are treated as the sticky header. When --with-nth is set, the lines are transformed just like the other lines that follow.
+
+       --header-first
+              Print header before the prompt line
+
+       --ellipsis=STR
+              Ellipsis to show when line is truncated (default: '..')
+
+   Display
+       --ansi Enable processing of ANSI color codes
+
+       --tabstop=SPACES
+              Number of spaces for a tab character (default: 8)
+
+       --color=[BASE_SCHEME][,COLOR_NAME[:ANSI_COLOR][:ANSI_ATTRIBUTES]]...
+              Color configuration. The name of the base color scheme is followed by custom color mappings.
+
+              BASE SCHEME:
+                  (default: dark on 256-color terminal, otherwise 16)
+
+                  dark    Color scheme for dark 256-color terminal
+                  light   Color scheme for light 256-color terminal
+                  16      Color scheme for 16-color terminal
+                  bw      No colors (equivalent to --no-color)
+
+              COLOR NAMES:
+                  fg         Text
+                  bg         Background
+                  preview-fg Preview window text
+                  preview-bg Preview window background
+                  hl         Highlighted substrings
+                  fg+        Text (current line)
+                  bg+        Background (current line)
+                  gutter     Gutter on the left (defaults to bg+)
+                  hl+        Highlighted substrings (current line)
+                  query      Query string
+                  disabled   Query string when search is disabled
+                  info       Info line (match counters)
+                  border     Border around the window (--border and --preview)
+                  prompt     Prompt
+                  pointer    Pointer to the current line
+                  marker     Multi-select marker
+                  spinner    Streaming input indicator
+                  header     Header
+
+              ANSI COLORS:
+                  -1         Default terminal foreground/background color
+                             (or the original color of the text)
+                  0 ~ 15     16 base colors
+                    black
+                    red
+                    green
+                    yellow
+                    blue
+                    magenta
+                    cyan
+                    white
+                    bright-black (gray | grey)
+                    bright-red
+                    bright-green
+                    bright-yellow
+                    bright-blue
+                    bright-magenta
+                    bright-cyan
+                    bright-white
+                  16 ~ 255   ANSI 256 colors
+                  #rrggbb    24-bit colors
+
+              ANSI ATTRIBUTES: (Only applies to foreground colors)
+                  regular    Clears previously set attributes; should precede the other ones
+                  bold
+                  underline
+                  reverse
+                  dim
+                  italic
+                  strikethrough
+
+              EXAMPLES:
+
+                   # Seoul256 theme with 8-bit colors
+                   # (https://github.com/junegunn/seoul256.vim)
+                   fzf --color='bg:237,bg+:236,info:143,border:240,spinner:108' \
+                       --color='hl:65,fg:252,header:65,fg+:252' \
+                       --color='pointer:161,marker:168,prompt:110,hl+:108'
+
+                   # Seoul256 theme with 24-bit colors
+                   fzf --color='bg:#4B4B4B,bg+:#3F3F3F,info:#BDBB72,border:#6B6B6B,spinner:#98BC99' \
+                       --color='hl:#719872,fg:#D9D9D9,header:#719872,fg+:#D9D9D9' \
+                       --color='pointer:#E12672,marker:#E17899,prompt:#98BEDE,hl+:#98BC99'
+
+       --no-bold
+              Do not use bold text
+
+       --black
+              Use black background
+
+   History
+       --history=HISTORY_FILE
+              Load search history from the specified file and update the file on completion.  When enabled, CTRL-N and CTRL-P are automatically remapped to next-history and previous-history.
+
+       --history-size=N
+              Maximum number of entries in the history file (default: 1000). The file is automatically truncated when the number of the lines exceeds the value.
+
+   Preview
+       --preview=COMMAND
+              Execute the given command for the current line and display the result on the preview window. {} in the command is the placeholder that is replaced to the single-quoted string of
+              the current line. To transform the replacement string, specify field index expressions between the braces (See FIELD INDEX EXPRESSION for the details).
+
+              e.g.
+                   fzf --preview='head -$LINES {}'
+                   ls -l | fzf --preview="echo user={3} when={-4..-2}; cat {-1}" --header-lines=1
+
+              fzf  exports $FZF_PREVIEW_LINES and $FZF_PREVIEW_COLUMNS so that they represent the exact size of the preview window. (It also overrides $LINES and $COLUMNS with the same values
+              but they can be reset by the default shell, so prefer to refer to the ones with FZF_PREVIEW_ prefix.)
+
+              A placeholder expression starting with + flag will be replaced to the space-separated list of the selected lines (or the current line if  no  selection  was  made)  individually
+              quoted.
+
+              e.g.
+                   fzf --multi --preview='head -10 {+}'
+                   git log --oneline | fzf --multi --preview 'git show {+1}'
+
+              When using a field index expression, leading and trailing whitespace is stripped from the replacement string. To preserve the whitespace, use the s flag.
+
+              Also,  {q}  is  replaced to the current query string, and {n} is replaced to zero-based ordinal index of the line. Use {+n} if you want all index numbers when multiple lines are
+              selected.
+
+              A placeholder expression with f flag is replaced to the path of a temporary file that holds the evaluated list. This is useful when you multi-select a large number of items  and
+              the length of the evaluated string may exceed ARG_MAX.
+
+              e.g.
+                   # Press CTRL-A to select 100K items and see the sum of all the numbers.
+                   # This won't work properly without 'f' flag due to ARG_MAX limit.
+                   seq 100000 | fzf --multi --bind ctrl-a:select-all \
+                                    --preview "awk '{sum+=\$1} END {print sum}' {+f}"
+
+              Note that you can escape a placeholder pattern by prepending a backslash.
+
+              Preview window will be updated even when there is no match for the current query if any of the placeholder expressions evaluates to a non-empty string.
+
+              Since  0.24.0,  fzf can render partial preview content before the preview command completes. ANSI escape sequence for clearing the display (CSI 2 J) is supported, so you can use
+              it to implement preview window that is constantly updating.
+
+              e.g.
+                    fzf --preview 'for i in $(seq 100000); do
+                      (( i % 200 == 0 )) && printf "\033[2J"
+                      echo "$i"
+                      sleep 0.01
+                    done'
+
+       --preview-window=[POSITION][,SIZE[%]][,border-BORDER_OPT][,[no]wrap][,[no]follow][,[no]cycle][,[no]hidden][,+SCROLL[OFFSETS][/DENOM]][,~HEADER_LINES][,default][,<SIZE_THRESHOLD(ALTER‐
+       NATIVE_LAYOUT)]
+
+              POSITION: (default: right)
+                  up
+                  down
+                  left
+                  right
+
+              Determines the layout of the preview window.
+
+              * If the argument contains :hidden, the preview window will be hidden by default until toggle-preview action is triggered.
+
+              * If size is given as 0, preview window will not be visible, but fzf will still execute the command in the background.
+
+              * Long lines are truncated by default. Line wrap can be enabled with wrap flag.
+
+              * Preview window will automatically scroll to the bottom when follow flag is set, similarly to how tail -f works.
+
+                     e.g.
+                           fzf --preview-window follow --preview 'for i in $(seq 100000); do
+                             echo "$i"
+                             sleep 0.01
+                             (( i % 300 == 0 )) && printf "\033[2J"
+                           done'
+
+              * Cyclic scrolling is enabled with cycle flag.
+
+              *  To  change  the  style  of the border of the preview window, specify one of the options for --border with border- prefix.  e.g. border-rounded (border with rounded edges, de‐
+              fault), border-sharp (border with sharp edges), border-left, border-none, etc.
+
+              * [:+SCROLL[OFFSETS][/DENOM]] determines the initial scroll offset of the preview window.
+
+                - SCROLL can be either a numeric integer or a single-field index expression that refers to a numeric integer.
+
+                - The optional OFFSETS part is for adjusting the base offset. It should be given as a series of signed integers (-INTEGER or +INTEGER).
+
+                - The final /DENOM part is for specifying a fraction of the preview window height.
+
+              * ~HEADER_LINES keeps the top N lines as the fixed header so that they are always visible.
+
+              * default resets all options previously set to the default.
+
+                     e.g.
+                          # Non-default scroll window positions and sizes
+                          fzf --preview="head {}" --preview-window=up,30%
+                          fzf --preview="file {}" --preview-window=down,1
+
+                          # Initial scroll offset is set to the line number of each line of
+                          # git grep output *minus* 5 lines (-5)
+                          git grep --line-number '' |
+                            fzf --delimiter : --preview 'nl {1}' --preview-window '+{2}-5'
+
+                          # Preview with bat, matching line in the middle of the window below
+                          # the fixed header of the top 3 lines
+                          #
+                          #   ~3    Top 3 lines as the fixed header
+                          #   +{2}  Base scroll offset extracted from the second field
+                          #   +3    Extra offset to compensate for the 3-line header
+                          #   /2    Put in the middle of the preview area
+                          #
+                          git grep --line-number '' |
+                            fzf --delimiter : \
+                                --preview 'bat --style=full --color=always --highlight-line {2} {1}' \
+                                --preview-window '~3,+{2}+3/2'
+
+                          # Display top 3 lines as the fixed header
+                          fzf --preview 'bat --style=full --color=always {}' --preview-window '~3'
+
+              * You can specify an alternative set of options that are used only when the size
+                of the preview window is below a certain threshold. Note that only one
+                alternative layout is allowed.
+
+                     e.g.
+                           fzf --preview 'cat {}' --preview-window 'right,border-left,<30(up,30%,border-bottom)'
+
+   Scripting
+       -q, --query=STR
+              Start the finder with the given query
+
+       -1, --select-1
+              If there is only one match for the initial query (--query), do not start interactive finder and automatically select the only match
+
+       -0, --exit-0
+              If there is no match for the initial query (--query), do not start interactive finder and exit immediately
+
+       -f, --filter=STR
+              Filter mode. Do not start interactive finder. When used with --no-sort, fzf becomes a fuzzy-version of grep.
+
+       --print-query
+              Print query as the first line
+
+       --expect=KEY[,..]
+              Comma-separated list of keys that can be used to complete fzf in addition to the default enter key. When this option is set, fzf will print the name of the key  pressed  as  the
+              first  line  of  its  output  (or as the second line if --print-query is also used). The line will be empty if fzf is completed with the default enter key. If --expect option is
+              specified multiple times, fzf will expect the union of the keys. --no-expect will clear the list.
+
+              e.g.
+                   fzf --expect=ctrl-v,ctrl-t,alt-s --expect=f1,f2,~,@
+
+       --read0
+              Read input delimited by ASCII NUL characters instead of newline characters
+
+       --print0
+              Print output delimited by ASCII NUL characters instead of newline characters
+
+       --no-clear
+              Do not clear finder interface on exit. If fzf was started in full screen mode, it will not switch back to the original screen, so you'll have to manually run tput rmcup  to  re‐
+              turn. This option can be used to avoid flickering of the screen when your application needs to start fzf multiple times in order.
+
+       --sync Synchronous search for multi-staged filtering. If specified, fzf will launch ncurses finder only after the input stream is complete.
+
+              e.g. fzf --multi | fzf --sync
+
+       --version
+              Display version information and exit
+
+       Note that most options have the opposite versions with --no- prefix.
+
+ENVIRONMENT VARIABLES
+       FZF_DEFAULT_COMMAND
+              Default  command to use when input is tty. On *nix systems, fzf runs the command with $SHELL -c if SHELL is set, otherwise with sh -c, so in this case make sure that the command
+              is POSIX-compliant.
+
+       FZF_DEFAULT_OPTS
+              Default options. e.g. export FZF_DEFAULT_OPTS="--extended --cycle"
+
+EXIT STATUS
+       0      Normal exit
+       1      No match
+       2      Error
+       130    Interrupted with CTRL-C or ESC
+
+FIELD INDEX EXPRESSION
+       A field index expression can be a non-zero integer or a range expression ([BEGIN]..[END]). --nth and --with-nth take a comma-separated list of field index expressions.
+
+   Examples
+       1      The 1st field
+       2      The 2nd field
+       -1     The last field
+       -2     The 2nd to last field
+       3..5   From the 3rd field to the 5th field
+       2..    From the 2nd field to the last field
+       ..-3   From the 1st field to the 3rd to the last field
+       ..     All the fields
+
+EXTENDED SEARCH MODE
+       Unless specified otherwise, fzf will start in "extended-search mode". In this mode, you can specify multiple patterns delimited by spaces, such as: 'wild ^music .mp3$ sbtrkt !rmx
+
+       You can prepend a backslash to a space (\ ) to match a literal space character.
+
+   Exact-match (quoted)
+       A term that is prefixed by a single-quote character (') is interpreted as an "exact-match" (or "non-fuzzy") term. fzf will search for the exact occurrences of the string.
+
+   Anchored-match
+       A term can be prefixed by ^, or suffixed by $ to become an anchored-match term. Then fzf will search for the lines that start with or end with the given string. An anchored-match  term
+       is also an exact-match term.
+
+   Negation
+       If a term is prefixed by !, fzf will exclude the lines that satisfy the term from the result. In this case, fzf performs exact match by default.
+
+   Exact-match by default
+       If you don't prefer fuzzy matching and do not wish to "quote" (prefixing with ') every word, start fzf with -e or --exact option. Note that when --exact is set, '-prefix "unquotes" the
+       term.
+
+   OR operator
+       A single bar character term acts as an OR operator. For example, the following query matches entries that start with core and end with either go, rb, or py.
+
+       e.g. ^core go$ | rb$ | py$
+
+KEY/EVENT BINDINGS
+       --bind option allows you to bind a key or an event to one or more actions. You can use it to customize key bindings or implement dynamic behaviors.
+
+       --bind takes a comma-separated list of binding expressions. Each binding expression is KEY:ACTION or EVENT:ACTION.
+
+       e.g.
+            fzf --bind=ctrl-j:accept,ctrl-k:kill-line
+
+   AVAILABLE KEYS: (SYNONYMS)
+       ctrl-[a-z]
+       ctrl-space
+       ctrl-\
+       ctrl-]
+       ctrl-^      (ctrl-6)
+       ctrl-/      (ctrl-_)
+       ctrl-alt-[a-z]
+       alt-[*]     (Any case-sensitive single character is allowed)
+       f[1-12]
+       enter       (return ctrl-m)
+       space
+       bspace      (bs)
+       alt-up
+       alt-down
+       alt-left
+       alt-right
+       alt-enter
+       alt-space
+       alt-bspace  (alt-bs)
+       tab
+       btab        (shift-tab)
+       esc
+       del
+       up
+       down
+       left
+       right
+       home
+       end
+       insert
+       pgup        (page-up)
+       pgdn        (page-down)
+       shift-up
+       shift-down
+       shift-left
+       shift-right
+       alt-shift-up
+       alt-shift-down
+       alt-shift-left
+       alt-shift-right
+       left-click
+       right-click
+       double-click
+       or any single character
+
+   AVAILABLE EVENTS:
+       change
+              Triggered whenever the query string is changed
+
+              e.g.
+                   # Move cursor to the first entry whenever the query is changed
+                   fzf --bind change:first
+
+       backward-eof
+              Triggered when the query string is already empty and you try to delete it backward.
+
+              e.g.
+                   fzf --bind backward-eof:abort
+
+   AVAILABLE ACTIONS:
+       A key or an event can be bound to one or more of the following actions.
+
+         ACTION:                   DEFAULT BINDINGS (NOTES):
+           abort                      ctrl-c  ctrl-g  ctrl-q  esc
+           accept                     enter   double-click
+           accept-non-empty           (same as accept except that it prevents fzf from exiting without selection)
+           backward-char              ctrl-b  left
+           backward-delete-char       ctrl-h  bspace
+           backward-delete-char/eof   (same as backward-delete-char except aborts fzf if query is empty)
+           backward-kill-word         alt-bs
+           backward-word              alt-b   shift-left
+           beginning-of-line          ctrl-a  home
+           cancel                     (clear query string if not empty, abort fzf otherwise)
+           change-preview(...)        (change --preview option)
+           change-preview-window(...) (change --preview-window option; rotate through the multiple option sets separated by '|')
+           change-prompt(...)         (change prompt to the given string)
+           clear-screen               ctrl-l
+           clear-selection            (clear multi-selection)
+           close                      (close preview window if open, abort fzf otherwise)
+           clear-query                (clear query string)
+           delete-char                del
+           delete-char/eof            ctrl-d (same as delete-char except aborts fzf if query is empty)
+           deselect
+           deselect-all               (deselect all matches)
+           disable-search             (disable search functionality)
+           down                       ctrl-j  ctrl-n  down
+           enable-search              (enable search functionality)
+           end-of-line                ctrl-e  end
+           execute(...)               (see below for the details)
+           execute-silent(...)        (see below for the details)
+           first                      (move to the first match)
+           forward-char               ctrl-f  right
+           forward-word               alt-f   shift-right
+           ignore
+           jump                       (EasyMotion-like 2-keystroke movement)
+           jump-accept                (jump and accept)
+           kill-line
+           kill-word                  alt-d
+           last                       (move to the last match)
+           next-history               (ctrl-n on --history)
+           page-down                  pgdn
+           page-up                    pgup
+           half-page-down
+           half-page-up
+           preview(...)               (see below for the details)
+           preview-down               shift-down
+           preview-up                 shift-up
+           preview-page-down
+           preview-page-up
+           preview-half-page-down
+           preview-half-page-up
+           preview-bottom
+           preview-top
+           previous-history           (ctrl-p on --history)
+           print-query                (print query and exit)
+           put                        (put the character to the prompt)
+           refresh-preview
+           rebind(...)                (rebind bindings after unbind)
+           reload(...)                (see below for the details)
+           replace-query              (replace query string with the current selection)
+           select
+           select-all                 (select all matches)
+           toggle                     (right-click)
+           toggle-all                 (toggle all matches)
+           toggle+down                ctrl-i  (tab)
+           toggle-in                  (--layout=reverse* ? toggle+up : toggle+down)
+           toggle-out                 (--layout=reverse* ? toggle+down : toggle+up)
+           toggle-preview
+           toggle-preview-wrap
+           toggle-search              (toggle search functionality)
+           toggle-sort
+           toggle+up                  btab    (shift-tab)
+           unbind(...)                (unbind bindings)
+           unix-line-discard          ctrl-u
+           unix-word-rubout           ctrl-w
+           up                         ctrl-k  ctrl-p  up
+           yank                       ctrl-y
+
+   ACTION COMPOSITION
+       Multiple actions can be chained using + separator.
+
+       e.g.
+            fzf --multi --bind 'ctrl-a:select-all+accept'
+            fzf --multi --bind 'ctrl-a:select-all' --bind 'ctrl-a:+accept'
+
+   ACTION ARGUMENT
+       An action denoted with (...) suffix takes an argument.
+
+       e.g.
+            fzf --bind 'ctrl-a:change-prompt(NewPrompt> )'
+            fzf --bind 'ctrl-v:preview(cat {})' --preview-window hidden
+
+       If the argument contains parentheses, fzf may fail to parse the expression. In that case, you can use any of the following alternative notations to avoid parse errors.
+
+           action-name[...]
+           action-name~...~
+           action-name!...!
+           action-name@...@
+           action-name#...#
+           action-name$...$
+           action-name%...%
+           action-name^...^
+           action-name&...&
+           action-name*...*
+           action-name;...;
+           action-name/.../
+           action-name|...|
+           action-name:...
+              The last one is the special form that frees you from parse errors as it does not expect the closing character. The catch is that it should be the last one in the comma-separated
+              list of key-action pairs.
+
+   COMMAND EXECUTION
+       With  execute(...)  action,  you  can execute arbitrary commands without leaving fzf. For example, you can turn fzf into a simple file browser by binding enter key to less command like
+       follows.
+
+           fzf --bind "enter:execute(less {})"
+
+       You can use the same placeholder expressions as in --preview.
+
+       fzf switches to the alternate screen when executing a command. However, if the command is expected to complete quickly, and you are not interested in its output, you might want to  use
+       execute-silent instead, which silently executes the command without the switching. Note that fzf will not be responsive until the command is complete. For asynchronous execution, start
+       your command as a background process (i.e. appending &).
+
+       On *nix systems, fzf runs the command with $SHELL -c if SHELL is set, otherwise with sh -c, so in this case make sure that the command is POSIX-compliant.
+
+   RELOAD INPUT
+       reload(...) action is used to dynamically update the input list without restarting fzf. It takes the same command template with placeholder expressions as execute(...).
+
+       See https://github.com/junegunn/fzf/issues/1750 for more info.
+
+       e.g.
+            # Update the list of processes by pressing CTRL-R
+            ps -ef | fzf --bind 'ctrl-r:reload(ps -ef)' --header 'Press CTRL-R to reload' \
+                         --header-lines=1 --layout=reverse
+
+            # Integration with ripgrep
+            RG_PREFIX="rg --column --line-number --no-heading --color=always --smart-case "
+            INITIAL_QUERY="foobar"
+            FZF_DEFAULT_COMMAND="$RG_PREFIX '$INITIAL_QUERY'" \
+              fzf --bind "change:reload:$RG_PREFIX {q} || true" \
+                  --ansi --disabled --query "$INITIAL_QUERY"
+
+   PREVIEW BINDING
+       With preview(...) action, you can specify multiple different preview commands in addition to the default preview command given by --preview option.
+
+       e.g.
+            # Default preview command with an extra preview binding
+            fzf --preview 'file {}' --bind '?:preview:cat {}'
+
+            # A preview binding with no default preview command
+            # (Preview window is initially empty)
+            fzf --bind '?:preview:cat {}'
+
+            # Preview window hidden by default, it appears when you first hit '?'
+            fzf --bind '?:preview:cat {}' --preview-window hidden
+
+   CHANGE PREVIEW WINDOW ATTRIBUTES
+       change-preview-window action can be used to change the properties of the preview window. Unlike the --preview-window option, you can specify multiple sets of options separated  by  '|'
+       characters.
+
+       e.g.
+            # Rotate through the options using CTRL-/
+            fzf --preview 'cat {}' --bind 'ctrl-/:change-preview-window(right,70%|down,40%,border-horizontal|hidden|right)'
+
+            # The default properties given by `--preview-window` are inherited, so an empty string in the list is interpreted as the default
+            fzf --preview 'cat {}' --preview-window 'right,40%,border-left' --bind 'ctrl-/:change-preview-window(70%|down,border-top|hidden|)'
+
+            # This is equivalent to toggle-preview action
+            fzf --preview 'cat {}' --bind 'ctrl-/:change-preview-window(hidden|)'
+
+AUTHOR
+       Junegunn Choi (junegunn.c@gmail.com)
+
+SEE ALSO
+       Project homepage:
+              https://github.com/junegunn/fzf
+
+       Extra Vim plugin:
+              https://github.com/junegunn/fzf.vim
+
+LICENSE
+       MIT
+
+fzf 0.33.0                                                                                  Aug 2022                                                                                     fzf(1)

tests/syntax-tests/highlighted/NSIS/test.nsi

@@ -0,0 +1,61 @@
+/*
+ * Multi-line
+ * Comment
+ */
+
+# Single-line comment
+; Another-single line comment
+
+; Includes
+!include "LogicLib.nsh"
+
+; Defines
+!define ARCHITECTURE "x64"
+
+; Compile time command
+!echo "Building ${ARCHITECTURE} script"
+
+; Macro definition
+!macro SayHello name
+    !ifdef name
+        !echo "Hello, ${name}"
+    !else
+        !echo "Hello, world"
+    !endif
+!macroend
+
+; Macro usage
+!insertmacro SayHello "John Doe"
+
+; Settings
+Name "installer_name"
+OutFile "installer_name.exe"
+RequestExecutionLevel user
+CRCCheck on
+Unicode true
+
+!ifdef ${ARCHITECTURE}
+  InstallDir "$PROGRAMFILES64\installer_name"
+!else
+  InstallDir "$PROGRAMFILES\installer_name"
+!endif
+
+; Pages
+Page components
+Page instfiles
+
+; Functions
+Function PrintTestStrings
+  DetailPrint "The install button reads $(^InstallBtn)"
+  DetailPrint 'Here comes a$\n$\rline-break!'
+  DetailPrint `Escape the dollar-sign: $$`
+FunctionEnd
+
+; Sections
+Section "section_name" section_index
+    Call PrintTestStrings    
+
+    ; NSIS plugin call
+    nsExec::ExecToLog "calc.exe"
+SectionEnd
+