Update man page regarding --nonprintable-notation

Updates for bat 0.23

.github/ISSUE_TEMPLATE/bug_report.md

@@ -7,9 +7,26 @@ assignees: ''
 
 ---
 
-<!-- Hey there, thank you for creating an issue! -->
+<!--
 
-**Describe the bug you encountered:**
+Hey there, thank you for reporting a bug!
+
+Please note that the following bugs have already been reported:
+
+* dpkg: error processing archive /some/path/some-program.deb (--unpack):
+  trying to overwrite '/usr/.crates2.json'
+
+  See https://github.com/sharkdp/bat/issues/938
+
+-->
+
+**What steps will reproduce the bug?**
+
+1. step 1
+2. step 2
+3. ...
+
+**What happens?**
 
 ...
 

.github/ISSUE_TEMPLATE/question.md

@@ -7,3 +7,5 @@ assignees: ''
 
 ---
 
+<!-- Using a normal ticket is still fine, but feel free to ask your
+questions about bat on https://github.com/sharkdp/bat/discussions instead. -->

.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,7 +1,6 @@
 name: CICD
 
 env:
-  MIN_SUPPORTED_RUST_VERSION: "1.51.0"
   CICD_INTERMEDIATES_DIR: "_cicd-intermediates"
 
 on:
@@ -18,20 +17,17 @@ jobs:
     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@v3
     - run: cargo fmt -- --check
 
   license_checks:
     name: License checks
     runs-on: ubuntu-20.04
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
       with:
         submodules: true # we especially want to perform license checks on submodules
     - run: tests/scripts/license-checks.sh
@@ -39,64 +35,45 @@ jobs:
   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
+      uses: actions/checkout@v3
 
-    - name: Install rust toolchain (v${{ env.MIN_SUPPORTED_RUST_VERSION }})
-      uses: actions-rs/toolchain@v1
+    - name: Get the MSRV from the package metadata
+      id: msrv
+      run: cargo metadata --no-deps --format-version 1 | jq -r '"version=" + (.packages[] | select(.name == "bat")).rust_version' >> $GITHUB_OUTPUT
+    - name: Install rust toolchain (v${{ steps.msrv.outputs.version }})
+      uses: dtolnay/rust-toolchain@master
       with:
-        toolchain: ${{ env.MIN_SUPPORTED_RUST_VERSION }}
-        default: true
-        profile: minimal # minimal component installation (ie, no documentation)
+        toolchain: ${{ steps.msrv.outputs.version }}
         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 --all-features
+      run: cargo clippy --locked --all-targets ${{ env.MSRV_FEATURES }}
     - name: Run tests
-      uses: actions-rs/cargo@v1
-      with:
-        command: test
-        args: --locked
+      run: cargo test --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@v3
       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 -- --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
@@ -106,25 +83,36 @@ jobs:
     - name: Test custom assets
       run: tests/syntax-tests/test_custom_assets.sh
 
+  test_with_system_config:
+    name: Run tests with system wide configuration
+    runs-on: ubuntu-20.04
+    steps:
+    - name: Git checkout
+      uses: actions/checkout@v3
+    - name: Prepare environment variables
+      run: |
+        echo "BAT_SYSTEM_CONFIG_PREFIX=$GITHUB_WORKSPACE/tests/examples/system_config" >> $GITHUB_ENV
+    - name: Install Rust toolchain
+      uses: dtolnay/rust-toolchain@stable
+    - name: Build and install bat
+      run: cargo install --locked --path .
+    - name: Run unit tests
+      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@v3
     - name: Install Rust toolchain
-      uses: actions-rs/toolchain@v1
-      with:
-        toolchain: stable
-        default: true
-        profile: minimal
+      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)
 
   build:
     name: ${{ matrix.job.target }} (${{ matrix.job.os }})
@@ -142,11 +130,13 @@ jobs:
           - { target: x86_64-apple-darwin         , os: macos-10.15                   }
           - { 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                  }
+          - { 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@v3
 
     - name: Install prerequisites
       shell: bash
@@ -165,12 +155,20 @@ jobs:
         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
@@ -183,14 +181,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 bin name & path
+      id: bin
       shell: bash
       run: |
         # Figure out suffix of binary
@@ -199,31 +194,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_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 bin
+        echo "BIN_PATH=${BIN_PATH}" >> $GITHUB_OUTPUT
+        echo "BIN_NAME=${BIN_NAME}" >> $GITHUB_OUTPUT
 
     - name: Set testing options
       id: test-options
@@ -232,63 +209,39 @@ jobs:
         # 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}
+        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: $BUILD_CMD test --locked --target=${{ matrix.job.target }} ${{ steps.test-options.outputs.CARGO_TEST_OPTIONS}}
 
     - 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
@@ -297,7 +250,7 @@ jobs:
         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_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}/"
@@ -305,7 +258,7 @@ jobs:
         mkdir -p "${ARCHIVE_DIR}/autocomplete"
 
         # Binary
-        cp "${{ steps.strip.outputs.BIN_PATH }}" "$ARCHIVE_DIR"
+        cp "${{ steps.bin.outputs.BIN_PATH }}" "$ARCHIVE_DIR"
 
         # Man page
         cp 'target/${{ matrix.job.target }}/release/build/${{ env.PROJECT_NAME }}'-*/out/assets/manual/bat.1 "$ARCHIVE_DIR"
@@ -328,7 +281,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
@@ -355,10 +308,10 @@ 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"
@@ -434,7 +387,7 @@ jobs:
         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}"
@@ -457,7 +410,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

.gitmodules

@@ -236,3 +236,21 @@
 [submodule "assets/syntaxes/02_Extra/Dart"]
 	path = assets/syntaxes/02_Extra/Dart
 	url = https://github.com/elMuso/Dartlight.git
+[submodule "assets/syntaxes/02_Extra/SublimeJQ"]
+	path = assets/syntaxes/02_Extra/SublimeJQ
+	url = https://github.com/zogwarg/SublimeJQ.git
+[submodule "assets/syntaxes/02_Extra/cmd-help"]
+	path = assets/syntaxes/02_Extra/cmd-help
+	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

CHANGELOG.md

@@ -1,12 +1,134 @@
-# unreleased
+# 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
+
+- Make the default macOS theme depend on Dark Mode. See #2197, #1746 (@Enselic)
+- Support for separate system and user config files. See #668 (@patrickpichler)
+
+## Bugfixes
+
+- Prevent fork nightmare with `PAGER=batcat`. See #2235 (@johnmatthiggins)
+- Make `--no-paging`/`-P` override `--paging=...` if passed as a later arg, see #2201 (@themkat)
+- `--map-syntax` and `--ignored-suffix` now works together, see #2093 (@czzrr)
+- Strips byte order mark from output when in non-loop-through mode. See #1922 (@dag-h)
+
+## Other
+
+- Relaxed glibc requirements on amd64, see #2106 and #2194 (@sharkdp)
+- Improved fish completions. See #2275 (@zgracem)
+- Stop pre-processing ANSI escape characters. Syntax highlighting on ANSI escaped input is not supported. See #2185 and #2189 (@Enselic)
+
+## Syntaxes
+
+- NSE (Nmap Scripting Engine) is mapped to Lua, see #2151 (@Cre3per)
+- Correctly color `fstab` dump and pass fields, see #2246 (@yuvalmo)
+- Update `Command Help` syntax, see #2255
+- `Julia`: Fix syntax highlighting for function name starting with `struct`, see #2230
+- Minor update to `LiveScript`, see #2291
+- Associate `.mts` and `.cts` files with the `TypeScript` syntax. See #2236 (@kidonng)
+- Fish history is mapped to YAML. See #2237 (@kidonng)
+
+## `bat` as a library
+
+- Make `bat::PrettyPrinter::syntaxes()` iterate over new `bat::Syntax` struct instead of `&syntect::parsing::SyntaxReference`. See #2222 (@Enselic)
+- Clear highlights after printing, see #1919 and #1920 (@rhysd)
+
+
+# v0.21.0
+
+## Features
+
+- Correctly render tab stops in `--show-all`, see #2038 (@Synthetica9)
+- Add a `--style=default` option and make it the default. It is less verbose than `full`, see #2061 (@IsaacHorvath)
+- Enable BusyBox `less` as pager, see #2162 (@nfisher1226)
+- File extensions are now matched case-insensitively. See #1854, #2181 (@Enselic)
+
+## Bugfixes
+
+- Bump `regex` dependency from 1.5.4 to 1.5.5 to fix [CVE-2022-24713](https://blog.rust-lang.org/2022/03/08/cve-2022-24713.html), see #2145, #2139 (@Enselic)
+- `bat` no longer crashes when encountering files that references missing syntaxes. See #915, #2181 (@Enselic)
+
+## Performance
+
+- Skip syntax highlighting on long lines (> 16384 chars) to help improve performance. See #2165 (@keith-hall)
+- Vastly improve startup time by lazy-loading syntaxes via syntect 5.0.0. This makes bat display small files ~75% faster than before. See #951, #2181 (@Enselic)
+
+## Other
+
+- Include info about custom assets in `--diagnostics` if used. See #2107, #2144 (@Enselic)
+
+## Syntaxes
+
+- Mapped clang-format config file (.clang-format) to YAML syntax (@TruncatedDinosour)
+- log syntax: improved handling of escape characters in double quoted strings. See #2123 (@keith-hall)
+- Associate `/var/spool/mail/*` and `/var/mail/*` with the `Email` syntax. See #2156 (@cyqsimon)
+- Added cmd-help syntax to scope --help messages. See #2148 (@victor-gp)
+- Slightly adjust Zig syntax. See #2136 (@Enselic)
+- Associate `.inf` files with the `INI` syntax. See #2190 (@Enselic)
+
+## `bat` as a library
+
+- Allow configuration of `show_nonprintable` with `PrettyPrinter`, see #2142
+- The binary format of syntaxes.bin has been changed due to syntaxes now being lazy-loaded via syntect 5.0.0. See #2181 (@Enselic)
+- Mark `bat::error::Error` enum as `#[non_exhaustive]` to allow adding new variants without future semver breakage. See #2181 (@Enselic)
+- Change `Error::SyntectError(syntect::LoadingError)` to `Error::SyntectError(syntect::Error)`. See #2181 (@Enselic)
+- Add `Error::SyntectLoadingError(syntect::LoadingError)` enum variant. See #2181 (@Enselic)
+
+
+# v0.20.0
 
 ## Features
 
 - New style component `header-filesize` to show size of the displayed file in the header. See #1988 (@mdibaiee)
+- Use underline for line highlighting on ANSI, see #1730 (@mdibaiee)
 
 ## Bugfixes
 
-## Other
+- Fix bash completion on bash 3.x and bash-completion 1.x. See #2066 (@joshpencheon)
 
 ## Syntaxes
 
@@ -14,12 +136,14 @@
 - Associate `_vimrc` and `_gvimrc` files with the `VimL` syntax. See #2002
 - Associate `poetry.lock` files with the `TOML` syntax. See #2049
 - Associate `.mesh`, `.task`, `.rgen`, `.rint`, `.rahit`, `.rchit`, `.rmiss`, and `.rcall` with the `GLSL` syntax. See #2050
-
-## Themes
+- Added support for `JQ` syntax, see #2072
+- Properly associate global git config files rooted in `$XDG_CONFIG_HOME/git/` or `$HOME/.config/git/`. See #2067 (@cyqsimon)
 
 ## `bat` as a library
 
 - Exposed `get_syntax_set` and `get_theme` methods on `HighlightingAssets`. See #2030 (@dandavison)
+- Added `HeaderFilename` and `HeaderFilesize` to `StyleComponent` enum, and mark it `#[non_exhaustive]`. See #1988 (@mdibaiee)
+
 
 # v0.19.0
 

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
@@ -46,3 +46,25 @@ If you really think that a particular syntax or theme should be added for all
 users, please read the corresponding
 [documentation](https://github.com/sharkdp/bat/blob/master/doc/assets.md)
 first.
+
+
+## Regression tests
+
+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.
+
+* 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
+[`tests/integration_tests.rs`](https://github.com/sharkdp/bat/blob/master/tests/integration_tests.rs).
+Look at existing tests to know how to write a new test. In short, you will
+invoke the `bat` binary with a certain set of arguments, and then assert on
+stdout/stderr.
+
+To learn how to write regression tests for theme and syntax changes, read the
+[Syntax
+tests](https://github.com/sharkdp/bat/blob/master/doc/assets.md#syntax-tests)
+section in `assets.md`.

Cargo.toml

@@ -6,10 +6,11 @@ homepage = "https://github.com/sharkdp/bat"
 license = "MIT/Apache-2.0"
 name = "bat"
 repository = "https://github.com/sharkdp/bat"
-version = "0.19.0"
+version = "0.23.0"
 exclude = ["assets/syntaxes/*", "assets/themes/*"]
 build = "build.rs"
 edition = '2018'
+rust-version = "1.64"
 
 [features]
 default = ["application"]
@@ -26,15 +27,14 @@ application = [
 minimal-application = [
     "atty",
     "clap",
-    "dirs-next",
+    "dirs",
     "paging",
     "regex-onig",
     "wild",
 ]
 git = ["git2"] # Support indicating git modifications
 paging = ["shell-words", "grep-cli"] # Support applying a pager on the output
-# Add "syntect/plist-load" when https://github.com/trishume/syntect/pull/345 reaches us
-build-assets = ["syntect/yaml-load", "syntect/dump-create", "regex", "walkdir"]
+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:
 regex-onig = ["syntect/regex-onig"] # Use the "oniguruma" regex engine
@@ -42,60 +42,67 @@ 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.47.0"
+ansi_colours = "^1.2"
 bincode = "1.0"
-console = "0.15.0"
+console = "0.15.5"
 flate2 = "1.0"
-once_cell = "1.9"
+once_cell = "1.17"
 thiserror = "1.0"
-wild = { version = "2.0", optional = true }
+wild = { version = "2.1", optional = true }
 content_inspector = "0.2.4"
 encoding = "0.2"
-shell-words = { version = "1.0.0", optional = true }
-unicode-width = "0.1.9"
+shell-words = { version = "1.1.0", optional = true }
+unicode-width = "0.1.10"
 globset = "0.4"
 serde = { version = "1.0", features = ["derive"] }
 serde_yaml = "0.8"
 semver = "1.0"
 path_abs = { version = "0.5", default-features = false }
 clircle = "0.3"
-bugreport = { version = "0.4", optional = true }
-dirs-next = { version = "2.0.0", optional = true }
-grep-cli = { version = "0.1.6", optional = true }
-regex = { version = "1.0", optional = true }
+bugreport = { version = "0.5.0", optional = true }
+dirs = { version = "5.0.0", optional = true }
+grep-cli = { version = "0.1.7", optional = true }
+regex = { version = "1.7.0", optional = true }
 walkdir = { version = "2.0", optional = true }
 bytesize = { version = "1.1.0" }
 
 [dependencies.git2]
-version = "0.13"
+version = "0.16"
 optional = true
 default-features = false
 
 [dependencies.syntect]
-version = "4.6.0"
+version = "5.0.0"
 default-features = false
 features = ["parsing"]
 
 [dependencies.clap]
-version = "2.34"
+version = "4.1.8"
 optional = true
-default-features = false
-features = ["suggestions", "color", "wrap_help"]
+features = ["wrap_help", "cargo"]
+
+[target.'cfg(target_os = "macos")'.dependencies]
+dirs = "5.0.0"
+plist = "1.3"
 
 [dev-dependencies]
-assert_cmd = "2.0.4"
-serial_test = "0.5.1"
-predicates = "2.1.0"
+assert_cmd = "2.0.8"
+expect-test = "1.4.0"
+serial_test = "0.6.0"
+predicates = "2.1.5"
 wait-timeout = "0.2.0"
 tempfile = "3.3.0"
 
 [target.'cfg(unix)'.dev-dependencies]
-nix = "0.23.1"
+nix = { version = "0.26.2", default-features = false, features = ["term"] }
 
-[build-dependencies]
-clap = { version = "2.34", optional = true }
+[build-dependencies.clap]
+version = "4.1.8"
+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

@@ -21,7 +21,7 @@
 
 ### Sponsors
 
-a special thank you goes to our biggest <a href="doc/sponsors.md">sponsors</a>:<br>
+A special *thank you* goes to our biggest <a href="doc/sponsors.md">sponsors</a>:<br>
 <a href="https://workos.com/?utm_campaign=github_repo&utm_medium=referral&utm_content=bat&utm_source=github">
   <img src="doc/sponsors/workos-logo-white-bg.svg" width="200" alt="WorkOS">
   <br>
@@ -171,7 +171,7 @@ You can combine `bat` with `git diff` to view lines around code changes with pro
 highlighting:
 ```bash
 batdiff() {
-    git diff --name-only --diff-filter=d | xargs bat --diff
+    git diff --name-only --relative --diff-filter=d | xargs bat --diff
 }
 ```
 If you prefer to use this as a separate tool, check out `batdiff` in [`bat-extras`](https://github.com/eth-p/bat-extras).
@@ -212,6 +212,24 @@ Also, note that this will [not work](https://github.com/sharkdp/bat/issues/1145)
 
 The [`prettybat`](https://github.com/eth-p/bat-extras/blob/master/doc/prettybat.md) script is a wrapper that will format code and print it with `bat`.
 
+#### Highlighting `--help` messages
+
+You can use `bat` to colorize help text: `$ cp --help | bat -plhelp`
+
+You can also use a wrapper around this:
+
+```bash
+# in your .bashrc/.zshrc/*rc
+alias bathelp='bat --plain --language=help'
+help() {
+    "$@" --help 2>&1 | bathelp
+}
+```
+
+Then you can do `$ help cp` or `$ help git commit`.
+
+Please report any issues with the help syntax in [this repository](https://github.com/victor-gp/cmd-help-sublime-syntax).
+
 
 ## Installation
 
@@ -349,7 +367,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
@@ -400,7 +418,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.51 or
+If you want to build `bat` from source, you need Rust 1.64.0 or
 higher. You can then use `cargo` to build everything:
 
 ```bash
@@ -621,6 +639,10 @@ A default configuration file can be created with the `--generate-config-file` op
 bat --generate-config-file
 ```
 
+There is also now a systemwide configuration file, which is located under `/etc/bat/config` on
+Linux and Mac OS and `C:\ProgramData\bat\config` on windows. If the system wide configuration
+file is present, the content of the user configuration will simply be appended to it.
+
 ### Format
 
 The configuration file is a simple list of command line arguments. Use `bat --help` to see a full list of possible options and values. In addition, you can add comments by prepending a line with the `#` character.
@@ -779,7 +801,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

@@ -37,7 +37,7 @@ Register-ArgumentCompleter -Native -CommandName '{{PROJECT_EXECUTABLE}}' -Script
             [CompletionResult]::new('-m', 'm', [CompletionResultType]::ParameterName, 'Use the specified syntax for files matching the glob pattern (''*.cpp:C++'').')
             [CompletionResult]::new('--map-syntax', 'map-syntax', [CompletionResultType]::ParameterName, 'Use the specified syntax for files matching the glob pattern (''*.cpp:C++'').')
             [CompletionResult]::new('--theme', 'theme', [CompletionResultType]::ParameterName, 'Set the color theme for syntax highlighting.')
-            [CompletionResult]::new('--style', 'style', [CompletionResultType]::ParameterName, 'Comma-separated list of style elements to display (*auto*, full, plain, changes, header, grid, rule, numbers, snip).')
+            [CompletionResult]::new('--style', 'style', [CompletionResultType]::ParameterName, 'Comma-separated list of style elements to display (*default*, auto, full, plain, changes, header, header-filename, header-filesize, grid, rule, numbers, snip).')
             [CompletionResult]::new('-r', 'r', [CompletionResultType]::ParameterName, 'Only print the lines from N to M.')
             [CompletionResult]::new('--line-range', 'line-range', [CompletionResultType]::ParameterName, 'Only print the lines from N to M.')
             [CompletionResult]::new('-A', 'A', [CompletionResultType]::ParameterName, 'Show non-printable characters (space, tab, newline, ..).')
@@ -68,7 +68,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

@@ -2,9 +2,43 @@
 
 # Requires https://github.com/scop/bash-completion
 
+# Macs have bash3 for which the bash-completion package doesn't include
+# _init_completion. This is a minimal version of that function.
+__bat_init_completion()
+{
+	COMPREPLY=()
+	_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
+	local cur prev words cword split=false
+	if declare -F _init_completion >/dev/null 2>&1; then
 		_init_completion -s || return 0
+	else
+		__bat_init_completion -n "=" || return 0
+		_split_longopt && split=true
+	fi
 
 	if [[ ${words[1]-} == cache ]]; then
 		case $prev in
@@ -14,7 +48,12 @@ _bat() {
 			;;
 		esac
 		COMPREPLY=($(compgen -W "
-			--build --clear --source --target --blank --help
+			--build
+			--clear
+			--source
+			--target
+			--blank
+			--help
 		" -- "$cur"))
 		return 0
 	fi
@@ -27,13 +66,26 @@ _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 | \
+	--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
@@ -61,28 +113,78 @@ _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
+			--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

@@ -1,78 +1,220 @@
 # Fish Shell Completions
-# Place or symlink to $XDG_CONFIG_HOME/fish/completions/{{PROJECT_EXECUTABLE}}.fish ($XDG_CONFIG_HOME is usually set to ~/.config)
+# Copy or symlink to $XDG_CONFIG_HOME/fish/completions/{{PROJECT_EXECUTABLE}}.fish
+# ($XDG_CONFIG_HOME is usually set to ~/.config)
 
-# Helper function:
-function __{{PROJECT_EXECUTABLE}}_autocomplete_languages --description "A helper function used by "(status filename)
-	{{PROJECT_EXECUTABLE}} --list-languages | awk -F':' '
-		{
-			lang=$1
-			split($2, exts, ",")
+# `bat` is `batcat` on Debian and Ubuntu
+set bat {{PROJECT_EXECUTABLE}}
 
-			for (i in exts) {
-				ext=exts[i]
-				if (ext !~ /[A-Z].*/ && ext !~ /^\..*rc$/) {
-					print ext"\t"lang
-				}
-			}
-		}
-	' | sort
+# Helper functions:
+
+function __bat_complete_files -a token
+    # Cheat to complete files by calling `complete -C` on a fake command name,
+    # like `__fish_complete_directories` does.
+    set -l fake_command aaabccccdeeeeefffffffffgghhhhhhiiiii
+    complete -C"$fake_command $token"
 end
 
+function __bat_complete_one_language -a comp
+    command $bat --list-languages | string split -f1 : | string match -e "$comp"
+end
+
+function __bat_complete_list_languages
+    for spec in (command $bat --list-languages)
+        set -l name (string split -f1 : $spec)
+        for ext in (string split -f2 : $spec | string split ,)
+            test -n "$ext"; or continue
+            string match -rq '[/*]' $ext; and continue
+            printf "%s\t%s\n" $ext $name
+        end
+        printf "%s\t\n" $name
+    end
+end
+
+function __bat_complete_map_syntax
+    set -l token (commandline -ct)
+
+    if string match -qr '(?<glob>.+):(?<syntax>.*)' -- $token
+        # If token ends with a colon, complete with the list of language names.
+        set -f comps $glob:(__bat_complete_one_language $syntax)
+    else if string match -qr '\*' -- $token
+        # If token contains a globbing character (`*`), complete only possible
+        # globs in the current directory
+        set -f comps (__bat_complete_files $token | string match -er '[*]'):
+    else
+        # Complete files (and globs).
+        set -f comps (__bat_complete_files $token | string match -erv '/$'):
+    end
+
+    if set -q comps[1]
+        printf "%s\t\n" $comps
+    end
+end
+
+function __bat_cache_subcommand
+    __fish_seen_subcommand_from cache
+end
+
+# Returns true if no exclusive arguments seen.
+function __bat_no_excl_args
+    not __bat_cache_subcommand; and not __fish_seen_argument \
+        -s h -l help \
+        -s V -l version \
+        -l acknowledgements \
+        -l config-dir -l config-file \
+        -l diagnostic \
+        -l list-languages -l list-themes
+end
+
+# Returns true if the 'cache' subcommand is seen without any exclusive arguments.
+function __bat_cache_no_excl
+    __bat_cache_subcommand; and not __fish_seen_argument \
+        -s h -l help \
+        -l acknowledgements -l build -l clear
+end
+
+function __bat_style_opts
+    set -l style_opts \
+        "default,recommended components" \
+        "auto,same as 'default' unless piped" \
+        "full,all components" \
+        "plain,no components" \
+        "changes,Git change markers" \
+        "header,alias for header-filename" \
+        "header-filename,filename above content" \
+        "header-filesize,filesize above content" \
+        "grid,lines b/w sidebar/header/content" \
+        "numbers,line numbers in sidebar" \
+        "rule,separate files" \
+        "snip,separate ranges"
+
+    string replace , \t $style_opts
+end
+
+# Use option argument descriptions to indicate which is the default, saving
+# horizontal space and making sure the option description isn't truncated.
+set -l color_opts '
+    auto\tdefault
+    never\t
+    always\t
+'
+set -l decorations_opts $color_opts
+set -l paging_opts $color_opts
+
+# Include some examples so we can indicate the default.
+set -l pager_opts '
+    less\tdefault
+    less\ -FR\t
+    more\t
+    vimpager\t
+'
+
+set -l italic_text_opts '
+    always\t
+    never\tdefault
+'
+
+set -l wrap_opts '
+    auto\tdefault
+    never\t
+    character\t
+'
+
+# While --tabs theoretically takes any number, most people should be OK with these.
+# Specifying a list lets us explain what 0 does.
+set -l tabs_opts '
+    0\tpass\ tabs\ through\ directly
+    1\t
+    2\t
+    4\t
+    8\t
+'
+
 # Completions:
 
-complete -c {{PROJECT_EXECUTABLE}} -l color -xka "auto never always" -d "Specify when to use colored output (default: auto)" -n "not __fish_seen_subcommand_from cache"
+complete -c $bat -l acknowledgements -d "Print acknowledgements" -n __fish_is_first_arg
 
-complete -c {{PROJECT_EXECUTABLE}} -l config-dir -d "Display location of '{{PROJECT_EXECUTABLE}}' configuration directory" -n "not __fish_seen_subcommand_from cache"
+complete -c $bat -l color -x -a "$color_opts" -d "When to use colored output" -n __bat_no_excl_args
 
-complete -c {{PROJECT_EXECUTABLE}} -l config-file -d "Display location of '{{PROJECT_EXECUTABLE}}' configuration file" -n "not __fish_seen_subcommand_from cache"
+complete -c $bat -l config-dir -f -d "Display location of configuration directory" -n __fish_is_first_arg
 
-complete -c {{PROJECT_EXECUTABLE}} -l decorations -xka "auto never always" -d "Specify when to use the decorations specified with '--style' (default: auto)" -n "not __fish_seen_subcommand_from cache"
+complete -c $bat -l config-file -f -d "Display location of configuration file" -n __fish_is_first_arg
 
-complete -c {{PROJECT_EXECUTABLE}} -s h -l help -d "Print help message" -n "not __fish_seen_subcommand_from cache"
+complete -c $bat -l decorations -x -a "$decorations_opts" -d "When to use --style decorations" -n __bat_no_excl_args
 
-complete -c {{PROJECT_EXECUTABLE}} -s H -l highlight-line -x -d "<N> Highlight the N-th line with a different background color" -n "not __fish_seen_subcommand_from cache"
+complete -c $bat -l diagnostic -d "Print diagnostic info for bug reports" -n __fish_is_first_arg
 
-complete -c {{PROJECT_EXECUTABLE}} -l italic-text -xka "always never" -d "Specify when to use ANSI sequences for italic text (default: never)" -n "not __fish_seen_subcommand_from cache"
+complete -c $bat -s d -l diff -d "Only show lines with Git changes" -n __bat_no_excl_args
 
-complete -c {{PROJECT_EXECUTABLE}} -s l -l language -d "Set the language for syntax highlighting" -n "not __fish_seen_subcommand_from cache" -xa "(__{{PROJECT_EXECUTABLE}}_autocomplete_languages)"
+complete -c $bat -l diff-context -x -d "Show N context lines around Git changes" -n "__fish_seen_argument -s d -l diff"
 
-complete -c {{PROJECT_EXECUTABLE}} -s r -l line-range -x -d "<N:M> Only print the specified range of lines for each file" -n "not __fish_seen_subcommand_from cache"
+complete -c $bat -l file-name -x -d "Specify the display name" -n __bat_no_excl_args
 
-complete -c {{PROJECT_EXECUTABLE}} -l list-languages -d "Display list of supported languages for syntax highlighting" -n "not __fish_seen_subcommand_from cache"
+complete -c $bat -s f -l force-colorization -d "Force color and decorations" -n __bat_no_excl_args
 
-complete -c {{PROJECT_EXECUTABLE}} -l list-themes -d "Display a list of supported themes for syntax highlighting" -n "not __fish_seen_subcommand_from cache"
+complete -c $bat -s h -d "Print a concise overview" -n __fish_is_first_arg
 
-complete -c {{PROJECT_EXECUTABLE}} -s m -l map-syntax -x -d "<from:to> Map a file extension or file name to an existing syntax" -n "not __fish_seen_subcommand_from cache"
+complete -c $bat -l help -f -d "Print all help information" -n __fish_is_first_arg
 
-complete -c {{PROJECT_EXECUTABLE}} -s n -l number -d "Only show line numbers, no other decorations. Alias for '--style=numbers'" -n "not __fish_seen_subcommand_from cache"
+complete -c $bat -s H -l highlight-line -x -d "Highlight line(s) N[:M]" -n __bat_no_excl_args
 
-complete -c {{PROJECT_EXECUTABLE}} -l pager -x -d "<command> Specify which pager program to use (default: less)" -n "not __fish_seen_subcommand_from cache"
+complete -c $bat -l ignored-suffix -x -d "Ignore extension" -n __bat_no_excl_args
 
-complete -c {{PROJECT_EXECUTABLE}} -l paging -xka "auto never always" -d "Specify when to use the pager (default: auto)" -n "not __fish_seen_subcommand_from cache"
+complete -c $bat -l italic-text -x -a "$italic_text_opts" -d "When to use italic text in the output" -n __bat_no_excl_args
 
-complete -c {{PROJECT_EXECUTABLE}} -s p -l plain -d "Only show plain style, no decorations. Alias for '--style=plain'" -n "not __fish_seen_subcommand_from cache"
+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 {{PROJECT_EXECUTABLE}} -s P -d "Disable paging. Alias for '--paging=never'" -n "not __fish_seen_subcommand_from cache"
+complete -c $bat -s r -l line-range -x -d "Only print lines [M]:[N] (either optional)" -n __bat_no_excl_args
 
-complete -c {{PROJECT_EXECUTABLE}} -s A -l show-all -d "Show non-printable characters like space/tab/newline" -n "not __fish_seen_subcommand_from cache"
+complete -c $bat -l list-languages -f -d "List syntax highlighting languages" -n __fish_is_first_arg
 
-complete -c {{PROJECT_EXECUTABLE}} -l style -xka "auto full plain changes header grid rule numbers snip" -d "Comma-separated list of style elements or presets to display with file contents" -n "not __fish_seen_subcommand_from cache"
+complete -c $bat -l list-themes -f -d "List syntax highlighting themes" -n __fish_is_first_arg
 
-complete -c {{PROJECT_EXECUTABLE}} -l tabs -x -d "<T> Set the tab width to T spaces (width of 0 passes tabs through directly)" -n "not __fish_seen_subcommand_from cache"
+complete -c $bat -s m -l map-syntax -x -a "(__bat_complete_map_syntax)" -d "Map <glob pattern>:<language syntax>" -n __bat_no_excl_args
 
-complete -c {{PROJECT_EXECUTABLE}} -l terminal-width -x -d "<width> Explicitly set terminal width; Prefix with '+' or '-' to offset (default width is auto determined)" -n "not __fish_seen_subcommand_from cache"
+complete -c $bat -s n -l number -d "Only show line numbers, no other decorations" -n __bat_no_excl_args
 
-complete -c {{PROJECT_EXECUTABLE}} -l theme -xka "({{PROJECT_EXECUTABLE}} --list-themes | cat)" -d "Set the theme for syntax highlighting" -n "not __fish_seen_subcommand_from cache"
+complete -c $bat -l pager -x -a "$pager_opts" -d "Which pager to use" -n __bat_no_excl_args
 
-complete -c {{PROJECT_EXECUTABLE}} -s u -l unbuffered -d "POSIX-compliant unbuffered output. Option is ignored" -n "not __fish_seen_subcommand_from cache"
+complete -c $bat -l paging -x -a "$paging_opts" -d "When to use the pager" -n __bat_no_excl_args
 
-complete -c {{PROJECT_EXECUTABLE}} -s V -l version -d "Show version information" -n "not __fish_seen_subcommand_from cache"
+complete -c $bat -s p -l plain -d "Disable decorations" -n __bat_no_excl_args
 
-complete -c {{PROJECT_EXECUTABLE}} -l wrap -xka "auto never character" -d "<mode> Specify the text-wrapping mode (default: auto)" -n "not __fish_seen_subcommand_from cache"
+complete -c $bat -o pp -d "Disable decorations and paging" -n __bat_no_excl_args
+
+complete -c $bat -s P -d "Disable paging" -n __bat_no_excl_args
+
+complete -c $bat -s A -l show-all -d "Show non-printable characters" -n __bat_no_excl_args
+
+complete -c $bat -l style -x -k -a "(__fish_complete_list , __bat_style_opts)" -d "Specify which non-content elements to display" -n __bat_no_excl_args
+
+complete -c $bat -l tabs -x -a "$tabs_opts" -d "Set tab width" -n __bat_no_excl_args
+
+complete -c $bat -l terminal-width -x -d "Set terminal <width>, +<offset>, or -<offset>" -n __bat_no_excl_args
+
+complete -c $bat -l theme -x -a "(command $bat --list-themes | command cat)" -d "Set the syntax highlighting theme" -n __bat_no_excl_args
+
+complete -c $bat -s V -l version -f -d "Show version information" -n __fish_is_first_arg
+
+complete -c $bat -l wrap -x -a "$wrap_opts" -d "Text-wrapping mode" -n __bat_no_excl_args
 
 # Sub-command 'cache' completions
-complete -c {{PROJECT_EXECUTABLE}} -a "cache" -d "Modify the syntax/language definition cache" -n "not __fish_seen_subcommand_from cache"
+## Completion of the 'cache' command itself is removed for better UX
+## See https://github.com/sharkdp/bat/issues/2085#issuecomment-1271646802
 
-complete -c {{PROJECT_EXECUTABLE}} -l build -f -d "Parse syntaxes/language definitions into cache" -n "__fish_seen_subcommand_from cache"
+complete -c $bat -l build -f -d "Parse new definitions into cache" -n __bat_cache_no_excl
 
-complete -c {{PROJECT_EXECUTABLE}} -l clear -f -d "Reset syntaxes/language definitions to default settings" -n "__fish_seen_subcommand_from cache"
+complete -c $bat -l clear -f -d "Reset definitions to defaults" -n __bat_cache_no_excl
+
+complete -c $bat -l blank -f -d "Create new data instead of appending" -n "__bat_cache_subcommand; and not __fish_seen_argument -l clear"
+
+complete -c $bat -l source -x -a "(__fish_complete_directories)" -d "Load syntaxes and themes from DIR" -n "__bat_cache_subcommand; and not __fish_seen_argument -l clear"
+
+complete -c $bat -l target -x -a "(__fish_complete_directories)" -d "Store cache in DIR" -n __bat_cache_subcommand
+
+complete -c $bat -l acknowledgements -d "Build acknowledgements.bin" -n __bat_cache_no_excl
+
+complete -c $bat -s h -d "Print a concise overview of $bat-cache help" -n __bat_cache_no_excl
+
+complete -c $bat -l help -f -d "Print all $bat-cache help" -n __bat_cache_no_excl
+
+# vim:ft=fish

assets/completions/bat.zsh.in

@@ -75,25 +75,19 @@ _{{PROJECT_EXECUTABLE}}_main() {
         ;;
 
         style)
-            _values -s , 'style' auto full plain changes header grid rule numbers snip
+            _values -s , 'style' default auto full plain changes header header-filename header-filesize grid rule numbers snip
         ;;
     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
+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
+esac

assets/manual/bat.1.in

@@ -25,11 +25,23 @@ 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
+.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
 \&'\-\-style=plain'. When '\-p' is used twice ('\-pp'), it also disables
-automatic paging (alias for '\-\-style=plain \fB\-\-pager\fR=\fI\,never\/\fR').
+automatic paging (alias for '\-\-style=plain \fB\-\-paging\fR=\fI\,never\/\fR').
 .HP
 \fB\-l\fR, \fB\-\-language\fR <language>
 .IP
@@ -146,7 +158,8 @@ Configure which elements (line numbers, file headers, grid borders, Git modifica
 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: *full*, auto, plain, changes, header, grid, rule, numbers, snip.
+values: *default*, full, auto, plain, changes, header, header-filename, header-filesize, grid,
+rule, numbers, snip.
 .HP
 \fB\-r\fR, \fB\-\-line\-range\fR <N:M>...
 .IP

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/Fstab.sublime-syntax

@@ -95,7 +95,7 @@ contexts:
 
   fstab_dump:
     - include: comment
-    - match: '\s*[01]\s*'
+    - match: '\s*[012]\s*'
       comment: dump field
       scope: constant.numeric
       set: fstab_pass
@@ -107,7 +107,7 @@ contexts:
 
   fstab_pass:
     - include: comment
-    - match: '\s*[01]\s*'
+    - match: '\s*[012]\s*'
       comment: pass field
       scope: constant.numeric
       set: expected_eol

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

@@ -5,8 +5,8 @@ name: INI
 file_extensions:
   - ini
   - INI
-  - inf
-  - INF
+  - "inf"
+  - "INF"
   - reg
   - REG
   - lng
@@ -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/TypeScript.sublime-syntax

@@ -4,6 +4,8 @@
 name: TypeScript
 file_extensions:
   - ts
+  - mts
+  - cts
 scope: source.ts
 contexts:
   main:

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/log.sublime-syntax

@@ -6,8 +6,16 @@ file_extensions:
 scope: text.log
 variables:
   ipv4_part: (?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)
+  hours_minutes_seconds: (?:[01]\d|2[0-3]):(?:[0-5]\d):(?:[0-5]\d)
+  error: \b(?i:fail(?:ure|ed)?|error|exception|fatal|critical)\b
+  warning: \b(?i:warn(?:ing)?)\b
+  info: \b(?i:info)\b
+  debug: \b(?i:debug)\b
 contexts:
   main:
+    - include: log_level_lines
+    - include: main_without_log_level_line
+  main_without_log_level_line:
     - match: (\w+)(=)
       captures:
         1: variable.parameter.log
@@ -17,31 +25,85 @@ contexts:
       captures:
         1: punctuation.definition.string.begin.log
         3: punctuation.definition.string.end.log
-    - match: (")([^"]*)(")
-      scope: string.quoted.double.log
+    - match: \"
       captures:
         1: punctuation.definition.string.begin.log
-        3: punctuation.definition.string.end.log
+      push: double_quoted_string
     - include: dates
     - include: ip_addresses
     - include: numbers
-    - match: \b(?i:fail(?:ure|ed)?|error|exception)\b
-      scope: markup.error.log
-    - match: \b(?i:warn(?:ing)?)\b
-      scope: markup.warning.log
+    - include: log_levels
     #- include: scope:text.html.markdown#autolink-inet
     - match: \b\w+:/{2,3}
       scope: markup.underline.link.scheme.log
       push: url-host
+  log_level_lines:
+    - match: ^(?=.*{{error}})
+      push:
+        - error_line
+        - main_pop_at_eol
+    - match: ^(?=.*{{warning}})
+      push:
+        - warning_line
+        - main_pop_at_eol
+    - match: ^(?=.*{{info}})
+      push:
+        - info_line
+        - main_pop_at_eol
+    - match: ^(?=.*{{debug}})
+      push:
+        - debug_line
+        - main_pop_at_eol
+  log_levels:
+    - match: '{{error}}'
+      scope: markup.error.log
+    - match: '{{warning}}'
+      scope: markup.warning.log
+    - match: '{{info}}'
+      scope: markup.info.log
+    - match: '{{debug}}'
+      scope: markup.info.log
+  error_line:
+    - meta_scope: meta.annotation.error-line.log
+    - include: immediately_pop
+  warning_line:
+    - meta_scope: meta.annotation.warning-line.log
+    - include: immediately_pop
+  info_line:
+    - meta_scope: meta.annotation.info-line.log
+    - include: immediately_pop
+  debug_line:
+    - meta_scope: meta.annotation.debug-line.log
+    - include: immediately_pop
+  immediately_pop:
+    - match: ''
+      pop: true
+  pop_at_eol:
+    - match: $
+      pop: true
+  main_pop_at_eol:
+    - include: main_without_log_level_line
+    - include: pop_at_eol
   dates:
-    - match: \b\d{4}-\d{2}-\d{2}\b
+    - match: \b\d{4}-\d{2}-\d{2}(?=\b|T)
       scope: meta.date.log meta.number.integer.decimal.log constant.numeric.value.log
-    - match: \b\d{4}/\d{2}/\d{2}\b
+      push: maybe_date_time_separator
+    - match: \b\d{4}/\d{2}/\d{2}(?=\b|T)
       scope: meta.date.log meta.number.integer.decimal.log constant.numeric.value.log
-    - match: \b(?:[01]\d|2[0-3]):(?:[0-5]\d):(?:[0-5]\d)(?:(\.)\d{3})?\b
+      push: maybe_date_time_separator
+    - match: \b(?={{hours_minutes_seconds}})
+      push: time
+  time:
+    - match: (?:{{hours_minutes_seconds}})(?:(\.)\d{3})?\b
       scope: meta.time.log meta.number.integer.decimal.log constant.numeric.value.log
       captures:
         1: punctuation.separator.decimal.log
+    - include: immediately_pop
+  maybe_date_time_separator:
+    - match: T(?={{hours_minutes_seconds}})
+      scope: meta.date.log meta.time.log keyword.other.log
+      set: time
+    - include: immediately_pop
   ip_addresses:
     - match: \b(?=(?:{{ipv4_part}}\.){3}{{ipv4_part}}\b)
       push:
@@ -50,8 +112,7 @@ contexts:
           scope: constant.numeric.value.log
         - match: \.
           scope: punctuation.separator.sequence.log
-        - match: ''
-          pop: true
+        - include: immediately_pop
     - match: (?=(?:\h{0,4}:){2,6}\h{1,4}\b)
       push:
         - meta_scope: meta.ipaddress.v6.log meta.number.integer.hexadecimal.log
@@ -59,8 +120,7 @@ contexts:
           scope: constant.numeric.value.log
         - match: ':'
           scope: punctuation.separator.sequence.log
-        - match: ''
-          pop: true
+        - include: immediately_pop
   numbers:
     - match: \b(0x)(\h+)(?:(\.)(\h+))?\b
       scope: meta.number.float.hexadecimal.log
@@ -112,5 +172,13 @@ contexts:
       pop: true
     - match: '[^?!.,:*_~\s<&()%]+|\S'
       scope: markup.underline.link.path.log
-    - match: ''
+    - include: immediately_pop
+  double_quoted_string:
+    - meta_scope: string.quoted.double.log
+    - match: \\"
+      scope: constant.character.escape.log
+    - match: \\n
+      scope: constant.character.escape.log
+    - match: \"
+      scope: punctuation.definition.string.end.log
       pop: true

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

doc/README-ja.md

@@ -181,12 +181,12 @@ man 2 select
 
 ## インストール
 
-[![Packaging status](https://repology.org/badge/vertical-allrepos/bat.svg)](https://repology.org/project/bat/versions)
+[![Packaging status](https://repology.org/badge/vertical-allrepos/bat-cat.svg)](https://repology.org/project/bat-cat/versions)
 
 ###  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.51 以上の環境が必要です。
+`bat` をソースからビルドしたいならば、Rust 1.64.0 以上の環境が必要です。
 `cargo` を使用してビルドすることができます:
 
 ```bash

doc/README-ko.md

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

doc/README-ru.md

@@ -160,7 +160,7 @@ man 2 select
 
 ## Установка
 
-[![Packaging status](https://repology.org/badge/vertical-allrepos/bat.svg)](https://repology.org/project/bat/versions)
+[![Packaging status](https://repology.org/badge/vertical-allrepos/bat-cat.svg)](https://repology.org/project/bat-cat/versions)
 
 ### Ubuntu (с помощью `apt`)
 *... и другие дистрибутивы основанные на Debian.*
@@ -344,7 +344,7 @@ ansible-galaxy install aeimer.install_bat
 
 ### Из исходников
 
-Если вы желаете установить `bat` из исходников, вам понадобится Rust 1.51 или выше. После этого используйте `cargo`, чтобы все скомпилировать:
+Если вы желаете установить `bat` из исходников, вам понадобится Rust 1.64.0 или выше. После этого используйте `cargo`, чтобы все скомпилировать:
 
 ```bash
 cargo install --locked bat

doc/README-zh.md

@@ -372,7 +372,7 @@ scoop install bat
 
 ### 从源码编译
 
-如果你想要自己构建`bat`，那么你需要安装有高于1.51版本的 Rust。
+如果你想要自己构建`bat`，那么你需要安装有高于1.64.0版本的 Rust。
 
 使用以下命令编译。
 
@@ -550,7 +550,7 @@ bat --generate-config-file
 # 在终端中以斜体输出文本（不是所有终端都支持）
 --italic-text=always
 
-# 使用 C++ 语法来给 Ardiuno 的 .ino 文件提供高亮
+# 使用 C++ 语法来给 Arduino 的 .ino 文件提供高亮
 --map-syntax "*.ino:C++"
 ```
 

doc/alternatives.md

@@ -4,17 +4,17 @@ The following table tries to give an overview *from `bat`s perspective*, i.e. we
 categories which are relevant for `bat`. Some of these projects have completely different goals and
 if you are not looking for a program like `bat`, this comparison might not be for you.
 
-|                                              | bat                                                                 | [pygments](http://pygments.org/) | [highlight](http://www.andre-simon.de/doku/highlight/highlight.php) | [ccat](https://github.com/jingweno/ccat) | [source-highlight](https://www.gnu.org/software/src-highlite/) | [hicat](https://github.com/rstacruz/hicat)          | [coderay](https://github.com/rubychan/coderay)      | [rouge](https://github.com/jneen/rouge)             |
-|----------------------------------------------|---------------------------------------------------------------------|----------------------------------|---------------------------------------------------------------------|------------------------------------------|----------------------------------------------------------------|-----------------------------------------------------|-----------------------------------------------------|-----------------------------------------------------|
-| Drop-in `cat` replacement                    | :heavy_check_mark: [*](https://github.com/sharkdp/bat/issues/134)   | :x:                              | :x:                                                                 | (:heavy_check_mark:)                     | :x:                                                            | :x: [*](https://github.com/rstacruz/hicat/issues/6) | :x:                                                 | :x:                                                 |
-| Git integration                              | :heavy_check_mark:                                                  | :x:                              | :x:                                                                 | :x:                                      | :x:                                                            | :x:                                                 | :x:                                                 | :x:                                                 |
-| Automatic paging                             | :heavy_check_mark:                                                  | :x:                              | :x:                                                                 | :x:                                      | :x:                                                            | :heavy_check_mark:                                  | :x:                                                 | :x:                                                 |
-| Languages (circa)                            | 150                                                                 | 300                              | 200                                                                 | 7                                        | 80                                                             | 130                                                 | 30                                                  | 130                                                 |
-| Extensible (languages, themes)               | :heavy_check_mark:                                                  | (:heavy_check_mark:)             | (:heavy_check_mark:)                                                | :x:                                      | (:heavy_check_mark:)                                           | :x:                                                 | :x:                                                 | :x:                                                 |
-| Advanced highlighting (e.g. nested syntaxes) | :heavy_check_mark:                                                  | :heavy_check_mark:               | (:heavy_check_mark:) ?                                              | :x:                                      | :heavy_check_mark:                                             | :heavy_check_mark:                                  | :heavy_check_mark:                                  | :heavy_check_mark:                                  |
-| Execution time [ms] (`jquery-3.3.1.js`)      | 624                                                                 | 789                              | 400                                                                 | 80                                       | 300                                                            | 316                                                 | 157                                                 | 695                                                 |
-| Execution time [ms] (`miniz.c`)              | 66                                                                  | 656                              | 26                                                                  | 8                                        | 53                                                             | 141                                                 | 75                                                  | 254                                                 |
-| Execution time [ms] (370 kB XML file)        | 238                                                                 | 487                              | 129                                                                 | 111                                      | 110                                                            | 339                                                 | 147                                                 | 359                                                 |
+|                                              | bat                                                                 | [pygments](http://pygments.org/) | [highlight](http://www.andre-simon.de/doku/highlight/highlight.php) | [ccat](https://github.com/jingweno/ccat) | [source-highlight](https://www.gnu.org/software/src-highlite/) | [hicat](https://github.com/rstacruz/hicat)          | [coderay](https://github.com/rubychan/coderay)      | [rouge](https://github.com/jneen/rouge)             | [clp](https://github.com/jpe90/clp)      |
+|----------------------------------------------|---------------------------------------------------------------------|----------------------------------|---------------------------------------------------------------------|------------------------------------------|----------------------------------------------------------------|-----------------------------------------------------|-----------------------------------------------------|-----------------------------------------------------|-----------------------------------------------------|
+| Drop-in `cat` replacement                    | :heavy_check_mark: [*](https://github.com/sharkdp/bat/issues/134)   | :x:                              | :x:                                                                 | (:heavy_check_mark:)                     | :x:                                                            | :x: [*](https://github.com/rstacruz/hicat/issues/6) | :x:                                                 | :x:                                                 | :x:                                                                 |
+| Git integration                              | :heavy_check_mark:                                                  | :x:                              | :x:                                                                 | :x:                                      | :x:                                                            | :x:                                                 | :x:                                                 | :x:                                                 | :x:                                                                 |
+| Automatic paging                             | :heavy_check_mark:                                                  | :x:                              | :x:                                                                 | :x:                                      | :x:                                                            | :heavy_check_mark:                                  | :x:                                                 | :x:                                                 | :x:                                                                 |
+| Languages (circa)                            | 150                                                                 | 300                              | 200                                                                 | 7                                        | 80                                                             | 130                                                 | 30                                                  | 130                                                 | 150                                                 |
+| Extensible (languages, themes)               | :heavy_check_mark:                                                  | (:heavy_check_mark:)             | (:heavy_check_mark:)                                                | :x:                                      | (:heavy_check_mark:)                                           | :x:                                                 | :x:                                                 | :x:                                                 | :heavy_check_mark:                                                 |
+| Advanced highlighting (e.g. nested syntaxes) | :heavy_check_mark:                                                  | :heavy_check_mark:               | (:heavy_check_mark:) ?                                              | :x:                                      | :heavy_check_mark:                                             | :heavy_check_mark:                                  | :heavy_check_mark:                                  | :heavy_check_mark:                                  | :heavy_check_mark:                                  |
+| Execution time [ms] (`jquery-3.3.1.js`)      | 422                                                                 | 455                              | 299                                                                 | 39                                       | 208                                                            | 287                                                 | 128                                                 | 740                                                 | 22                                          |
+| Execution time [ms] (`miniz.c`)              | 27                                                                  | 169                              | 19                                                                  | 4                                        | 36                                                             | 131                                                 | 58                                                  | 231                                                 | 4                                          |
+| Execution time [ms] (957 kB XML file)        | 215                                                                 | 296                              | 236                                                                 | 165                                      | 83                                                            | 412                                                 | 135                                                 | 386                                                 | 127                                          |
 
 If you think that some entries in this table are outdated or wrong, please open a ticket or pull
 request.
@@ -49,6 +49,7 @@ cmd_source_highlight="source-highlight --failsafe --infer-lang -f esc -i '$SRC'"
 cmd_hicat="hicat '$SRC'"
 cmd_coderay="coderay '$SRC'"
 cmd_rouge="rougify '$SRC'"
+cmd_clp="clp '$SRC'"
 
 hyperfine --warmup 3 \
     "$cmd_bat" \
@@ -60,4 +61,5 @@ hyperfine --warmup 3 \
     "$cmd_hicat" \
     "$cmd_coderay" \
     "$cmd_rouge" \
+    "$cmd_clp" \
 ```

doc/assets.md

@@ -77,12 +77,13 @@ 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
 
 ### 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_PAGER to an empty string. 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

@@ -1,38 +1,28 @@
 # Release checklist
 
-## Dependencies
-
-See this page for a good overview: https://deps.rs/repo/github/sharkdp/bat
-
-- [ ] Optional: update dependencies with `cargo update`. This is also done by
-      dependabot, so it is not strictly necessary.
-- [ ] Install [cargo-outdated](https://crates.io/crates/cargo-outdated). Check
-      for outdated dependencies with `cargo outdated --root-deps-only` and
-      decide for each of them whether we want to (manually) upgrade. This will
-      require changes to `Cargo.toml`.
-
 ## Version bump
 
 - [ ] 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 'rust.*1\.'` and
-      `git grep -i '1\..*rust'`.
+      `doc/README-*.md`. Check with
+      `git grep -i -e 'rust.*1\.' -e '1\..*rust' | grep README | grep -v tests/`.
 - [ ] Update `CHANGELOG.md`. Introduce a section for the new release.
 
 ## Update syntaxes and themes (build assets)
 
-- [ ] Install the latest master version (`cargo install -f --path .`) and make
+- [ ] Install the latest master version (`cargo clean && cargo install --locked -f --path .`) and make
       sure that it is available on the `PATH` (`bat --version` should show the
       new version).
 - [ ] Run `assets/create.sh` and check in the binary asset files.
 
 ## Documentation
 
-- [ ] Review the `-h` and `--help` texts
-- [ ] Review the `man` page
+- [ ] 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.
 
 ## Pre-release checks
 
@@ -41,13 +31,14 @@ See this page for a good overview: https://deps.rs/repo/github/sharkdp/bat
 - [ ] Optional: manually test the new features and command-line options. To do
       this, install the latest `bat` version again (to include the new syntaxes
       and themes).
-- [ ] Run `cargo publish --dry-run --allow-dirty` to make sure that it will
+- [ ] Run `cargo publish --dry-run` to make sure that it will
       succeed later (after creating the GitHub release).
 
 ## Release
 
 - [ ] Create a tag and push it: `git tag vX.Y.Z; git push origin tag vX.Y.Z`.
       This will trigger the deployment via GitHub Actions.
+      REMINDER: If your `origin` is a fork, don't forget to push to e.g. `upstream` instead!
 - [ ] Go to https://github.com/sharkdp/bat/releases/new to create the new
       release. Select the new tag and also use it as the release title. For the
       release notes, copy the corresponding section from `CHANGELOG.md` and
@@ -60,4 +51,23 @@ See this page for a good overview: https://deps.rs/repo/github/sharkdp/bat
 
 ## Post-release
 
-- [ ] Prepare a new (empty) "unreleased" section at the top of `CHANGELOG.md`.
+- [ ] Prepare a new "unreleased" section at the top of `CHANGELOG.md`.
+      Put this at the top:
+
+```
+# unreleased
+
+## Features
+
+## Bugfixes
+
+## Other
+
+## Syntaxes
+
+## Themes
+
+## `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

doc/sponsors.md

@@ -1,5 +1,7 @@
 ## Sponsors
 
+`bat` development is sponsored by many individuals and companies. Thank you very much!
+
 Please note, that being sponsored does not affect the individuality of the `bat`
 project or affect the maintainers' actions in any way.
 We remain impartial and continue to assess pull requests solely on merit - the

examples/list_syntaxes_and_themes.rs

@@ -1,4 +1,4 @@
-/// A simple program that prints its own source code using the bat library
+/// A simple program that lists all supported syntaxes and themes.
 use bat::PrettyPrinter;
 
 fn main() {

rustfmt.toml

@@ -0,0 +1 @@
+# Defaults are used

src/assets.rs

@@ -43,8 +43,9 @@ pub struct SyntaxReferenceInSet<'a> {
     pub syntax_set: &'a SyntaxSet,
 }
 
-/// Compress for size of ~700 kB instead of ~4600 kB at the cost of ~30% longer deserialization time
-pub(crate) const COMPRESS_SYNTAXES: bool = true;
+/// Lazy-loaded syntaxes are already compressed, and we don't want to compress
+/// already compressed data.
+pub(crate) const COMPRESS_SYNTAXES: bool = false;
 
 /// We don't want to compress our [LazyThemeSet] since the lazy-loaded themes
 /// within it are already compressed, and compressing another time just makes
@@ -68,10 +69,57 @@ impl HighlightingAssets {
         }
     }
 
+    /// The default theme.
+    ///
+    /// ### Windows and Linux
+    ///
+    /// Windows and most Linux distributions has a dark terminal theme by
+    /// default. On these platforms, this function always returns a theme that
+    /// looks good on a dark background.
+    ///
+    /// ### macOS
+    ///
+    /// On macOS the default terminal background is light, but it is common that
+    /// Dark Mode is active, which makes the terminal background dark. On this
+    /// 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`.
+    ///
+    /// See <https://github.com/sharkdp/bat/issues/1746> and
+    /// <https://github.com/sharkdp/bat/issues/1928> for more context.
     pub fn default_theme() -> &'static str {
+        #[cfg(not(target_os = "macos"))]
+        {
+            Self::default_dark_theme()
+        }
+        #[cfg(target_os = "macos")]
+        {
+            if macos_dark_mode_active() {
+                Self::default_dark_theme()
+            } else {
+                Self::default_light_theme()
+            }
+        }
+    }
+
+    /**
+     * The default theme that looks good on a dark background.
+     */
+    fn default_dark_theme() -> &'static str {
         "Monokai Extended"
     }
 
+    /**
+     * The default theme that looks good on a light background.
+     */
+    #[cfg(target_os = "macos")]
+    fn default_light_theme() -> &'static str {
+        "Monokai Extended Light"
+    }
+
     pub fn from_cache(cache_path: &Path) -> Result<Self> {
         Ok(HighlightingAssets::new(
             SerializedSyntaxSet::FromFile(cache_path.join("syntaxes.bin")),
@@ -351,6 +399,26 @@ fn asset_from_cache<T: serde::de::DeserializeOwned>(
         .map_err(|_| format!("Could not parse cached {}", description).into())
 }
 
+#[cfg(target_os = "macos")]
+fn macos_dark_mode_active() -> bool {
+    const PREFERENCES_FILE: &str = "Library/Preferences/.GlobalPreferences.plist";
+    const STYLE_KEY: &str = "AppleInterfaceStyle";
+
+    let preferences_file = dirs::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,
+    }
+}
+
 #[cfg(test)]
 mod tests {
     use super::*;
@@ -581,13 +649,22 @@ mod tests {
     }
 
     #[test]
-    fn syntax_detection_is_case_sensitive() {
+    fn syntax_detection_is_case_insensitive() {
         let mut test = SyntaxDetectionTest::new();
 
-        assert_ne!(test.syntax_for_file("README.MD"), "Markdown");
+        assert_eq!(test.syntax_for_file("README.md"), "Markdown");
+        assert_eq!(test.syntax_for_file("README.mD"), "Markdown");
+        assert_eq!(test.syntax_for_file("README.Md"), "Markdown");
+        assert_eq!(test.syntax_for_file("README.MD"), "Markdown");
+
+        // Adding a mapping for "MD" in addition to "md" should not break the mapping
         test.syntax_mapping
             .insert("*.MD", MappingTarget::MapTo("Markdown"))
             .ok();
+
+        assert_eq!(test.syntax_for_file("README.md"), "Markdown");
+        assert_eq!(test.syntax_for_file("README.mD"), "Markdown");
+        assert_eq!(test.syntax_for_file("README.Md"), "Markdown");
         assert_eq!(test.syntax_for_file("README.MD"), "Markdown");
     }
 

src/assets/assets_metadata.rs

@@ -7,7 +7,7 @@ use serde::{Deserialize, Serialize};
 
 use crate::error::*;
 
-#[derive(Debug, PartialEq, Default, Serialize, Deserialize)]
+#[derive(Debug, PartialEq, Eq, Default, Serialize, Deserialize)]
 pub struct AssetsMetadata {
     bat_version: Option<String>,
     creation_time: Option<SystemTime>,

src/assets/build_assets/acknowledgements.rs

@@ -1,3 +1,4 @@
+use std::fmt::Write;
 use std::fs::read_to_string;
 use std::path::{Path, PathBuf};
 
@@ -124,7 +125,7 @@ fn append_to_acknowledgements(
     relative_path: &str,
     license_text: &str,
 ) {
-    acknowledgements.push_str(&format!("## {}\n\n{}", relative_path, license_text));
+    write!(acknowledgements, "## {}\n\n{}", relative_path, license_text).ok();
 
     // Make sure the last char is a newline to not mess up formatting later
     if acknowledgements

src/bin/bat/app.rs

@@ -1,13 +1,12 @@
 use std::collections::HashSet;
 use std::env;
-use std::path::Path;
-use std::str::FromStr;
+use std::path::{Path, PathBuf};
 
 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 +21,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 {
@@ -32,14 +31,14 @@ fn is_truecolor_terminal() -> bool {
 }
 
 pub struct App {
-    pub matches: ArgMatches<'static>,
+    pub matches: ArgMatches,
     interactive_output: bool,
 }
 
 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);
 
@@ -49,21 +48,35 @@ impl App {
         })
     }
 
-    fn matches(interactive_output: bool) -> Result<ArgMatches<'static>> {
-        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
+    fn matches(interactive_output: bool) -> Result<ArgMatches> {
+        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());
 
@@ -79,13 +92,13 @@ impl App {
     pub fn config(&self, inputs: &[Input]) -> Result<Config> {
         let style_components = self.style_components()?;
 
-        let paging_mode = match self.matches.value_of("paging") {
+        let paging_mode = match self.matches.get_one::<String>("paging").map(|s| s.as_str()) {
             Some("always") => PagingMode::Always,
             Some("never") => PagingMode::Never,
             Some("auto") | None => {
                 // If we have -pp as an option when in auto mode, the pager should be disabled.
-                let extra_plain = self.matches.occurrences_of("plain") > 1;
-                if extra_plain || self.matches.is_present("no-paging") {
+                let extra_plain = self.matches.get_count("plain") > 1;
+                if extra_plain || self.matches.get_flag("no-paging") {
                     PagingMode::Never
                 } else if inputs.iter().any(Input::is_stdin) {
                     // If we are reading from stdin, only enable paging if we write to an
@@ -107,13 +120,13 @@ impl App {
 
         let mut syntax_mapping = SyntaxMapping::builtin();
 
-        if let Some(values) = self.matches.values_of("ignored-suffix") {
+        if let Some(values) = self.matches.get_many::<String>("ignored-suffix") {
             for suffix in values {
                 syntax_mapping.insert_ignored_suffix(suffix);
             }
         }
 
-        if let Some(values) = self.matches.values_of("map-syntax") {
+        if let Some(values) = self.matches.get_many::<String>("map-syntax") {
             for from_to in values {
                 let parts: Vec<_> = from_to.split(':').collect();
 
@@ -125,7 +138,10 @@ impl App {
             }
         }
 
-        let maybe_term_width = self.matches.value_of("terminal-width").and_then(|w| {
+        let maybe_term_width = self
+            .matches
+            .get_one::<String>("terminal-width")
+            .and_then(|w| {
                 if w.starts_with('+') || w.starts_with('-') {
                     // Treat argument as a delta to the current terminal width
                     w.parse().ok().map(|delta: i16| {
@@ -145,16 +161,30 @@ impl App {
 
         Ok(Config {
             true_color: is_truecolor_terminal(),
-            language: self.matches.value_of("language").or_else(|| {
-                if self.matches.is_present("show-all") {
+            language: self
+                .matches
+                .get_one::<String>("language")
+                .map(|s| s.as_str())
+                .or_else(|| {
+                    if self.matches.get_flag("show-all") {
                         Some("show-nonprintable")
                     } else {
                         None
                     }
                 }),
-            show_nonprintable: self.matches.is_present("show-all"),
+            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.value_of("wrap") {
+                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 => {
@@ -166,13 +196,16 @@ impl App {
                         }
                         _ => 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.
                 // There's no point in wrapping when this is the case.
                 WrappingMode::NoWrapping(false)
             },
-            colored_output: self.matches.is_present("force-colorization")
-                || match self.matches.value_of("color") {
+            colored_output: self.matches.get_flag("force-colorization")
+                || match self.matches.get_one::<String>("color").map(|s| s.as_str()) {
                     Some("always") => true,
                     Some("never") => false,
                     Some("auto") => env::var_os("NO_COLOR").is_none() && self.interactive_output,
@@ -181,14 +214,17 @@ impl App {
             paging_mode,
             term_width: maybe_term_width.unwrap_or(Term::stdout().size().1 as usize),
             loop_through: !(self.interactive_output
-                || self.matches.value_of("color") == Some("always")
-                || self.matches.value_of("decorations") == Some("always")
-                || self.matches.is_present("force-colorization")),
+                || self.matches.get_one::<String>("color").map(|s| s.as_str()) == Some("always")
+                || self
+                    .matches
+                    .get_one::<String>("decorations")
+                    .map(|s| s.as_str())
+                    == Some("always")
+                || self.matches.get_flag("force-colorization")),
             tab_width: self
                 .matches
-                .value_of("tabs")
+                .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 {
@@ -199,9 +235,8 @@ impl App {
                 ),
             theme: self
                 .matches
-                .value_of("theme")
+                .get_one::<String>("theme")
                 .map(String::from)
-                .or_else(|| env::var("BAT_THEME").ok())
                 .map(|s| {
                     if s == "default" {
                         String::from(HighlightingAssets::default_theme())
@@ -210,19 +245,21 @@ impl App {
                     }
                 })
                 .unwrap_or_else(|| String::from(HighlightingAssets::default_theme())),
-            visible_lines: match self.matches.is_present("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
-                        .value_of("diff-context")
+                        .get_one::<String>("diff-context")
                         .and_then(|t| t.parse().ok())
                         .unwrap_or(2),
                 ),
 
                 _ => VisibleLines::Ranges(
                     self.matches
-                        .values_of("line-range")
-                        .map(|vs| vs.map(LineRange::from).collect())
+                        .get_many::<String>("line-range")
+                        .map(|vs| vs.map(|s| LineRange::from(s.as_str())).collect())
                         .transpose()?
                         .map(LineRanges::from)
                         .unwrap_or_default(),
@@ -230,45 +267,47 @@ impl App {
             },
             style_components,
             syntax_mapping,
-            pager: self.matches.value_of("pager"),
-            use_italic_text: self.matches.value_of("italic-text") == Some("always"),
+            pager: self.matches.get_one::<String>("pager").map(|s| s.as_str()),
+            use_italic_text: self
+                .matches
+                .get_one::<String>("italic-text")
+                .map(|s| s.as_str())
+                == Some("always"),
             highlighted_lines: self
                 .matches
-                .values_of("highlight-line")
-                .map(|ws| ws.map(LineRange::from).collect())
+                .get_many::<String>("highlight-line")
+                .map(|ws| ws.map(|s| LineRange::from(s.as_str())).collect())
                 .transpose()?
                 .map(LineRanges::from)
                 .map(HighlightedLineRanges)
                 .unwrap_or_default(),
-            use_custom_assets: !self.matches.is_present("no-custom-assets"),
+            use_custom_assets: !self.matches.get_flag("no-custom-assets"),
         })
     }
 
     pub fn inputs(&self) -> Result<Vec<Input>> {
+        let filenames: Option<Vec<&Path>> = self
+            .matches
+            .get_many::<PathBuf>("file-name")
+            .map(|vs| vs.map(|p| p.as_path()).collect::<Vec<_>>());
+
+        let files: Option<Vec<&Path>> = self
+            .matches
+            .get_many::<PathBuf>("FILE")
+            .map(|vs| vs.map(|p| p.as_path()).collect::<Vec<_>>());
+
         // verify equal length of file-names and input FILEs
-        match self.matches.values_of("file-name") {
-            Some(ref filenames)
-                if self.matches.values_of_os("FILE").is_some()
-                    && filenames.len() != self.matches.values_of_os("FILE").unwrap().len() =>
+        if filenames.is_some()
+            && files.is_some()
+            && filenames.as_ref().map(|v| v.len()) != files.as_ref().map(|v| v.len())
         {
             return Err("Must be one file name per input type.".into());
         }
-            _ => {}
-        }
-        let filenames: Option<Vec<&Path>> = self
-            .matches
-            .values_of_os("file-name")
-            .map(|values| values.map(Path::new).collect());
 
         let mut filenames_or_none: Box<dyn Iterator<Item = Option<&Path>>> = match filenames {
             Some(filenames) => Box::new(filenames.into_iter().map(Some)),
             None => Box::new(std::iter::repeat(None)),
         };
-        let files: Option<Vec<&Path>> = self
-            .matches
-            .values_of_os("FILE")
-            .map(|vs| vs.map(Path::new).collect());
-
         if files.is_none() {
             return Ok(vec![new_stdin_input(
                 filenames_or_none.next().unwrap_or(None),
@@ -294,26 +333,16 @@ impl App {
 
     fn style_components(&self) -> Result<StyleComponents> {
         let matches = &self.matches;
-        let mut styled_components =
-            StyleComponents(if matches.value_of("decorations") == Some("never") {
+        let mut styled_components = StyleComponents(
+            if matches.get_one::<String>("decorations").map(|s| s.as_str()) == Some("never") {
                 HashSet::new()
-            } else if matches.is_present("number") {
+            } else if matches.get_flag("number") {
                 [StyleComponent::LineNumbers].iter().cloned().collect()
-            } else if matches.is_present("plain") {
+            } 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
-                    .value_of("style")
+                    .get_one::<String>("style")
                     .map(|styles| {
                         styles
                             .split(',')
@@ -321,15 +350,15 @@ impl App {
                             .filter_map(|style| style.ok())
                             .collect::<Vec<_>>()
                     })
-                    .or(env_style_components)
-                    .unwrap_or_else(|| vec![StyleComponent::Full])
+                    .unwrap_or_else(|| vec![StyleComponent::Default])
                     .into_iter()
                     .map(|style| style.components(self.interactive_output))
                     .fold(HashSet::new(), |mut acc, components| {
                         acc.extend(components.iter().cloned());
                         acc
                     })
-            });
+            },
+        );
 
         // If `grid` is set, remove `rule` as it is a subset of `grid`, and print a warning.
         if styled_components.grid() && styled_components.0.remove(&StyleComponent::Rule) {

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,7 +1,9 @@
-use clap::{crate_name, crate_version, App as ClapApp, AppSettings, Arg, ArgGroup, SubCommand};
+use clap::{
+    crate_name, crate_version, value_parser, Arg, ArgAction, ArgGroup, ColorChoice, Command,
+};
 use once_cell::sync::Lazy;
 use std::env;
-use std::path::Path;
+use std::path::{Path, PathBuf};
 
 static VERSION: Lazy<String> = Lazy::new(|| {
     #[cfg(feature = "bugreport")]
@@ -16,48 +18,39 @@ static VERSION: Lazy<String> = Lazy::new(|| {
     }
 });
 
-pub fn build_app(interactive_output: bool) -> ClapApp<'static, 'static> {
-    let clap_color_setting = if interactive_output && env::var_os("NO_COLOR").is_none() {
-        AppSettings::ColoredHelp
+pub fn build_app(interactive_output: bool) -> Command {
+    let color_when = if interactive_output && env::var_os("NO_COLOR").is_none() {
+        ColorChoice::Auto
     } else {
-        AppSettings::ColorNever
+        ColorChoice::Never
     };
 
-    let mut app = ClapApp::new(crate_name!())
+    let mut app = Command::new(crate_name!())
         .version(VERSION.as_str())
-        .global_setting(clap_color_setting)
-        .global_setting(AppSettings::DeriveDisplayOrder)
-        .global_setting(AppSettings::UnifiedHelpMessage)
-        .global_setting(AppSettings::HidePossibleValuesInHelp)
-        .setting(AppSettings::ArgsNegateSubcommands)
-        .setting(AppSettings::AllowExternalSubcommands)
-        .setting(AppSettings::DisableHelpSubcommand)
-        .setting(AppSettings::VersionlessSubcommands)
+        .color(color_when)
+        .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::with_name("FILE")
+            Arg::new("FILE")
                 .help("File(s) to print / concatenate. Use '-' for standard input.")
                 .long_help(
                     "File(s) to print / concatenate. Use a dash ('-') or no argument at all \
                      to read from standard input.",
                 )
-                .multiple(true)
-                .empty_values(false),
+                .num_args(1..)
+                .value_parser(value_parser!(PathBuf)),
         )
         .arg(
-            Arg::with_name("show-all")
+            Arg::new("show-all")
                 .long("show-all")
                 .alias("show-nonprintable")
-                .short("A")
+                .short('A')
+                .action(ArgAction::SetTrue)
                 .conflicts_with("language")
                 .help("Show non-printable characters (space, tab, newline, ..).")
                 .long_help(
@@ -67,22 +60,38 @@ pub fn build_app(interactive_output: bool) -> ClapApp<'static, 'static> {
                 ),
         )
         .arg(
-            Arg::with_name("plain")
+            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")
-                .short("p")
+                .short('p')
                 .long("plain")
-                .multiple(true)
+                .action(ArgAction::Count)
                 .help("Show plain style (alias for '--style=plain').")
                 .long_help(
                     "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 --pager=never').",
+                     automatic paging (alias for '--style=plain --paging=never').",
                 ),
         )
         .arg(
-            Arg::with_name("language")
-                .short("l")
+            Arg::new("language")
+                .short('l')
                 .long("language")
                 .overrides_with("language")
                 .help("Set the language for syntax highlighting.")
@@ -91,16 +100,13 @@ pub fn build_app(interactive_output: bool) -> ClapApp<'static, '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::with_name("highlight-line")
+            Arg::new("highlight-line")
                 .long("highlight-line")
-                .short("H")
-                .takes_value(true)
-                .number_of_values(1)
-                .multiple(true)
+                .short('H')
+                .action(ArgAction::Append)
                 .value_name("N:M")
                 .help("Highlight lines N through M.")
                 .long_help(
@@ -114,12 +120,11 @@ pub fn build_app(interactive_output: bool) -> ClapApp<'static, 'static> {
                 ),
         )
         .arg(
-            Arg::with_name("file-name")
+            Arg::new("file-name")
                 .long("file-name")
-                .takes_value(true)
-                .number_of_values(1)
-                .multiple(true)
+                .action(ArgAction::Append)
                 .value_name("name")
+                .value_parser(value_parser!(PathBuf))
                 .help("Specify the name to display for a file.")
                 .long_help(
                     "Specify the name to display for a file. Useful when piping \
@@ -133,9 +138,11 @@ pub fn build_app(interactive_output: bool) -> ClapApp<'static, 'static> {
     {
         app = app
                 .arg(
-                    Arg::with_name("diff")
+                    Arg::new("diff")
                         .long("diff")
-                        .short("d")
+                        .short('d')
+                        .action(ArgAction::SetTrue)
+                        .conflicts_with("line-range")
                         .help("Only show lines that have been added/removed/modified.")
                         .long_help(
                             "Only show lines that have been added/removed/modified with respect \
@@ -143,20 +150,19 @@ pub fn build_app(interactive_output: bool) -> ClapApp<'static, 'static> {
                         ),
                 )
                 .arg(
-                    Arg::with_name("diff-context")
+                    Arg::new("diff-context")
                         .long("diff-context")
                         .overrides_with("diff-context")
-                        .takes_value(true)
                         .value_name("N")
-                        .validator(
-                            |n| {
+                        .value_parser(
+                            |n: &str| {
                                 n.parse::<usize>()
                                     .map_err(|_| "must be a number")
-                                    .map(|_| ()) // Convert to Result<(), &str>
+                                    .map(|_| n.to_owned()) // Convert to Result<String, &str>
                                     .map_err(|e| e.to_string())
                             }, // Convert to Result<(), String>
                         )
-                        .hidden_short_help(true)
+                        .hide_short_help(true)
                         .long_help(
                             "Include N lines of context around added/removed/modified lines when using '--diff'.",
                         ),
@@ -164,16 +170,15 @@ pub fn build_app(interactive_output: bool) -> ClapApp<'static, 'static> {
     }
 
     app = app.arg(
-        Arg::with_name("tabs")
+        Arg::new("tabs")
             .long("tabs")
             .overrides_with("tabs")
-            .takes_value(true)
             .value_name("T")
-            .validator(
-                |t| {
+            .value_parser(
+                |t: &str| {
                     t.parse::<u32>()
                         .map_err(|_t| "must be a number")
-                        .map(|_t| ()) // Convert to Result<(), &str>
+                        .map(|_t| t.to_owned()) // Convert to Result<String, &str>
                         .map_err(|e| e.to_string())
                 }, // Convert to Result<(), String>
             )
@@ -184,12 +189,11 @@ pub fn build_app(interactive_output: bool) -> ClapApp<'static, 'static> {
             ),
     )
         .arg(
-            Arg::with_name("wrap")
+            Arg::new("wrap")
                 .long("wrap")
                 .overrides_with("wrap")
-                .takes_value(true)
                 .value_name("mode")
-                .possible_values(&["auto", "never", "character"])
+                .value_parser(["auto", "never", "character"])
                 .default_value("auto")
                 .hide_default_value(true)
                 .help("Specify the text-wrapping mode (*auto*, never, character).")
@@ -198,21 +202,27 @@ pub fn build_app(interactive_output: bool) -> ClapApp<'static, 'static> {
                            control the output width."),
         )
         .arg(
-            Arg::with_name("terminal-width")
+            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")
-                .hidden_short_help(true)
+                .hide_short_help(true)
                 .allow_hyphen_values(true)
-                .validator(
-                    |t| {
+                .value_parser(
+                    |t: &str| {
                         let is_offset = t.starts_with('+') || t.starts_with('-');
                         t.parse::<i32>()
                             .map_err(|_e| "must be an offset or number")
                             .and_then(|v| if v == 0 && !is_offset {
                                 Err("terminal width cannot be zero")
                             } else {
-                                Ok(())
+                                Ok(t.to_owned())
                             })
                             .map_err(|e| e.to_string())
                     })
@@ -223,10 +233,11 @@ pub fn build_app(interactive_output: bool) -> ClapApp<'static, 'static> {
                 ),
         )
         .arg(
-            Arg::with_name("number")
+            Arg::new("number")
                 .long("number")
                 .overrides_with("number")
-                .short("n")
+                .short('n')
+                .action(ArgAction::SetTrue)
                 .help("Show line numbers (alias for '--style=numbers').")
                 .long_help(
                     "Only show line numbers, no other decorations. This is an alias for \
@@ -234,12 +245,11 @@ pub fn build_app(interactive_output: bool) -> ClapApp<'static, 'static> {
                 ),
         )
         .arg(
-            Arg::with_name("color")
+            Arg::new("color")
                 .long("color")
                 .overrides_with("color")
-                .takes_value(true)
                 .value_name("when")
-                .possible_values(&["auto", "never", "always"])
+                .value_parser(["auto", "never", "always"])
                 .hide_default_value(true)
                 .default_value("auto")
                 .help("When to use colors (*auto*, never, always).")
@@ -251,23 +261,21 @@ pub fn build_app(interactive_output: bool) -> ClapApp<'static, 'static> {
                 ),
         )
         .arg(
-            Arg::with_name("italic-text")
+            Arg::new("italic-text")
                 .long("italic-text")
-                .takes_value(true)
                 .value_name("when")
-                .possible_values(&["always", "never"])
+                .value_parser(["always", "never"])
                 .default_value("never")
                 .hide_default_value(true)
                 .help("Use italics in output (always, *never*)")
                 .long_help("Specify when to use ANSI sequences for italic text in the output. Possible values: always, *never*."),
         )
         .arg(
-            Arg::with_name("decorations")
+            Arg::new("decorations")
                 .long("decorations")
                 .overrides_with("decorations")
-                .takes_value(true)
                 .value_name("when")
-                .possible_values(&["auto", "never", "always"])
+                .value_parser(["auto", "never", "always"])
                 .default_value("auto")
                 .hide_default_value(true)
                 .help("When to show the decorations (*auto*, never, always).")
@@ -278,24 +286,25 @@ pub fn build_app(interactive_output: bool) -> ClapApp<'static, 'static> {
                 ),
         )
         .arg(
-            Arg::with_name("force-colorization")
+            Arg::new("force-colorization")
                 .long("force-colorization")
-                .short("f")
+                .short('f')
+                .action(ArgAction::SetTrue)
                 .conflicts_with("color")
                 .conflicts_with("decorations")
                 .overrides_with("force-colorization")
-                .hidden_short_help(true)
+                .hide_short_help(true)
                 .long_help("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.")
         )
         .arg(
-            Arg::with_name("paging")
+            Arg::new("paging")
                 .long("paging")
                 .overrides_with("paging")
-                .takes_value(true)
+                .overrides_with("no-paging")
                 .value_name("when")
-                .possible_values(&["auto", "never", "always"])
+                .value_parser(["auto", "never", "always"])
                 .default_value("auto")
                 .hide_default_value(true)
                 .help("Specify when to use the pager, or use `-P` to disable (*auto*, never, always).")
@@ -307,22 +316,22 @@ pub fn build_app(interactive_output: bool) -> ClapApp<'static, 'static> {
                 ),
         )
         .arg(
-            Arg::with_name("no-paging")
-                .short("P")
+            Arg::new("no-paging")
+                .short('P')
                 .long("no-paging")
                 .alias("no-pager")
+                .action(ArgAction::SetTrue)
                 .overrides_with("no-paging")
-                .hidden(true)
-                .hidden_short_help(true)
+                .hide(true)
+                .hide_short_help(true)
                 .help("Alias for '--paging=never'")
             )
         .arg(
-            Arg::with_name("pager")
+            Arg::new("pager")
                 .long("pager")
                 .overrides_with("pager")
-                .takes_value(true)
                 .value_name("command")
-                .hidden_short_help(true)
+                .hide_short_help(true)
                 .help("Determine which pager to use.")
                 .long_help(
                     "Determine which pager is used. This option will override the \
@@ -332,12 +341,10 @@ pub fn build_app(interactive_output: bool) -> ClapApp<'static, 'static> {
                 ),
         )
         .arg(
-            Arg::with_name("map-syntax")
-                .short("m")
+            Arg::new("map-syntax")
+                .short('m')
                 .long("map-syntax")
-                .multiple(true)
-                .takes_value(true)
-                .number_of_values(1)
+                .action(ArgAction::Append)
                 .value_name("glob:syntax")
                 .help("Use the specified syntax for files matching the glob pattern ('*.cpp:C++').")
                 .long_help(
@@ -347,25 +354,21 @@ pub fn build_app(interactive_output: bool) -> ClapApp<'static, '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::with_name("ignored-suffix")
-                .number_of_values(1)
-                .multiple(true)
-                .takes_value(true)
+            Arg::new("ignored-suffix")
+                .action(ArgAction::Append)
                 .long("ignored-suffix")
-                .hidden_short_help(true)
+                .hide_short_help(true)
                 .help(
                     "Ignore extension. For example:\n  \
                     'bat --ignored-suffix \".dev\" my_file.json.dev' will use JSON syntax, and ignore '.dev'"
                 )
         )
         .arg(
-            Arg::with_name("theme")
+            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 \
@@ -376,28 +379,26 @@ pub fn build_app(interactive_output: bool) -> ClapApp<'static, 'static> {
                 ),
         )
         .arg(
-            Arg::with_name("list-themes")
+            Arg::new("list-themes")
                 .long("list-themes")
+                .action(ArgAction::SetTrue)
                 .help("Display all supported highlighting themes.")
                 .long_help("Display a list of supported themes for syntax highlighting."),
         )
         .arg(
-            Arg::with_name("style")
+            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_delimiter(false)
-                .takes_value(true)
                 .overrides_with("style")
                 .overrides_with("plain")
                 .overrides_with("number")
                 // Cannot use claps built in validation because we have to turn off clap's delimiters
-                .validator(|val| {
+                .value_parser(|val: &str| {
                     let mut invalid_vals = val.split(',').filter(|style| {
                         !&[
                             "auto",
                             "full",
+                            "default",
                             "plain",
                             "header",
                             "header-filename",
@@ -414,12 +415,12 @@ pub fn build_app(interactive_output: bool) -> ClapApp<'static, 'static> {
                     if let Some(invalid) = invalid_vals.next() {
                         Err(format!("Unknown style, '{}'", invalid))
                     } else {
-                        Ok(())
+                        Ok(val.to_owned())
                     }
                 })
                 .help(
                     "Comma-separated list of style elements to display \
-                     (*auto*, full, plain, changes, header, grid, rule, numbers, snip).",
+                     (*default*, auto, full, plain, changes, header, header-filename, header-filesize, grid, rule, numbers, snip).",
                 )
                 .long_help(
                     "Configure which elements (line numbers, file headers, grid \
@@ -430,8 +431,9 @@ pub fn build_app(interactive_output: bool) -> ClapApp<'static, 'static> {
                      '--style=\"..\"' option to the configuration file or export the \
                      BAT_STYLE environment variable (e.g.: export BAT_STYLE=\"..\").\n\n\
                      Possible values:\n\n  \
-                     * full: enables all available components (default).\n  \
-                     * auto: same as 'full', unless the output is piped.\n  \
+                     * default: enables recommended style components (default).\n  \
+                     * full: enables all available components.\n  \
+                     * auto: same as 'default', unless the output is piped.\n  \
                      * plain: disables all available components.\n  \
                      * changes: show Git modification markers.\n  \
                      * header: alias for 'header-filename'.\n  \
@@ -445,14 +447,11 @@ pub fn build_app(interactive_output: bool) -> ClapApp<'static, 'static> {
                 ),
         )
         .arg(
-            Arg::with_name("line-range")
+            Arg::new("line-range")
                 .long("line-range")
-                .short("r")
-                .multiple(true)
-                .takes_value(true)
-                .number_of_values(1)
+                .short('r')
+                .action(ArgAction::Append)
                 .value_name("N:M")
-                .conflicts_with("diff")
                 .help("Only print the lines from N to M.")
                 .long_help(
                     "Only print the specified range of lines for each file. \
@@ -465,18 +464,20 @@ pub fn build_app(interactive_output: bool) -> ClapApp<'static, 'static> {
                 ),
         )
         .arg(
-            Arg::with_name("list-languages")
+            Arg::new("list-languages")
                 .long("list-languages")
-                .short("L")
+                .short('L')
+                .action(ArgAction::SetTrue)
                 .conflicts_with("list-themes")
                 .help("Display all supported languages.")
                 .long_help("Display a list of supported languages for syntax highlighting."),
         )
         .arg(
-            Arg::with_name("unbuffered")
-                .short("u")
+            Arg::new("unbuffered")
+                .short('u')
                 .long("unbuffered")
-                .hidden_short_help(true)
+                .action(ArgAction::SetTrue)
+                .hide_short_help(true)
                 .long_help(
                     "This option exists for POSIX-compliance reasons ('u' is for \
                      'unbuffered'). The output is always unbuffered - this option \
@@ -484,60 +485,66 @@ pub fn build_app(interactive_output: bool) -> ClapApp<'static, 'static> {
                 ),
         )
         .arg(
-            Arg::with_name("no-config")
+            Arg::new("no-config")
                 .long("no-config")
-                .hidden(true)
+                .action(ArgAction::SetTrue)
+                .hide(true)
                 .help("Do not use the configuration file"),
         )
         .arg(
-            Arg::with_name("no-custom-assets")
+            Arg::new("no-custom-assets")
                 .long("no-custom-assets")
-                .hidden(true)
+                .action(ArgAction::SetTrue)
+                .hide(true)
                 .help("Do not load custom assets"),
         )
         .arg(
-            Arg::with_name("config-file")
+            Arg::new("config-file")
                 .long("config-file")
+                .action(ArgAction::SetTrue)
                 .conflicts_with("list-languages")
                 .conflicts_with("list-themes")
-                .hidden(true)
+                .hide(true)
                 .help("Show path to the configuration file."),
         )
         .arg(
-            Arg::with_name("generate-config-file")
+            Arg::new("generate-config-file")
                 .long("generate-config-file")
+                .action(ArgAction::SetTrue)
                 .conflicts_with("list-languages")
                 .conflicts_with("list-themes")
-                .hidden(true)
+                .hide(true)
                 .help("Generates a default configuration file."),
         )
         .arg(
-            Arg::with_name("config-dir")
+            Arg::new("config-dir")
                 .long("config-dir")
-                .hidden(true)
+                .action(ArgAction::SetTrue)
+                .hide(true)
                 .help("Show bat's configuration directory."),
         )
         .arg(
-            Arg::with_name("cache-dir")
+            Arg::new("cache-dir")
                 .long("cache-dir")
-                .hidden(true)
+                .action(ArgAction::SetTrue)
+                .hide(true)
                 .help("Show bat's cache directory."),
         )
         .arg(
-            Arg::with_name("diagnostic")
+            Arg::new("diagnostic")
                 .long("diagnostic")
                 .alias("diagnostics")
-                .hidden_short_help(true)
+                .action(ArgAction::SetTrue)
+                .hide_short_help(true)
                 .help("Show diagnostic information for bug reports.")
         )
         .arg(
-            Arg::with_name("acknowledgements")
+            Arg::new("acknowledgements")
                 .long("acknowledgements")
-                .hidden_short_help(true)
+                .action(ArgAction::SetTrue)
+                .hide_short_help(true)
                 .help("Show acknowledgements."),
-        )
-        .help_message("Print this help message.")
-        .version_message("Show version information.");
+        );
 
     // Check if the current directory contains a file name cache. Otherwise,
     // enable the 'bat cache' subcommand.
@@ -545,12 +552,14 @@ pub fn build_app(interactive_output: bool) -> ClapApp<'static, 'static> {
         app
     } else {
         app.subcommand(
-            SubCommand::with_name("cache")
+            Command::new("cache")
+                .hide(true)
                 .about("Modify the syntax-definition and theme cache")
                 .arg(
-                    Arg::with_name("build")
+                    Arg::new("build")
                         .long("build")
-                        .short("b")
+                        .short('b')
+                        .action(ArgAction::SetTrue)
                         .help("Initialize (or update) the syntax/theme cache.")
                         .long_help(
                             "Initialize (or update) the syntax/theme cache by loading from \
@@ -558,37 +567,37 @@ pub fn build_app(interactive_output: bool) -> ClapApp<'static, 'static> {
                         ),
                 )
                 .arg(
-                    Arg::with_name("clear")
+                    Arg::new("clear")
                         .long("clear")
-                        .short("c")
+                        .short('c')
+                        .action(ArgAction::SetTrue)
                         .help("Remove the cached syntax definitions and themes."),
                 )
                 .group(
-                    ArgGroup::with_name("cache-actions")
-                        .args(&["build", "clear"])
+                    ArgGroup::new("cache-actions")
+                        .args(["build", "clear"])
                         .required(true),
                 )
                 .arg(
-                    Arg::with_name("source")
+                    Arg::new("source")
                         .long("source")
                         .requires("build")
-                        .takes_value(true)
                         .value_name("dir")
                         .help("Use a different directory to load syntaxes and themes from."),
                 )
                 .arg(
-                    Arg::with_name("target")
+                    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.",
                         ),
                 )
                 .arg(
-                    Arg::with_name("blank")
+                    Arg::new("blank")
                         .long("blank")
+                        .action(ArgAction::SetTrue)
                         .requires("build")
                         .help(
                             "Create completely new syntax and theme sets \
@@ -596,11 +605,21 @@ pub fn build_app(interactive_output: bool) -> ClapApp<'static, 'static> {
                         ),
                 )
                 .arg(
-                    Arg::with_name("acknowledgements")
+                    Arg::new("acknowledgements")
                         .long("acknowledgements")
+                        .action(ArgAction::SetTrue)
                         .requires("build")
                         .help("Build acknowledgements.bin."),
                 ),
         )
+        .after_long_help(
+            "You can use 'bat cache' to customize syntaxes and themes. \
+            See 'bat cache --help' for more information",
+        )
     }
 }
+
+#[test]
+fn verify_app() {
+    build_app(false).debug_assert();
+}

src/bin/bat/config.rs

@@ -6,6 +6,22 @@ use std::path::PathBuf;
 
 use crate::directories::PROJECT_DIRS;
 
+#[cfg(not(target_os = "windows"))]
+const DEFAULT_SYSTEM_CONFIG_PREFIX: &str = "/etc";
+
+#[cfg(target_os = "windows")]
+const DEFAULT_SYSTEM_CONFIG_PREFIX: &str = "C:\\ProgramData";
+
+pub fn system_config_file() -> PathBuf {
+    let folder = option_env!("BAT_SYSTEM_CONFIG_PREFIX").unwrap_or(DEFAULT_SYSTEM_CONFIG_PREFIX);
+    let mut path = PathBuf::from(folder);
+
+    path.push("bat");
+    path.push("config");
+
+    path
+}
+
 pub fn config_file() -> PathBuf {
     env::var("BAT_CONFIG_PATH")
         .ok()
@@ -87,14 +103,21 @@ pub fn generate_config_file() -> bat::error::Result<()> {
 }
 
 pub fn get_args_from_config_file() -> Result<Vec<OsString>, shell_words::ParseError> {
-    Ok(fs::read_to_string(config_file())
-        .ok()
-        .map(|content| get_args_from_str(&content))
-        .transpose()?
-        .unwrap_or_else(Vec::new))
+    let mut config = String::new();
+
+    if let Ok(c) = fs::read_to_string(system_config_file()) {
+        config.push_str(&c);
+        config.push('\n');
+    }
+
+    if let Ok(c) = fs::read_to_string(config_file()) {
+        config.push_str(&c);
+    }
+
+    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))
 }
 
@@ -114,6 +137,20 @@ 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"),
+        ("--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

@@ -26,10 +26,10 @@ impl BatProjectDirs {
                 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")));
+                    .or_else(|| dirs::home_dir().map(|d| d.join(".config")));
 
                 #[cfg(not(target_os = "macos"))]
-                let config_dir_op = dirs_next::config_dir();
+                let config_dir_op = dirs::config_dir();
 
                 config_dir_op.map(|d| d.join("bat"))?
             };
@@ -51,10 +51,10 @@ impl BatProjectDirs {
         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")));
+            .or_else(|| dirs::home_dir().map(|d| d.join(".cache")));
 
         #[cfg(not(target_os = "macos"))]
-        let cache_dir_op = dirs_next::cache_dir();
+        let cache_dir_op = dirs::cache_dir();
 
         cache_dir_op.map(|d| d.join("bat"))
     }

src/bin/bat/main.rs

@@ -8,20 +8,24 @@ mod directories;
 mod input;
 
 use std::collections::{HashMap, HashSet};
+use std::fmt::Write as _;
 use std::io;
 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,
     config::{config_file, generate_config_file},
 };
 
-use assets::{assets_from_cache_or_binary, cache_dir, clear_assets, config_dir};
+#[cfg(feature = "bugreport")]
+use crate::config::system_config_file;
+
+use assets::{assets_from_cache_or_binary, clear_assets};
 use directories::PROJECT_DIRS;
 use globset::GlobMatcher;
 
@@ -37,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
-        .value_of("source")
+        .get_one::<String>("source")
         .map(Path::new)
-        .unwrap_or_else(|| PROJECT_DIRS.config_dir());
-    let target_dir = matches
-        .value_of("target")
-        .map(Path::new)
-        .unwrap_or_else(|| PROJECT_DIRS.cache_dir());
+        .unwrap_or_else(|| config_dir);
 
     bat::assets::build(
         source_dir,
-        !matches.is_present("blank"),
-        matches.is_present("acknowledgements"),
-        target_dir,
+        !matches.get_flag("blank"),
+        matches.get_flag("acknowledgements"),
+        cache_dir,
         clap::crate_version!(),
     )
 }
 
-fn run_cache_subcommand(matches: &clap::ArgMatches) -> Result<()> {
-    if matches.is_present("build") {
+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.is_present("clear") {
-        clear_assets();
+    } else if matches.get_flag("clear") {
+        clear_assets(cache_dir);
     }
 
     Ok(())
@@ -82,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()
@@ -125,7 +134,7 @@ pub fn get_languages(config: &Config) -> Result<String> {
 
     if config.loop_through {
         for lang in languages {
-            result += &format!("{}:{}\n", lang.name, lang.file_extensions.join(","));
+            writeln!(result, "{}:{}", lang.name, lang.file_extensions.join(",")).ok();
         }
     } else {
         let longest = languages
@@ -146,7 +155,7 @@ pub fn get_languages(config: &Config) -> Result<String> {
         };
 
         for lang in languages {
-            result += &format!("{:width$}{}", lang.name, separator, width = longest);
+            write!(result, "{:width$}{}", lang.name, separator, width = longest).ok();
 
             // Number of characters on this line so far, wrap before `desired_width`
             let mut num_chars = 0;
@@ -157,11 +166,11 @@ pub fn get_languages(config: &Config) -> Result<String> {
                 let new_chars = word.len() + comma_separator.len();
                 if num_chars + new_chars >= desired_width {
                     num_chars = 0;
-                    result += &format!("\n{:width$}{}", "", separator, width = longest);
+                    write!(result, "\n{:width$}{}", "", separator, width = longest).ok();
                 }
 
                 num_chars += new_chars;
-                result += &format!("{}", style.paint(&word[..]));
+                write!(result, "{}", style.paint(&word[..])).ok();
                 if extension.peek().is_some() {
                     result += comma_separator;
                 }
@@ -177,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);
@@ -207,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() {
@@ -218,18 +227,23 @@ 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)
 }
 
 #[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.value_of("pager"))
+    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 = cache_dir.to_path_buf();
+    custom_assets_metadata.push("metadata.yaml");
+
     let mut report = bugreport!()
         .info(SoftwareVersion::default())
         .info(OperatingSystem::default())
@@ -253,7 +267,13 @@ fn invoke_bugreport(app: &App) {
             "NO_COLOR",
             "MANPAGER",
         ]))
+        .info(FileContent::new("System Config file", system_config_file()))
         .info(FileContent::new("Config file", config_file()))
+        .info(FileContent::new(
+            "Custom assets metadata",
+            custom_assets_metadata,
+        ))
+        .info(DirectoryEntries::new("Custom assets", cache_dir))
         .info(CompileTimeInformation::default());
 
     #[cfg(feature = "paging")]
@@ -272,63 +292,70 @@ 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.is_present("diagnostic") {
+    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);
     }
 
     match app.matches.subcommand() {
-        ("cache", Some(cache_matches)) => {
+        Some(("cache", cache_matches)) => {
             // If there is a file named 'cache' in the current working directory,
             // 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.is_empty() {
-                run_cache_subcommand(cache_matches)?;
+            if cache_matches.args_present() {
+                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)
             }
         }
         _ => {
             let inputs = app.inputs()?;
             let config = app.config(&inputs)?;
 
-            if app.matches.is_present("list-languages") {
-                let languages: String = get_languages(&config)?;
+            if app.matches.get_flag("list-languages") {
+                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)
-            } else if app.matches.is_present("list-themes") {
-                list_themes(&config)?;
+                run_controller(inputs, &plain_config, cache_dir)
+            } else if app.matches.get_flag("list-themes") {
+                list_themes(&config, config_dir, cache_dir)?;
                 Ok(true)
-            } else if app.matches.is_present("config-file") {
+            } else if app.matches.get_flag("config-file") {
                 println!("{}", config_file().to_string_lossy());
                 Ok(true)
-            } else if app.matches.is_present("generate-config-file") {
+            } else if app.matches.get_flag("generate-config-file") {
                 generate_config_file()?;
                 Ok(true)
-            } else if app.matches.is_present("config-dir") {
-                writeln!(io::stdout(), "{}", config_dir())?;
+            } else if app.matches.get_flag("config-dir") {
+                writeln!(io::stdout(), "{}", config_dir.to_string_lossy())?;
                 Ok(true)
-            } else if app.matches.is_present("cache-dir") {
-                writeln!(io::stdout(), "{}", cache_dir())?;
+            } else if app.matches.get_flag("cache-dir") {
+                writeln!(io::stdout(), "{}", cache_dir.to_string_lossy())?;
                 Ok(true)
-            } else if app.matches.is_present("acknowledgements") {
+            } 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,
 

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

@@ -2,11 +2,14 @@ use std::io::Write;
 use thiserror::Error;
 
 #[derive(Error, Debug)]
+#[non_exhaustive]
 pub enum Error {
     #[error(transparent)]
     Io(#[from] ::std::io::Error),
     #[error(transparent)]
-    SyntectError(#[from] ::syntect::LoadingError),
+    SyntectError(#[from] ::syntect::Error),
+    #[error(transparent)]
+    SyntectLoadingError(#[from] ::syntect::LoadingError),
     #[error(transparent)]
     ParseIntError(#[from] ::std::num::ParseIntError),
     #[error(transparent)]
@@ -40,7 +43,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

@@ -118,7 +118,7 @@ impl OpenedInput<'_> {
         self.metadata
             .user_provided_name
             .as_ref()
-            .or_else(|| match self.kind {
+            .or(match self.kind {
                 OpenedInputKind::OrdinaryFile(ref path) => Some(path),
                 _ => None,
             })

src/less.rs

@@ -3,21 +3,38 @@
 use std::ffi::OsStr;
 use std::process::Command;
 
-pub fn retrieve_less_version(less_path: &dyn AsRef<OsStr>) -> Option<usize> {
+#[derive(Debug, PartialEq, Eq)]
+pub enum LessVersion {
+    Less(usize),
+    BusyBox,
+}
+
+pub fn retrieve_less_version(less_path: &dyn AsRef<OsStr>) -> Option<LessVersion> {
     let resolved_path = grep_cli::resolve_binary(less_path.as_ref()).ok()?;
 
     let cmd = Command::new(resolved_path).arg("--version").output().ok()?;
+    if cmd.status.success() {
         parse_less_version(&cmd.stdout)
+    } else {
+        parse_less_version_busybox(&cmd.stderr)
+    }
 }
 
-fn parse_less_version(output: &[u8]) -> Option<usize> {
+fn parse_less_version(output: &[u8]) -> Option<LessVersion> {
     if !output.starts_with(b"less ") {
         return None;
     }
 
     let version = std::str::from_utf8(&output[5..]).ok()?;
     let end = version.find(|c: char| !c.is_ascii_digit())?;
-    version[..end].parse::<usize>().ok()
+    Some(LessVersion::Less(version[..end].parse::<usize>().ok()?))
+}
+
+fn parse_less_version_busybox(output: &[u8]) -> Option<LessVersion> {
+    match std::str::from_utf8(output) {
+        Ok(version) if version.contains("BusyBox ") => Some(LessVersion::BusyBox),
+        _ => None,
+    }
 }
 
 #[test]
@@ -30,7 +47,7 @@ For information about the terms of redistribution,
 see the file named README in the less distribution.
 Homepage: http://www.greenwoodsoftware.com/less";
 
-    assert_eq!(Some(487), parse_less_version(output));
+    assert_eq!(Some(LessVersion::Less(487)), parse_less_version(output));
 }
 
 #[test]
@@ -43,7 +60,7 @@ For information about the terms of redistribution,
 see the file named README in the less distribution.
 Homepage: http://www.greenwoodsoftware.com/less";
 
-    assert_eq!(Some(529), parse_less_version(output));
+    assert_eq!(Some(LessVersion::Less(529)), parse_less_version(output));
 }
 
 #[test]
@@ -56,7 +73,7 @@ For information about the terms of redistribution,
 see the file named README in the less distribution.
 Home page: http://www.greenwoodsoftware.com/less";
 
-    assert_eq!(Some(551), parse_less_version(output));
+    assert_eq!(Some(LessVersion::Less(551)), parse_less_version(output));
 }
 
 #[test]
@@ -69,7 +86,7 @@ For information about the terms of redistribution,
 see the file named README in the less distribution.
 Home page: https://greenwoodsoftware.com/less";
 
-    assert_eq!(Some(581), parse_less_version(output));
+    assert_eq!(Some(LessVersion::Less(581)), parse_less_version(output));
 }
 
 #[test]
@@ -77,4 +94,38 @@ fn test_parse_less_version_wrong_program() {
     let output = b"more from util-linux 2.34";
 
     assert_eq!(None, parse_less_version(output));
+    assert_eq!(None, parse_less_version_busybox(output));
+}
+
+#[test]
+fn test_parse_less_version_busybox() {
+    let output = b"pkg/less: unrecognized option '--version'
+BusyBox v1.35.0 (2022-04-21 10:38:11 EDT) multi-call binary.
+
+Usage: less [-EFIMmNSRh~] [FILE]...
+
+View FILE (or stdin) one screenful at a time
+
+        -E      Quit once the end of a file is reached
+        -F      Quit if entire file fits on first screen
+        -I      Ignore case in all searches
+        -M,-m   Display status line with line numbers
+                and percentage through the file
+        -N      Prefix line number to each line
+        -S      Truncate long lines
+        -R      Remove color escape codes in input
+        -~      Suppress ~s displayed past EOF";
+
+    assert_eq!(
+        Some(LessVersion::BusyBox),
+        parse_less_version_busybox(output)
+    );
+}
+
+#[test]
+fn test_parse_less_version_invalid_utf_8() {
+    let output = b"\xff";
+
+    assert_eq!(None, parse_less_version(output));
+    assert_eq!(None, parse_less_version_busybox(output));
 }

src/lib.rs

@@ -35,6 +35,7 @@ pub mod error;
 pub mod input;
 mod less;
 pub mod line_range;
+pub(crate) mod nonprintable_notation;
 mod output;
 #[cfg(feature = "paging")]
 mod pager;
@@ -49,7 +50,8 @@ mod terminal;
 mod vscreen;
 pub(crate) mod wrapping;
 
-pub use pretty_printer::{Input, PrettyPrinter};
+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

@@ -168,7 +168,7 @@ fn test_parse_minus_fail() {
     assert!(range.is_err());
 }
 
-#[derive(Copy, Clone, Debug, PartialEq)]
+#[derive(Copy, Clone, Debug, PartialEq, Eq)]
 pub enum RangeCheckResult {
     // Within one of the given ranges
     InRange,

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

@@ -4,7 +4,7 @@ use std::process::Child;
 
 use crate::error::*;
 #[cfg(feature = "paging")]
-use crate::less::retrieve_less_version;
+use crate::less::{retrieve_less_version, LessVersion};
 #[cfg(feature = "paging")]
 use crate::paging::PagingMode;
 #[cfg(feature = "paging")]
@@ -83,13 +83,13 @@ impl OutputType {
             let replace_arguments_to_less = pager.source == PagerSource::EnvVarPager;
 
             if args.is_empty() || replace_arguments_to_less {
-                p.arg("--RAW-CONTROL-CHARS");
+                p.arg("-R"); // Short version of --RAW-CONTROL-CHARS for maximum compatibility
                 if single_screen_action == SingleScreenAction::Quit {
-                    p.arg("--quit-if-one-screen");
+                    p.arg("-F"); // Short version of --quit-if-one-screen for compatibility
                 }
 
                 if wrapping_mode == WrappingMode::NoWrapping(true) {
-                    p.arg("--chop-long-lines");
+                    p.arg("-S"); // Short version of --chop-long-lines for compatibility
                 }
 
                 // Passing '--no-init' fixes a bug with '--quit-if-one-screen' in older
@@ -103,7 +103,9 @@ impl OutputType {
                     None => {
                         p.arg("--no-init");
                     }
-                    Some(version) if (version < 530 || (cfg!(windows) && version < 558)) => {
+                    Some(LessVersion::Less(version))
+                        if (version < 530 || (cfg!(windows) && version < 558)) =>
+                    {
                         p.arg("--no-init");
                     }
                     _ => {}

src/pager.rs

@@ -40,15 +40,23 @@ impl PagerKind {
     fn from_bin(bin: &str) -> PagerKind {
         use std::path::Path;
 
-        match Path::new(bin)
-            .file_stem()
-            .map(|s| s.to_string_lossy())
-            .as_deref()
-        {
-            Some("bat") => PagerKind::Bat,
+        // Set to `less` by default on most Linux distros.
+        let pager_bin = Path::new(bin).file_stem();
+
+        // The name of the current running binary. Normally `bat` but sometimes
+        // `batcat` for compatibility reasons.
+        let current_bin = env::args_os().next();
+
+        // Check if the current running binary is set to be our pager.
+        let is_current_bin_pager = current_bin
+            .map(|s| Path::new(&s).file_stem() == pager_bin)
+            .unwrap_or(false);
+
+        match pager_bin.map(|s| s.to_string_lossy()).as_deref() {
             Some("less") => PagerKind::Less,
             Some("more") => PagerKind::More,
             Some("most") => PagerKind::Most,
+            _ if is_current_bin_pager => PagerKind::Bat,
             _ => PagerKind::Unknown,
         }
     }

src/paging.rs

@@ -1,12 +1,7 @@
-#[derive(Debug, Clone, Copy, PartialEq)]
+#[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,5 +1,9 @@
+use std::fmt::Write;
+
 use console::AnsiCodeIterator;
 
+use crate::nonprintable_notation::NonprintableNotation;
+
 /// Expand tabs like an ANSI-enabled expand(1).
 pub fn expand_tabs(line: &str, width: usize, cursor: &mut usize) -> String {
     let mut buffer = String::with_capacity(line.len() * 2);
@@ -18,7 +22,7 @@ pub fn expand_tabs(line: &str, width: usize, cursor: &mut usize) -> String {
                     // Add tab.
                     let spaces = width - (*cursor % width);
                     *cursor += spaces;
-                    buffer.push_str(&*" ".repeat(spaces));
+                    buffer.push_str(&" ".repeat(spaces));
 
                     // Next.
                     text = &text[index + 1..text.len()];
@@ -47,42 +51,71 @@ 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 };
 
     let mut idx = 0;
+    let mut line_idx = 0;
     let len = input.len();
     while idx < len {
         if let Some((chr, skip_ahead)) = try_parse_utf8_char(&input[idx..]) {
             idx += skip_ahead;
+            line_idx += 1;
 
             match chr {
                 // space
                 ' ' => output.push('·'),
                 // tab
                 '\t' => {
-                    if tab_width == 1 {
+                    let tab_stop = tab_width - ((line_idx - 1) % tab_width);
+                    line_idx = 0;
+                    if tab_stop == 1 {
                         output.push('↹');
                     } else {
                         output.push('├');
-                        output.push_str(&"─".repeat(tab_width - 2));
+                        output.push_str(&"─".repeat(tab_stop - 2));
                         output.push('┤');
                     }
                 }
                 // line feed
-                '\x0A' => output.push_str("␊\x0A"),
+                '\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()
@@ -94,7 +127,7 @@ pub fn replace_nonprintable(input: &[u8], tab_width: usize) -> String {
                 c => output.push_str(&c.escape_unicode().collect::<String>()),
             }
         } else {
-            output.push_str(&format!("\\x{:02X}", input[idx]));
+            write!(output, "\\x{:02X}", input[idx]).ok();
             idx += 1;
         }
     }

src/pretty_printer.rs

@@ -2,7 +2,6 @@ use std::io::Read;
 use std::path::Path;
 
 use console::Term;
-use syntect::parsing::SyntaxReference;
 
 use crate::{
     assets::HighlightingAssets,
@@ -11,7 +10,7 @@ use crate::{
     error::Result,
     input,
     line_range::{HighlightedLineRanges, LineRange, LineRanges},
-    style::{StyleComponent, StyleComponents},
+    style::StyleComponent,
     SyntaxMapping, WrappingMode,
 };
 
@@ -20,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,
@@ -28,6 +28,12 @@ struct ActiveStyleComponents {
     snip: bool,
 }
 
+#[non_exhaustive]
+pub struct Syntax {
+    pub name: String,
+    pub file_extensions: Vec<String>,
+}
+
 pub struct PrettyPrinter<'a> {
     inputs: Vec<Input<'a>>,
     config: Config<'a>,
@@ -134,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
     }
 
@@ -164,6 +170,12 @@ impl<'a> PrettyPrinter<'a> {
         self
     }
 
+    /// Whether to print binary content or nonprintable characters (default: no)
+    pub fn show_nonprintable(&mut self, yes: bool) -> &mut Self {
+        self.config.show_nonprintable = yes;
+        self
+    }
+
     /// Whether to show "snip" markers between visible line ranges (default: no)
     pub fn snip(&mut self, yes: bool) -> &mut Self {
         self.active_style_components.snip = yes;
@@ -234,47 +246,57 @@ impl<'a> PrettyPrinter<'a> {
         self.assets.themes()
     }
 
-    pub fn syntaxes(&self) -> impl Iterator<Item = &SyntaxReference> {
+    pub fn syntaxes(&self) -> impl Iterator<Item = Syntax> + '_ {
         // We always use assets from the binary, which are guaranteed to always
         // be valid, so get_syntaxes() can never fail here
-        self.assets.get_syntaxes().unwrap().iter()
+        self.assets
+            .get_syntaxes()
+            .unwrap()
+            .iter()
+            .filter(|s| !s.hidden)
+            .map(|s| Syntax {
+                name: s.name.clone(),
+                file_extensions: s.file_extensions.clone(),
+            })
     }
 
     /// Pretty-print all specified inputs. This method will "use" all stored inputs.
     /// If you want to call 'print' multiple times, you have to call the appropriate
     /// input_* methods again.
     pub fn print(&mut self) -> Result<bool> {
-        self.config.highlighted_lines =
-            HighlightedLineRanges(LineRanges::from(self.highlighted_lines.clone()));
+        let highlight_lines = std::mem::take(&mut self.highlighted_lines);
+        self.config.highlighted_lines = HighlightedLineRanges(LineRanges::from(highlight_lines));
         self.config.term_width = self
             .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);
         }
-        if self.active_style_components.vcs_modification_markers {
         #[cfg(feature = "git")]
-            style_components.push(StyleComponent::Changes);
+        if self.active_style_components.vcs_modification_markers {
+            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);

src/printer.rs

@@ -1,8 +1,8 @@
 use std::io::Write;
 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;
 
@@ -93,7 +93,11 @@ impl<'a> Printer for SimplePrinter<'a> {
     ) -> 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)?
@@ -422,9 +426,13 @@ impl<'a> Printer for InteractivePrinter<'a> {
         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,
+            )
         } else {
-            match self.content_type {
+            let line = match self.content_type {
                 Some(ContentType::BINARY) | None => {
                     return Ok(());
                 }
@@ -435,6 +443,15 @@ impl<'a> Printer for InteractivePrinter<'a> {
                     .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,
+                }
+            } else {
+                line
             }
         };
 
@@ -445,9 +462,21 @@ impl<'a> Printer for InteractivePrinter<'a> {
                     return Ok(());
                 }
             };
-            highlighter_from_set
+
+            // skip syntax highlighting on long lines
+            let too_long = line.len() > 1024 * 16;
+
+            let for_highlighting: &str = if too_long { "\n" } else { &line };
+
+            let mut highlighted_line = highlighter_from_set
                 .highlighter
-                .highlight(&line, highlighter_from_set.syntax_set)
+                .highlight_line(for_highlighting, highlighter_from_set.syntax_set)?;
+
+            if too_long {
+                highlighted_line[0].1 = &line;
+            }
+
+            highlighted_line
         };
 
         if out_of_range {
@@ -463,6 +492,10 @@ impl<'a> Printer for InteractivePrinter<'a> {
         let highlight_this_line =
             self.config.highlighted_lines.0.check(line_number) == RangeCheckResult::InRange;
 
+        if highlight_this_line && self.config.theme == "ansi" {
+            self.ansi_style.update("^[4m");
+        }
+
         let background_color = self
             .background_color_highlight
             .filter(|_| highlight_this_line);
@@ -596,7 +629,7 @@ impl<'a> Printer for InteractivePrinter<'a> {
                                         "{}\n{}",
                                         as_terminal_escaped(
                                             style,
-                                            &*format!("{}{}", self.ansi_style, line_buf),
+                                            &format!("{}{}", self.ansi_style, line_buf),
                                             self.config.true_color,
                                             self.config.colored_output,
                                             self.config.use_italic_text,
@@ -622,7 +655,7 @@ impl<'a> Printer for InteractivePrinter<'a> {
                                 "{}",
                                 as_terminal_escaped(
                                     style,
-                                    &*format!("{}{}", self.ansi_style, line_buf),
+                                    &format!("{}{}", self.ansi_style, line_buf),
                                     self.config.true_color,
                                     self.config.colored_output,
                                     self.config.use_italic_text,
@@ -649,6 +682,11 @@ impl<'a> Printer for InteractivePrinter<'a> {
             writeln!(handle)?;
         }
 
+        if highlight_this_line && self.config.theme == "ansi" {
+            self.ansi_style.update("^[24m");
+            write!(handle, "\x1B[24m")?;
+        }
+
         Ok(())
     }
 }

src/style.rs

@@ -17,6 +17,7 @@ pub enum StyleComponent {
     LineNumbers,
     Snip,
     Full,
+    Default,
     Plain,
 }
 
@@ -25,7 +26,7 @@ impl StyleComponent {
         match self {
             StyleComponent::Auto => {
                 if interactive_terminal {
-                    StyleComponent::Full.components(interactive_terminal)
+                    StyleComponent::Default.components(interactive_terminal)
                 } else {
                     StyleComponent::Plain.components(interactive_terminal)
                 }
@@ -48,6 +49,14 @@ impl StyleComponent {
                 StyleComponent::LineNumbers,
                 StyleComponent::Snip,
             ],
+            StyleComponent::Default => &[
+                #[cfg(feature = "git")]
+                StyleComponent::Changes,
+                StyleComponent::Grid,
+                StyleComponent::HeaderFilename,
+                StyleComponent::LineNumbers,
+                StyleComponent::Snip,
+            ],
             StyleComponent::Plain => &[],
         }
     }
@@ -69,6 +78,7 @@ impl FromStr for StyleComponent {
             "numbers" => Ok(StyleComponent::LineNumbers),
             "snip" => Ok(StyleComponent::Snip),
             "full" => Ok(StyleComponent::Full),
+            "default" => Ok(StyleComponent::Default),
             "plain" => Ok(StyleComponent::Plain),
             _ => Err(format!("Unknown style '{}'", s).into()),
         }
@@ -119,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

@@ -7,7 +7,7 @@ use globset::{Candidate, GlobBuilder, GlobMatcher};
 
 pub mod ignored_suffixes;
 
-#[derive(Debug, Clone, Copy, PartialEq)]
+#[derive(Debug, Clone, Copy, PartialEq, Eq)]
 #[non_exhaustive]
 pub enum MappingTarget<'a> {
     /// For mapping a path to a specific syntax.
@@ -41,6 +41,9 @@ impl<'a> SyntaxMapping<'a> {
     pub fn builtin() -> SyntaxMapping<'a> {
         let mut mapping = Self::empty();
         mapping.insert("*.h", MappingTarget::MapTo("C++")).unwrap();
+        mapping
+            .insert(".clang-format", MappingTarget::MapTo("YAML"))
+            .unwrap();
         mapping.insert("*.fs", MappingTarget::MapTo("F#")).unwrap();
         mapping
             .insert("build", MappingTarget::MapToUnknown)
@@ -63,6 +66,14 @@ impl<'a> SyntaxMapping<'a> {
         mapping
             .insert("*.pac", MappingTarget::MapTo("JavaScript (Babel)"))
             .unwrap();
+        mapping
+            .insert("fish_history", MappingTarget::MapTo("YAML"))
+            .unwrap();
+
+        // See #2151, https://nmap.org/book/nse-language.html
+        mapping
+            .insert("*.nse", MappingTarget::MapTo("Lua"))
+            .unwrap();
 
         // See #1008
         mapping
@@ -117,13 +128,32 @@ impl<'a> SyntaxMapping<'a> {
             mapping.insert(glob, MappingTarget::MapTo("INI")).unwrap();
         }
 
+        // unix mail spool
+        for glob in &["/var/spool/mail/*", "/var/mail/*"] {
+            mapping.insert(glob, MappingTarget::MapTo("Email")).unwrap()
+        }
+
         // pacman hooks
         mapping
             .insert("*.hook", MappingTarget::MapTo("INI"))
             .unwrap();
 
-        if let Some(xdg_config_home) = std::env::var_os("XDG_CONFIG_HOME") {
-            let git_config_path = Path::new(&xdg_config_home).join("git");
+        // 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);
+        }
+
+        fn insert_git_config_global(mapping: &mut SyntaxMapping, config_home: impl AsRef<Path>) {
+            let git_config_path = config_home.as_ref().join("git");
 
             mapping
                 .insert(
@@ -164,6 +194,7 @@ impl<'a> SyntaxMapping<'a> {
     }
 
     pub(crate) fn get_syntax_for(&self, path: impl AsRef<Path>) -> Option<MappingTarget<'a>> {
+        // Try matching on the file name as-is.
         let candidate = Candidate::new(&path);
         let candidate_filename = path.as_ref().file_name().map(Candidate::new);
         for (ref glob, ref syntax) in self.mappings.iter().rev() {
@@ -175,7 +206,13 @@ impl<'a> SyntaxMapping<'a> {
                 return Some(*syntax);
             }
         }
-        None
+        // Try matching on the file name after removing an ignored suffix.
+        let file_name = path.as_ref().file_name()?;
+        self.ignored_suffixes
+            .try_with_stripped_suffix(file_name, |stripped_file_name| {
+                Ok(self.get_syntax_for(stripped_file_name))
+            })
+            .ok()?
     }
 
     pub fn insert_ignored_suffix(&mut self, suffix: &'a str) {

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,

tests/examples/bat-tabs.conf

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

tests/examples/bat-theme.conf

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

tests/examples/bat.conf

@@ -1,5 +1,5 @@
 # Make sure that the pager gets executed
 --paging=always
 
-# Output a dummy message for the integration test.
+# Output a dummy message for the integration test and system wide config test.
 --pager="echo 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/git/.config/git/config

@@ -0,0 +1,3 @@
+[user]
+    email = foo@bar.net
+    name = foobar

tests/examples/git/.gitconfig

@@ -0,0 +1,3 @@
+[user]
+    email = foo@bar.net
+    name = foobar

tests/examples/long-single-line.txt

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

tests/examples/system_config/bat/config

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

tests/examples/test.demo.foo.suffix

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

tests/examples/test.demo.suffix

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