Which file types have Nerd Font icons?

[odebroqueville]

Hi Dhruv, I noticed that certain file types, e.g. html, css or js, don't get an icon when I perform a pls in the terminal. Therefore, I wanted to ask you if there's a list somewhere of the file types you have taken care of, i.e. for which a Nerd Font icon has been associated.

[dhruvkb]

This is the list of icons names built into pls, each with its associated Nerd Fonts icon. (If you see just squares below, you will need to adjust your browser's monospace font.)

pls/src/config/conf.rs

Lines 41 to 75 in 5fc0373

	// pls
	"pls" => "", // nf-oct-primitive_dot
	"missing" => "", // nf-cod-error
	// Node types
	"file" => "", // nf-fa-file
	"dir" => "", // nf-fa-folder
	"symlink" => "󰌹", // nf-md-link-variant
	"fifo" => "󰟥", // nf-md-pipe
	"socket" => "󰟨", // nf-md-power_socket_uk
	"char_device" => "", // nf-fa-paragraph
	"block_device" => "󰋊", // nf-md-harddisk
	// Generic
	"audio" => "󰓃", // nf-md-speaker
	"book" => "", // nf-fa-book
	"broom" => "󰃢", // nf-md-broom
	"config" => "", // nf-seti-config
	"container" => "", // nf-oct-container
	"env" => "", // nf-fae-plant
	"image" => "󰋩", // nf-md-image
	"json" => "", // nf-seti-json
	"law" => "", // nf-oct-law
	"lock" => "", // nf-oct-lock
	"package" => "", // nf-oct-package
	"runner" => "󰜎", // nf-md-run
	"shell" => "", // nf-oct-terminal
	"source" => "", // nf-oct-file_code
	"test" => "󰙨", // nf-md-test_tube
	"text" => "", // nf-seti-text
	"video" => "󰕧", // nf-md-video
	// Brands
	"apple" => "", // nf-fa-apple
	"git" => "󰊢", // nf-md-git
	"github" => "", // nf-oct-mark_github
	"markdown" => "", // nf-oct-markdown
	"rust" => "", // nf-dev-rust

This is the list of specs built into pls, each with its associated icon name.

pls/src/config/conf.rs

Lines 78 to 106 in 5fc0373

	// Extensions
	Spec::new(r"\.sh$", "shell"),
	Spec::new(r"\.rs$", "rust").style("rgb(247,76,0)"),
	Spec::new(r"\.(txt|rtf)$", "text"),
	Spec::new(r"\.mdx?$", "markdown"),
	Spec::new(r"\.ini$", "config"),
	Spec::new(r"\.(json|toml|yml|yaml)$", "json"),
	Spec::new(r"\.(jpg|jpeg|png|svg|webp|gif|ico)$", "image"),
	Spec::new(r"\.(mov|mp4|mkv|webm|avi|flv)$", "video"),
	Spec::new(r"\.(mp3|flac|ogg|wav)$", "audio"),
	// Partial names
	Spec::new(r"^\.env\b", "env"),
	Spec::new(r"^README\b", "book").importance(2),
	Spec::new(r"^LICENSE\b", "law"),
	Spec::new(r"docker-compose.*\.yml$", "container"),
	Spec::new(r"Dockerfile", "container"),
	// Exact names
	Spec::new(r"^\.DS_Store$", "apple").importance(-2),
	Spec::new(r"^\.pls\.yml$", "pls").importance(0),
	Spec::new(r"^\.git$", "git").importance(-2),
	Spec::new(r"^\.gitignore$", "git"),
	Spec::new(r"^\.github$", "github"),
	Spec::new(r"^src$", "source").importance(1),
	Spec::new(r"^(justfile|Makefile)$", "runner"),
	Spec::new(r"^Cargo\.toml$", "package"),
	Spec::new(r"^Cargo\.lock$", "lock")
	.importance(-1)
	.collapse(Collapse::Name(String::from("Cargo.toml"))),
	Spec::new(r"^rustfmt.toml$", "broom"),

I can understand how this can have been communicated better in the docs.

Pattern	Icon
\.sh$	shell
\.rs$	rust
\.(txt|rtf)$	text
\.mdx?$	markdown
\.ini$	config
\.(json|toml|yml|yaml)$	json
\.(jpg|jpeg|png|svg|webp|gif|ico)$	image
\.(mov|mp4|mkv|webm|avi|flv)$	video
\.(mp3|flac|ogg|wav)$	audio
^\.env\b	env
^README\b	book
^LICENSE\b	law
docker-compose.*\.yml$	container
Dockerfile	container
^\.DS_Store$	apple
^\.pls\.yml$	pls
^\.git$	git
^\.gitignore$	git
^\.github$	github
^src$	source
^(justfile|Makefile)$	runner
^Cargo\.toml$	package
^Cargo\.lock$	loc
^rustfmt.toml$	broom

The icons for web development are not built in and will need to be added by the user. You can refer to the starter configs in the pls documentation for that.

[dhruvkb]

I also just added a starter config for web dev projects involving HTML, CSS and some CSS pre-processors.

[odebroqueville]

Beautiful, Dhruv! Thank you so much. I was actually having a look at the Material Design Files Icons and thought that this file could be used to generate the Specs. The difficulty I'm having is to automatically associate an Nerd Font Icon Name to an icon name. I don't think there's an API that I could use.

Btw, can the icon always be left blank as shown below, as an example (in other words, does it suffice to have the name nf-seti-json specified):

"json" => " ", // nf-seti-json

[dhruvkb]

pls ships with a limited set of specs so that the app can be performant. Matching specs to node names is a time-consuming expensive operation so the fewer the specs the faster pls runs. That's why pls recommends making a .pls.yml file inside your project repo so that the specs are localised to that project.

You can refer to the Nerd Fonts cheat sheet for the list of available icons. It's much more limited compared to the icons in an icon pack because

• they're packaged in a font
• they're not changed and updated as often
• they need to be monochromatic

The VS Code icon themes will definitely be much more comprehensive and suitable for UI-based applications.

As for the .pls.yml file, the icon glyph is needed. The text after the # is just a comment, that can be skipped. So to your question, no, the icon cannot be skipped but the name can.

icons:
  json: ""