feat: get icons by filetype

[b0o]

Adds the filetypes table, which is a map from vim filetypes to icon names.

local filetypes = {
  ["Brewfile"] = "Brewfile",
  ["COMMIT"] = "COMMIT_EDITMSG",
  ["COPYING"] = "COPYING",
  -- ...
  ["yaml"] = "yaml",
  ["zig"] = "zig",
  ["zsh"] = "zsh",
}

The map is not exhaustive. More filetypes should be added over time, but at least this is a start.

Also adds the following functions:

get_icon_by_filetype(filetype, opts)
get_icon_colors_by_filetype(filetype, opts)
get_icon_color_by_filetype(filetype, opts)
get_icon_cterm_color_by_filetype(filetype, opts)
get_icon_name_by_filetype(filetype)

Because some icons are not distinguishable by their filetype alone, the filetype table maps to the "most common" or "canonical" icon. E.g. the filetype cpp maps to the cpp icon, even though .hpp files also have the cpp filetype.

For this reason, users should prefer the standard get_icon function if the filename is known; the get_icon_name_by_filetype function should only be used if the filename is unknown.

---

P.s. if you're interested, I wrote this script to assist in generating the filetypes table, and then manually cleaned up the results.

#!/usr/bin/env bash
set -euo pipefail

function get_icon_names() {
  curl 'https://raw.githubusercontent.com/kyazdani42/nvim-web-devicons/master/lua/nvim-web-devicons.lua' |
    lua -e '
      pats={}
      for name in pairs(dofile().get_icons()) do
        table.insert(pats, name)
      end
      table.sort(pats)
      print(table.concat(pats, "\n"))
    '
}

function main() {
  local tmp
  tmp="$(mktemp -d)"
  # shellcheck disable=2064
  trap "rmdir '$tmp'" EXIT
  cd "$tmp"
  local file
  local -A filetypes=()
  local -a missing=()
  while read -r pat; do
    echo "$pat" >&2
    if [[ "$pat" =~ ^\. ]]; then
      file="$pat"
    else
      file="test.$pat"
    fi
    touch "./$file"
    local ft
    ft="$(/usr/bin/nvim -u NORC --noplugin --headless "./$file" +'lua
      local ok, err = pcall(vim.fn.writefile, { vim.bo.filetype }, "/dev/stdout")
      if not ok then
        print(err .. "\n")
        vim.cmd "cquit"
      end
      vim.cmd "quit"
    ')"
    rm "./$file"
    if [[ -n "$ft" ]]; then
      if [[ -v filetypes["$ft"] ]]; then
        filetypes["$ft"]="${filetypes["$ft"]}, '$pat'"
      else
        filetypes["$ft"]="'$pat'"
      fi
    else
      missing+=("$pat")
    fi
  done < <(get_icon_names)

  echo "local filetypes = {"
  for ft in "${!filetypes[@]}"; do
    echo "  ['$ft'] = { ${filetypes[$ft]} },"
  done
  echo "}"
  echo
  echo "local missing = {"
  printf "  '%s',\n" "${missing[@]}"
  echo "}"
}

main "$@"

Ref #29

[kyazdani42]

very nice addition, thanks :)

[b0o]

Great! Should be able to close #29