I forked from the original logo-ls repository (which has been inactive since 2021) in June 2022 and my PRs have been pending since then. I ended up mantaining my own version of this software.
Despite the output is pretty cool (I personally prefer logo-ls to something like exa) the codebase is a mess and most of the time it's difficult to understand what is happening.
My primary goals have been:
- Correct output (I should see all the files /bin/ls would show me)
- Informative output (I should see at least what /bin/ls would show me)
- MacOS / Linux / Windows compatibility (I mainly develop on OSX but I want to use logo-ls everywhere)
The modifications I made involved:
- Removing case sensitive paths in order to avoid issues on OSX/Windows machines
- Changing UTF-8 space character in order to properly render the output on every terminal
- Fixing a bug on path separators that caused issues with the git status flag on Windows machines
- Implementing a symlink resolution that behaves like the one of the original ls(coreutils).
In July 2023 I made a breaking change which breaks compatibility with nerd fonts versions prior to 3.*.*. This was due to the codepoint migration made by Nerd Fonts (who dropped Material Design Icons). This broke a few icons and I manually replaced them, but I'm still not completely sure all the fonts are working.
If you want to contribute, it would be really cool to:
- Implement proper unit testing (for now, there's something called
e2e_test.gowhich is broken) - Clean up the codebase
- Refactor some uselessly complex parts of the code
- Deploy to package managers like homebrew, apt, yum, yay, pacman, etc.
Since no binary is available, you should compile yours by yourself (for now). You have to install go, then run:
git clone https://github.com/canta2899/logo-ls And install using
cd logo-ls
go install .If you want to build the binary only you can, instead, run
cd logo-ls
go build -o logo-ls .- Thanks to ehoefel for his contribution