🕰️

Neovimで使うluaのlanguage serverによってos.date()の型定義が違ってめんどいのよね

に公開

この記事はVim駅伝の2026-03-04の記事です。
前回の記事はmikoto2000さんのローカル LLM でコード補完する Vim プラグインを作ったです。

Vim駅伝は常に参加者を募集しています。詳しくはこちらのページをご覧ください。


luaにはos.date()という時刻情報を返す関数があります。

https://www.lua.org/pil/22.1.html

戻り値は年・月・日・時・分・秒・数などのフィールドが含まれるテーブルです。仕様的にはこれはtable型でしかありません。とはいえ、日時型というのは使用頻度が高いので、型名が定義されていると便利です。

課題 lua-lsとemmyluaで型定義が異なる

lua-language-serverでは、os.date()の戻り値にはosdateという名前がつけられています。

https://github.com/LuaLS/lua-language-server/blob/7c3d4a094956697fc18430e28f19007e058276f5/meta/template/os.lua#L12-L37

emmylua-analyzerでは、os.date()の戻り値にはstd.osdateという名前がつけられています。

https://github.com/EmmyLuaLs/emmylua-analyzer-rust/blob/45eccb2eb8fbf0c9613f3ec377a20072800d3325/crates/emmylua_code_analysis/resources/std/os.lua#L25-L73

これらの名前が違うのがめんどい。
lua-language-serverの使用者が書いたコードにはosdateの型注釈があるのですが、このファイルをemmylua-analyzerを使って見ると「osdateなんて型は知らないよ」というエラーが出まくります。逆も同様。せっかくの型情報なのに、却って邪魔になりかねません。

解決 それぞれにエイリアスを張る

ということでこれらを互いに紐づけるため、lua_lsではstd.osdateをosdateの、emmyluaではosdateをstd.osdateのエイリアスとして定義します。
これらは別に~/.config/になくてもよいのですが、自分の設定は~/.config/以下にまとめてあるので、わかりやすいかと思ってここに配置しました。

~/.config/lua_ls/types.lua
---@meta
---@alias std.osdate osdate
~/.config/emmylua/types.lua
---@meta
---@alias osdate std.osdate

これらを各lspの設定で読み込みます。workspace.libraryに定義を追加してください。

~/.config/nvim/after/lsp/lua_ls.lua
return {
  settings = {
    Lua = {
      workspace = {
        library = {
          vim.env.XDG_CONFIG_HOME .. '/lua_ls',
        }
      }
    }
  }
}
~/.config/nvim/after/lsp/emmylua.lua
return {
  settings = {
    emmylua = {
      workspace = {
        library = {
          vim.env.XDG_CONFIG_HOME .. '/emmylua',
        }
      }
    }
  }
}

筆者のように両方のls設定を並行で運用している方はあまりいないとは思いますが、OSSのコードを読むときに自分の使っていない方のlsの型定義が使われていることは稀によくあります。もしそういった状況に遭遇したらこの設定を試してみてください。

Discussion