A Go library for mapping files/folders to Nerd Font icons and colors.

When building command-line tools or file explorers in Go, displaying appropriate icons can enhance the user experience, providing quick visual cues about file types. go-devicons simplifies this by providing a straightforward way to map Nerd Font icon and corresponding color for files and directories, leveraging the comprehensive icon mappings from nvim-web-devicons project.

This library is useful for enhancing terminal applications, file explorers, or any Go program that needs to display visually distinct file representations. See codegrab for an example usage.

To use go-devicons in your Go project, install it using go get:

go get github.com/epilande/go-devicons

The library provides two main functions to get the icon style:

1. IconForPath(path string) icons.Style: Takes a file system path, determines the file type (regular, directory, symlink) using os.Lstat, and returns the best matching style.
2. IconForInfo(info os.FileInfo) icons.Style: Takes an existing os.FileInfo object (useful if you've already read directory contents), and returns the best matching style based on the info.

Both functions return an icons.Style struct:

// Style holds the suggested icon and hex color for a file/directory.
type Style struct {
	Icon  string
	Color string
}

Here's a simple example demonstrating how to get and print the icon for files in the current directory:

package main

import (
	"fmt"
	"log"
	"os"

	"github.com/epilande/go-devicons"
)

func main() {
	targetDir := "."
	entries, err := os.ReadDir(targetDir)
	if err != nil {
		log.Fatalf("Error reading directory '%s': %v\n", targetDir, err)
	}

	fmt.Printf("Listing contents of '%s':\n", targetDir)

	for _, entry := range entries {
		info, err := entry.Info()
		if err != nil {
			fmt.Printf("? %s (Error getting info: %v)\n", entry.Name(), err)
			continue
		}

		// Get the icon style using FileInfo
		fileStyle := devicons.IconForInfo(info)

		// Get the icon style using Path (alternative)
		// path := filepath.Join(targetDir, entry.Name())
		// fileStyle := devicons.IconForPath(path)

		// Print the icon and name (basic, no color)
		fmt.Printf("%s %s %s\n", fileStyle.Icon, entry.Name(), fileStyle.Color)
	}
}

The icon mappings used in this library are automatically generated from the Lua source files of nvim-web-devicons. Full credit goes to the maintainers and contributors of that project for curating the extensive icon set.