Since all the work is done behind the scenes and only TUI is shown, it can be really hard to know what's going on. This issue proposes to add support for optional logging. It can be useful for debugging issues.

Specifically,

1. Add a CLI flag for an optional path to logs
2. Add logger to the project to output data in the specified file (only when the file is given)
3. Add log lines

At this point, I can see the following relevant log lines:

• Cloning repo
• Reading file contents
• Every time bat is called
• Received events

This should be a good start.

The entire layout just goes horribly wrong.

Solution:

1. Check that the file is binary.
2. Don't call bat if the file is binary (happens here)

   • github-tui/lib/fs/fs.ml

     Lines 32 to 37 in b2c44c1

     	let read_file_contents path =
     	let cmd =
     	"bat --style=numbers,changes --color=always --italic-text=always \
     	--paging=never --terminal-width=80 " ^ path
     	in
     	let contents = Shell.proc_stdout cmd in

3. Instead, display some standard text saying that the file is binary
4. Additionally, use the eae8 icon for the file icon when the file is binary

Currently, the file contents are shown in the on-screen UI, supported by bat:

Instead, it can be desirable to open them in $EDITOR to edit in place.

Currently, when a repository contains too many nested directories, opening it may take a while.

To improve the starting performance, let's make the directory contents reading a lazy operation. To do this, the type of fs needs to be changed:

Directory contents should be tree array Lazy.t instead of tree array.

It should be possible to configure a Dev env shell with one command (I'm thinking about: https://devenv.sh/) that brings into the scope:

• Entire required OCaml toolchain
• All dependencies
• All dev tools
  • ocamlformat
  • ocaml-lsp
  • utop
• Required runtime dependencies
  • bat
  • (Optional) Fonts

Come up with an idea on how to support it nicely and implement

The proposed design:

• Don't show .gitignored files by default
• Provide a CLI option --no-gitignore to show the files
• When shown, highlight them in grey colour

A directory may contain too many files, and they might not fit onto the screen. It looks like this:

The solution would be to have some sort of scrolling or automatically switch to a fuzzy search view.