sharkdp / bat Goto Github PK

View Code? Open in Web Editor NEW

46.3K 199.0 1.2K 30.29 MB

A cat(1) clone with wings.

License: Apache License 2.0

Rust 96.92% Shell 0.89% Batchfile 0.01% Python 2.18%

command-line tool syntax-highlighting git terminal cli rust hacktoberfest

bat's People

Contributors

Stargazers

Watchers

Forkers

wezm wdv4758h shaunstanislauslau brainmaestro rleungx kuangyeheng mikalv rahrawat bradparks mbrukman pitkley brianwitte shelltips madnight yifan1111 spencerx eth-p iamed2 kogai ellerbrock gitking 0mp shorsher jraulhernandezi ghuls tathanhdinh sanga migzone tskinn funny-fury hello2dj kangaloo infrastrukt massongit scampi soc mandx cfcosta sjas chengyuanheng progray mothsart mina86 jameschen79 mhartington dangdungcntt meltinglava sylvanasbeta anykao mojitmj bollwarm hhy5277 mchlrhw mikegirkin iamsingularity miteshshah mkfsn ashr mewbak bk1603 josephusmi 0xdaksh meain jithinraj ohc192 paiva typedefine morganwang010 gatarelib candeira lyrl zach14c banafshr gabrsar lovio chengfeng-git xinger123123 0asa andytengca blka henri linecode modulexcite kognise phoenx34 mimame sin-ning kimkh930122 hapazores amanmehndiratta25 biborn rigby-dane simplereps rachitchokshi ms2300 rogach shikchen jdhoek tomarrell 0xflotus

bat's Issues

Do not fail on regex errors

Unfortuntately, syntect may panic! if there are errors in the syntax definition regular expressions (see trishume/syntect#98).

Add Markdown support

~~Unfortunately, Markdown does not seem to be included in syntects default set.~~

It would be extra-cool if bat could syntax-highlight the code blocks in the correct language 😄

thread 'main' panicked at 'no entry found for key', libcore/option.rs:917:5

I'm using latest stable rust (1.25.0) and installed bat via cargo install bat. Trying it on some file throws an error message.

Is this a bug or did cargo

thread 'main' panicked at 'no entry found for key', libcore/option.rs:917:5
stack backtrace:
   0: std::sys::unix::backtrace::tracing::imp::unwind_backtrace
             at libstd/sys/unix/backtrace/tracing/gcc_s.rs:49
   1: std::sys_common::backtrace::_print
             at libstd/sys_common/backtrace.rs:71
   2: std::panicking::default_hook::{{closure}}
             at libstd/sys_common/backtrace.rs:59
             at libstd/panicking.rs:380
   3: std::panicking::default_hook
             at libstd/panicking.rs:396
   4: std::panicking::rust_panic_with_hook
             at libstd/panicking.rs:576
   5: std::panicking::begin_panic
             at libstd/panicking.rs:537
   6: std::panicking::begin_panic_fmt
             at libstd/panicking.rs:521
   7: rust_begin_unwind
             at libstd/panicking.rs:497
   8: core::panicking::panic_fmt
             at libcore/panicking.rs:71
   9: core::option::expect_failed
             at libcore/option.rs:917
  10: bat::main
  11: std::rt::lang_start::{{closure}}
  12: std::panicking::try::do_call
             at libstd/rt.rs:59
             at libstd/panicking.rs:479
  13: __rust_maybe_catch_panic
             at libpanic_unwind/lib.rs:102
  14: std::rt::lang_start_internal
             at libstd/panicking.rs:458
             at libstd/panic.rs:358
             at libstd/rt.rs:58
  15: main
  16: __libc_start_main
  17: _start

Have you thought about adding git-style automatic paging to it? If the lines fit on one screen, it would not do paging (like the current behavior). But as soon as it's more than one screen, it could automatically page.

That's one of the things that git got right IMO.

Performance tweaks

Possible options to improve performance:

Do not parse syntax definitions (and themes) from files, include them in the binary (like syntect does)
Run the computation of the Git differences in parallel while the syntax definitions are loaded.

Text wrapping

Is there any plan for text wrapping? The output right now is so polished, lines too long look pretty out-of-place. Definitely understand not wrapping by default, but having a flag for it would be pretty chill I think.

Handle non-interactive terminals properly

Add support for reading from stdin?

Also, allow - as a path argument

Use XDG-compliant config and cache directories

Add CURL support

... so we can do things like

bat https://raw.githubusercontent.com/sharkdp/bat/master/src/main.rs

or just do it the UNIX way 😄

curl https://raw.githubusercontent.com/sharkdp/bat/master/src/main.rs | bat

Both cases would probably require us to infer the programming language from the file contents.

Provide a "less" interactive mode

First, thanks for this awesome tool. Here is my feature request:
provide a less-like browsable mode, usefull for large files.
This is needed because there is no obvious way to colorize less input which makes bat ... | less unusable.

Provide a man page

Offer a linux manual page for utility description.

Elixir syntax

Doesn't work with: https://github.com/elixir-editors/elixir-tmbundle

Any plans to support syntax highlighting for emacs org-mode file?

Hi, do you have any plans to support syntax highlighting for emacs org-mode file, which is also a markup language?

org-mode: https://orgmode.org

An example:

Add some basic documentation for less integration

I suspect a lot of use cases of bat are of integration with less.

I suggest adding some documentation on this. What is needed is already written on #29 , namely

export LESS="-R"
Is needed for the bat blah|less to work

and

export LESSOPEN="| bat %s"
export LESS="-R"

Is need for less to use bat automatically

bat init-cache failed

i've followed steps from readme, but got this:

➜   bat init-cache
[bat error]: Could not load themes from '/Users/xxxxx/Library/Preferences/bat/themes'

i thought it maybe writing in linux context, so i copied files from ~/.config/bat into ~/Library/Preferences/bat/, still not working.

thread main panicked on Result::unwrap() with simple js file

> cat index2.js
const io

> bat index2.js
thread 'main' panicked at 'called `Result::unwrap()` on an `Err` value: 
Error(-114, target of repeat operator is invalid)', libcore/result.rs:945:5

This appears to be syntax related, if I change the file name to .py it works

> mv index2.js index2.py

> bat index2.py
───────┬────────────────────────────────────────────────────────────────────
       │ File index2.py
───────┼────────────────────────────────────────────────────────────────────
   1   │ const io
───────┴────────────────────────────────────────────────────────────────────

I'm using the sample from the readme for the syntax definitions

mkdir -p ~/.config/bat/syntax
cd ~/.config/bat/syntax

# Download some language definition files, for example:
git clone https://github.com/sublimehq/Packages/
rm -rf Packages/Markdown
git clone https://github.com/jonschlinkert/sublime-markdown-extended

Any plans to package it to Deb/Rpm or etc??

Might be really great to just download from package repo.
(without using cargo)

Any chances to deploy with openSUSE's Build Service?
https://software.opensuse.org/

Heads-up: a FreeBSD port of bat is on its way

Hello!

I just wanted to point out that bat is on its way be included in the FreeBSD ports collection (pending PR). At the moment the problem is with the dictionaries dependency.

Cheers and happy hacking!

Add pretty-printing options?

For files such as JSON, CSV, etc.?

Unable to run `cargo install bat`

Here is the log:

$ cargo install bat
^V    Updating registry `https://github.com/rust-lang/crates.io-index`
  Installing bat v0.2.3
 Downloading backtrace v0.3.7
 Downloading rustc-demangle v0.1.8
 Downloading cfg-if v0.1.3
 Downloading cmake v0.1.31
   Compiling unicode-normalization v0.1.6
   Compiling stable_deref_trait v1.0.0
   Compiling serde v1.0.45
   Compiling dtoa v0.4.2
   Compiling regex-syntax v0.4.2
   Compiling bitflags v0.9.1
   Compiling void v1.0.2
   Compiling cfg-if v0.1.3
   Compiling matches v0.1.6
   Compiling bitflags v1.0.3
   Compiling safemem v0.2.0
   Compiling regex v0.2.11
   Compiling winapi v0.3.4
   Compiling lazy_static v0.2.11
   Compiling plist v0.2.4
   Compiling byteorder v1.2.2
   Compiling lazy_static v1.0.0
   Compiling pkg-config v0.3.11
   Compiling same-file v1.0.2
   Compiling percent-encoding v1.0.1
   Compiling utf8-ranges v1.0.0
   Compiling ansi_term v0.9.0
   Compiling linked-hash-map v0.5.1
   Compiling unicode-xid v0.1.0
   Compiling num-traits v0.2.2
   Compiling unicode-width v0.1.4
   Compiling fnv v1.0.6
   Compiling cc v1.0.15
   Compiling ansi_term v0.11.0
   Compiling strsim v0.7.0
   Compiling rustc-demangle v0.1.8
   Compiling ucd-util v0.1.1
   Compiling itoa v0.4.1
   Compiling smallvec v0.6.1
   Compiling libc v0.2.40
   Compiling owning_ref v0.3.3
   Compiling unreachable v1.0.0
   Compiling unicode-bidi v0.3.4
   Compiling xml-rs v0.7.0
   Compiling base64 v0.8.0
   Compiling bincode v1.0.0
   Compiling walkdir v2.1.4
   Compiling yaml-rust v0.4.0
   Compiling proc-macro2 v0.3.8
   Compiling num-integer v0.1.36
   Compiling regex-syntax v0.5.6
   Compiling serde_json v1.0.17
   Compiling thread_local v0.3.5
   Compiling term_size v0.3.1
   Compiling clicolors-control v0.2.0
   Compiling rand v0.4.2
   Compiling time v0.1.39
   Compiling atty v0.2.10
   Compiling termios v0.2.2
   Compiling memchr v2.0.1
   Compiling libz-sys v1.0.18
   Compiling backtrace-sys v0.1.16
   Compiling cmake v0.1.31
   Compiling miniz-sys v0.1.10
   Compiling quote v0.5.2
   Compiling textwrap v0.9.0
   Compiling parking_lot_core v0.2.14
   Compiling chrono v0.4.2
error[E0432]: unresolved import `std::sync::atomic::spin_loop_hint`
  --> .cargo/registry/src/github.com-1ecc6299db9ec823/parking_lot_core-0.2.14/src/spinwait.rs:14:5
   |
14 | use std::sync::atomic::spin_loop_hint;
   |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ no `spin_loop_hint` in `sync::atomic`

error: aborting due to previous error

error: Could not compile `parking_lot_core`.
warning: build failed, waiting for other jobs to finish...
error: failed to compile `bat v0.2.3`, intermediate artifacts can be found at `/tmp/cargo-install.rCS7oWKs408U`

Caused by:
  build failed

Screenshot here:

Here is my Ubuntu Linux version info:

$ lsb_release -a
No LSB modules are available.
Distributor ID: Ubuntu
Description:    Ubuntu 16.04.3 LTS
Release:        16.04
Codename:       xenial

My Ubuntu is run under Bash on Ubuntu on Windows in my Windows 10 ver 1803 (OS Build 17134.1).

TOML support

Hey! Looks like TOML support is missing. Sorry if this issue should be on one of your dependencies and not this repo :).

I added it with the README's instruction for syntax support, but might be nice to include by default, especially since this tool is written in Rust!

Git modifications not shown from child folder

Filter to only include hunks?

First: congrats on the release, and props for creatively putting together the pieces that make this work!

Anyway: It'd be really neat if this could be used as an alternative to the default pager in Git -- this is REALLY nice-looking, and I'd love to use this as a pager. Would you be open to a PR or implementing yourself a feature to filter out everything that's not a hunk in a diff? I'm not sure if this should be a special way to process diff/patch files or just integrated with libgit2 directly -- the latter is probably easier, since you're already using libgit2 as a dependency.

Bat requires glibc 2.18 - CentOS 7 only offers glibc 2.17

On CentOS 7.4.1708, when trying to run bat, there is a GLIBC version problem error

/lib64/libc.so.6: version `GLIBC_2.18' not found (required by ./bat)

CentOS 7 only offers glibc 2.17

Build dependencies - cmake

Hi, I've tried to build bat on a Mac OS system and I have realized that there is a dependency to cmake to have the cargo build complete. Can you update the readme please?

Proper handling of syntax highlighting themes

Use syntect-internal default theme if ~/.config/bat/themes/ does not contain anything.
Make theme configurable via command line option (or use Default.tmTheme symlink?)

Add a --language option to explicitly specify the programming language

Syntax highlighting for JSON

I am using version 0.2.2 on Linux and apparently bat does not colorize .json files.

Add instructions for openssl installation

See https://github.com/sfackler/rust-openssl

# On Debian and Ubuntu
sudo apt-get install pkg-config libssl-dev
# On Arch Linux
sudo pacman -S openssl
# On Fedora
sudo dnf install openssl-devel

Do not exit on errors

If we call bat file1 file2 file3, we should still output file3 if file2 is erroneous.

The exit code should still be nonzero.

As another example, see #27

Wrong parameter parsing.

Obiviously, as depicted below, bat command recognizes filename (R-language source code) as subcommand.

If this error doesn't come from my misuse, i'll fix it.

Add Git support

Show a +, - or ~ indicator for lines/hunks that have been added, removed or modified (similar to https://github.com/airblade/vim-gitgutter)

cat-like behavior while piping

I could use this as an shell alias for cat if it disabled all formatting/syntax-highlighting when it detects that the output stream is piped to another process (i.e. not a tty). But also have an option to force syntax-highlighting for use-cases such as bat myfile.json --force-syntax-hi | head.

Handle edge cases

Very large files => make sure that line number output looks okay
Binary files => do not attempt to output anything. Instead, print some statistics?
Lines with no line-ending => Indicate this in a similar way to cat(1)?
Lines with wrong faulty Unicode characters => print �
Filenames which are non-UTF8 compatible
different line ending formats (\n, \r, etc.)

Missing libcurl-gnutls.so.4 with Fedora or CentOS prevents execution

When running bat via the releases bat-v0.2.0-x86_64-unknown-linux-gnu.tar.gz , it complains about a missing shared library:
error while loading shared libraries: libcurl-gnutls.so.4: cannot open shared object file: No such file or directory

There is no libcurl-gnutls in CentOS per https://www.centos.org/forums/viewtopic.php?t=64227

Collection of Syntaxes Available

I have a pasting service that also uses syntect, and I have a bit of a collection of syntaxes to potentially contribute. I believe many were converted from tmbundles using a ruby gem for this purpose, but they seem to work well enough in my experience. Some of these may already been included, and so I'll list them as a checklist.

They're all available in an archive here.
(Sorry in advance, but I unfortunately didn't keep track of the source 😦)

Add more Git features

Just a few ideas:

~~Add a --staged option to show staged changes.~~ => this would require us to read the file from the Git index.
Add a --context N option to only show the lines associated with changes
(Add a way to specify a git commit/tag/branch to show the file contents from the git index.)

Default colorschemes for light terminals

Hi! I just found this tool and it would be super nice if there was a way to use it for terminals with a light background color (e.g. solarized light). I'm just hoping there's a quick way to provide a dark colorscheme by default.

Thanks alot for making this!

Support terminals with no true color support

.. by using 8 bit ANSI sequences instead of 24 bit true color ANSI sequences.

brew install option

Hello,

Do you think a brew install method will be available soon ?

publish package to debian repositories

it would be nice to have bat as a regular debian package so that we can install it via apt.

Get git repository from file path instead of current directory

Inside the repo:

some/folder/repo > bat test.md

▶ bat test.md
───────┬─────────────────────────────────────────────────────────────────────
       │ File test.md
───────┼─────────────────────────────────────────────────────────────────────
...
  19   │ 
  20 + │ <div>
  21 + │ huhu
  22 + │ </div>
───────┴─────────────────────────────────────────────────────────────────────

Outside the repo:

some/folder > bat repo/test.md

▶ bat test.md
───────┬─────────────────────────────────────────────────────────────────────
       │ File test.md
───────┼─────────────────────────────────────────────────────────────────────
...
  19   │ 
  20   │ <div>
  21   │ huhu
  22   │ </div>
───────┴─────────────────────────────────────────────────────────────────────

Installation with rust 1.20.0 fails

I tried to install bat with cargo, but got some error[E0277] messages. After updating to lastest version installation works fine.

Is this a bug or is expecting / using latest rust version a default for rust software I wasn't aware of?

# failing
$ cargo -V
cargo 0.21.0 (5b4b8b2ae 2017-08-12)

$ rustc --version
rustc 1.20.0 (f3d6973f4 2017-08-27)

# successfull
$ cargo -V
cargo 0.26.0 (41480f5cc 2018-02-26)

$ rustc --version
rustc 1.25.0 (84203cac6 2018-03-25)

Example error message for reference purpose

$ cargo install bat
[ ... ]
error[E0277]: the trait bound `std::option::Option<std::collections::HashMap<u32, LineChange>>: std::ops::Try` is not satisfied
   --> /home/kbite/.cargo/registry/src/github.com-1ecc6299db9ec823/bat-0.1.0/src/main.rs:120:16
    |
120 |        let diff = repo.diff_index_to_workdir(None, Some(&mut diff_options))
    |   ________________-
    |  |________________|
    | ||
121 | ||         .ok()?;
    | ||              -
    | ||______________|
    | |_______________the `?` operator can only be used in a function that returns `Result` (or another type that implements `std::ops::Try`)
    |                 in this macro invocation
    |
    = help: the trait `std::ops::Try` is not implemented for `std::option::Option<std::collections::HashMap<u32, LineChange>>`
    = note: required by `std::ops::Try::from_error`

error: aborting due to 5 previous errors

error: failed to compile `bat v0.1.0`, intermediate artifacts can be found at `/tmp/cargo-install.1dfJ32nRGNx6`

Caused by:
  Could not compile `bat`.

Default behavior when output is sent to a file

I, for one, prefer the way exa handles this. To wit,

With exa, I've aliased ls and everything's been fine. I'd consider doing the same for bat if we could get non-colorized output and byte-for-byte copying when the output isn't a terminal ("catting to a file"). Perhaps via a config. If that's not your goal, that's fine too. 👍

Cool project, btw.

Don't stop on error

When attempting to print a directory, an error is returned. ([bat error]: Is a directory (os error 21)).
It would be nice if, when given multiple files, bat would then just move on to the next file.

To reproduce:

$ mkdir foo_dir
$ echo foo > foo_file
$ cat * 2> /dev/null
foo
$ bat * 2> /dev/null
$

Add option to disable line numbers

... and Git modification-markers.

Panic on some input

Given the file test.md:

Test

<div>
</div>

Running bat test.md panics:

% bat test.md            
───────┬────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────
       │ File test.md
───────┼────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────
   1   │ Test
   2   │ 
thread 'main' panicked at 'called `Result::unwrap()` on an `Err` value: Error(-122, invalid pattern in look-behind)', libcore/result.rs:945:5
stack backtrace:
   0: std::sys::unix::backtrace::tracing::imp::unwind_backtrace
             at libstd/sys/unix/backtrace/tracing/gcc_s.rs:49
   1: std::sys_common::backtrace::print
             at libstd/sys_common/backtrace.rs:71
             at libstd/sys_common/backtrace.rs:59
   2: std::panicking::default_hook::{{closure}}
             at libstd/panicking.rs:205
   3: std::panicking::default_hook
             at libstd/panicking.rs:221
   4: std::panicking::rust_panic_with_hook
             at libstd/panicking.rs:457
   5: std::panicking::begin_panic_fmt
             at libstd/panicking.rs:344
   6: rust_begin_unwind
             at libstd/panicking.rs:322
   7: core::panicking::panic_fmt
             at libcore/panicking.rs:71
   8: core::result::unwrap_failed
   9: syntect::parsing::syntax_definition::MatchPattern::compile_with_refs
  10: syntect::parsing::parser::ParseState::parse_line
  11: syntect::easy::HighlightLines::highlight
  12: bat::run
  13: bat::main
  14: std::rt::lang_start::{{closure}}
  15: std::panicking::try::do_call
             at libstd/rt.rs:59
             at libstd/panicking.rs:304
  16: __rust_maybe_catch_panic
             at libpanic_unwind/lib.rs:105
  17: std::rt::lang_start_internal
             at libstd/panicking.rs:283
             at libstd/panic.rs:361
             at libstd/rt.rs:58
  18: main
  19: __libc_start_main
  20: _start

Any support syntax styling (indent, tab, etc..) from .editorconfig ?

Well, bat is not really an 'editor',

but It'll be really nice if bat supports syntax styling with .editorconfig.

sharkdp / bat Goto Github PK

bat's People

Contributors

Stargazers

Watchers

Forkers

bat's Issues

Recommend Projects

Recommend Topics

Recommend Org

Jobs