📝

nvim-lspでtsconfig.jsonとかの補完をする方法(JSON schema)

2021/05/15に公開約1,500字

追記

SchemaStore.nvim というプラグインが出てきました。
基本的にこの記事で説明されていることをやってくれてさらに定期的に更新されるのでこのプラグインを使うのがおすすめです。


neovim の built-in lsp の話です。lspconfig が入ってるのが前提です。

基本的にはjsonlsの設定で

require("lspconfig")["jsonls"].setup({
    filetypes = {"json", "jsonc"},
    settings = {
        json = {
            schemas = {
                {fileMatch = {"package.json"}, url = "https://json.schemastore.org/package.json"},
                {fileMatch = {"tsconfig*.json"}, url = "https://json.schemastore.org/tsconfig.json"},
            }
        }
    },
})

みたいな感じでつらつらと schema を探して書いていけばできます。
しかしこれを一々書くのはとても面倒臭いです。そこで上のコードの URL にもあるschemastoreというサイトを使います。
このサイトの

https://www.schemastore.org/api/json/catalog.json
にはまさに上の設定通りの schema のカタログが用意されており、これを使えたら便利だと思いませんか?
ただ、json をパースしてとかやるのも面倒臭いのでTypescriptToLuaというツールを使います。
https://typescripttolua.github.io
ここの playground に先程のカタログの json を Typescript のオブジェクトとして貼り付けると、なんと lua のコードで出力してくれます。あとはそのコードをコピペしてくるだけです。

変換したものを一応 gist に用意しておきました。

https://gist.github.com/nazo6/abd12b74d1862e50939049602110c159

このファイルを適当なところに置いて

local catalog_data = require("schema-catalog")
local schemas = catalog_data.schemas

require("lspconfig")["jsonls"].setup({
    filetypes = {"json", "jsonc"},
    settings = {
        json = {
            schemas = schemas
        }
    },
})

みたいな感じにすればこれでほぼ全てのナントカ config みたいな JSON ファイルが補完できるようになります。ドキュメントもあります。

GitHubで編集を提案

Discussion

ログインするとコメントできます