sharkdp / bat

Bugfixes

• Mouse support and screen clearing broken for less versions with minor version number (581.2), see #1629 and #1639 (@aswild)

Other

• Input::ordinary_file and Input::with_name now accept Path rather than OsStr see #1571 (@matklad)
• The LESS environment variable is now included in bat --diagnostic, see #1589 (@Enselic)
• Increased min. required Rust version to 1.45

Syntaxes

• Improved the Syslog syntax highlighting, see #1606 (@keith-hall)
• Replaced "Advanced CSV" with a custom CSV syntax definition written especially for bat; see #1574 (@keith-hall)
• Added SystemVerilog file syntax, see #1580 (@SeanMcLoughlin)
• Added Solidity and Vyper syntax, see #1602 (@Ersikan)

New themes

• Dark+ VS Code theme, see #1588 and #1598 (@PatriotRossii)

Features

• Use a pager when bat --list-languages is called, see #1394 (@stku1985)

Bugfixes

• If the last line doesn't end with a newline character, don't add it if --style=plain, see #1438 (@Enselic)
• Only print themes hint in interactive mode (bat --list-themes), see #1439 (@rsteube)
• Make ./tests/syntax-tests/regression_test.sh work on recent versions of macOS, see #1443 (@Enselic)
• VimL syntax highlighting fix, see #1450 (@esensar)
• Print an 'Invalid syntax theme settings' error message if a custom theme is broken, see #614 (@Enselic)
• If plain mode is set and wrap is not explicitly opted in, long lines will no be truncated, see #1426
• If PAGER (but not BAT_PAGER or --pager) is more or most, silently use less instead to ensure support for colors, see #1063 (@Enselic)
• If PAGER is bat, silently use less to prevent recursion. For BAT_PAGER or --pager, exit with error, see #1413 (@Enselic)
• Manpage highlighting fix, see #1511 (@keith-hall)
• BAT_CONFIG_PATH ignored by bat if non-existent, see #1550 (@sharkdp)

Other

• Performance improvements, see #1421 (@LovecraftianHorror)
• Added a new --diagnostic option to collect information for bug reports, see #1459 (@sharkdp)
• Modified default theme colors to differentiate between a JSON key and a string value, see #1400 (@keith-hall)
• Upped min required Rust version to 1.42

Syntaxes

• Added Zig syntax, see #1470 (@paulsmith)
• Added Lean syntax, see #1446 (@Julian)
• Added .resource extension for Robot Framework files, see #1386
• Added gnuplot syntax, see #1431 (@sharkdp)
• Highlight *.pac (Proxy auto-config) files as JavaScript, see #1515 (@sharkdp)

New themes

• ansi replaces ansi-dark and ansi-light, see #1104 and #1412 (@mk12). Breaking change: users that were previously using one of the ansi-* themes should switch to ansi.
• The Gruvbox theme has been updated, see #1291 (@j0hnmeow). Breaking change: users that were previously using gruvbox or gruvbox-white should update and use gruvbox-dark/gruvbox-light instead.

bat as a library

• The following PrettyPrinter methods have been removed (they were previously deprecated):
  • input_stdin_with_name
  • input_from_bytes_with_name
  • input_from_reader_with_name
  • vcs_modification_markers (if the git feature is not enabled)

Bugfixes

• Running bat without arguments fails ("output file is also an input"), see #1396

Features

• Added a new --style value, rule, which adds a simple horizontal ruled line between files, see #1276 (@tommilligan)
• Pass -S ("chop long lines") to less if --wrap=never is set in bat, see #1255 (@gahag)

Bugfixes

• Detect infinite loop when input and output are the same, see #1193 and #1197 (@niklasmohrin)
• Throw an error when bat is being used as pager, see #1343 (@adrian-rivera)
• Bash syntax highlighting not selected for *.ebuild and *.eclass files, see #1292 (@sharkdp)
• Fix zsh completion when using -p, see #1320 (@xzfc)

Other

• Add note to refer to see detailed help with --help (and vice versa with -h), see #1215 (@henil)
• Add a Contributors section to README, see #1348 (@adrian-rivera)

Syntaxes

• Manpage syntax highlighting has been improved, see #1315 (@keith-hall)
• Add Svelte file syntax, see #1285 (@kjmph)

New themes

• Coldark, see #1329 (@ArmandPhilippot)

Features

• Added support for the NO_COLOR environment variable, see #1021 and #1031 (@eth-p)
• Added -P short flag to disable paging, see #1075 and #1082 (@LordFlashmeow)
• Added --force-colorization/-f flag to provide an alias for forced color and decoration output, see #1141 (@alexanderkarlis)

Bugfixes

• Fixed non-printable characters display for redirected output, see #1061 (@gsomix)
• Handle file extension conflicts in --list-languages, see #1076 and #1135 (@Kienyew)

Other

• Switched to "·" (U+00B7) Middle Dot from "•" (U+2022) Bullet for non-printing spaces, see #1056 and #1100 (@LordFlashmeow)
• Added zsh shell completion script, see #1136 (@Kienyew)
• Improved --help text (@sharkdp)
• Added custom languages/themes sections to manpage (@eth-p)

Syntaxes

• Update AsciiDoc syntax, see #1034 (@rxt1077)
• GLSL (@caioalonso)
• Add Nginx and Apache config file syntax, see #1137 (@kjmph, @niklasmohrin)
• Use fstab syntax for crypttab files, see #1073 (@sharkdp)
• Support syntax highlighting for files in $XDG_CONFIG_HOME/git/, see #1191 (@ahmedelgabri)

New themes

• Gruvbox, see #1069 (@KyleOndy)
• base16-256 for base16-shell users, see #1111 (@mk12)

bat as a library

• Add APIs to provide Input descriptions with InputDescription (@eth-p)
• Add function to directly provide Inputs to PrettyPrinter (@eth-p)
• Breaking: Input::theme_preview_file is no longer available. (@eth-p)

Packaging

• Package maintainers: note that we now include zsh shell completion files
• Removed build dependency on liquid (@sharkdp).

Thanks

Special thanks to @rivy for porting our CI/CD workflows to Github Actions. Also, many thanks to @Kienyew and @eth-p for major contributions!

Bugfixes

• Added missing Solarized themes, see #1027
• Fixed highlighting bug in Haskell source files, see #1026

Bugfixes

• Cannot run bat with relative paths, see #1022
• bat mishighlights Users that start with digits in SSH config, see #984

New syntaxes

• SML, see #1005 (@kopecs)

Other

• Some syntaxes and themes have been updated to the latest version

Warning: this release suffers from #1022. bat will panic when called with a relative file path.

Bugfixes

• --map-syntax doesn't work with names provided through --file-name (@eth-p)
• Fix syntax detection for files called 'rails', see #1008
• Fix potential errors with syntax detection for symlinked files, see #1001

Other

• Add padding above headers when not using a grid, see #968 and #981 (@pt2121)
• bat now prints an error if an invalid syntax is specified via -l or --map-syntax, see #1004 (@eth-p)

bat as a library

• PrettyPrinter::vcs_modification_markers has been marked deprecated when building without the git feature, see #997 and #1020 (@eth-p, @sharkdp)

Packaging

• Compilation problems with onig_sys on various platforms have been resolved by upgrading to syntect 4.2, which includes a new onig version that allows to build onig_sys without the bindgen dependency. This removes the need for libclang(-dev) to be installed to compile bat. Package maintainers might want to remove clang as a build dependency. See #650 for more details.

Bugfixes

• Fix highlighting of Markdown files, see #963 and #977
• Fix base16 theme (was broken since in v0.14), see #972, #934 and #979 (@mk12).
  Users suffering from #865 ("no color for bat in ssh from a Windows client") can use the ansi-dark and ansi-light themes from now on.

New syntaxes

• Fortran, see #957
• Email (@mariozaizar)
• QML, see #962 (@pylipp)