logo-ls

This is a fork of logo-ls which I ended up maintaining since the original repository went unmaintained some years ago.

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).
• Restructuring the code base to make it easier to apply changes and introduce features (still in progress)
• Nerd Fonts Version 3 migration (this breaks compatibility with codepoints of previous versions)

Feel free to contribute and I'll be more than happy to merge your changes. In case you want to add some new icons, please make a PR so that we can all benefit from that. The following sections explains how to do it.

Adding Icons

In order to add new icons you need to:

1. Fork the repository
2. Add an entry in the map IconSet in icons/icons_map.go. The key should be the name of the icon and not its extension (i.e. markdown for markdown files). The value should be of type IconInfo, a struct indicating the unicode character and its color.
3. Add one or more entries in the map IconExt in icons/icon_ext.go, mapping the entry defined in IconSet to each one of the desired extensions

You can map an icon to a specific file name (i.e. tsconfig.json) by editing icons/icons_files.go. You can also override an icon for a specific file name (i.e. use a different icon for gitlab-ci.yml rather than the standard YML one) by editing icons/icons_sub_ext.go.

Installation

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 ./cmd/logo-ls

If you want to build the binary only you can, instead, run

cd logo-ls
go build -o logo-ls ./cmd/logo-ls