Skip to content

Latest commit

 

History

History
69 lines (50 loc) · 2.52 KB

README.md

File metadata and controls

69 lines (50 loc) · 2.52 KB
Raw

coc-toml

npm version

toml language server extension for coc.nvim.

Powered by taplo

! Important

  • Issues and pull requests are all welcome. I'm a beginner in rust and ts. So, please tell me if I'm wrong or going to bad way to implement this.
  • This plugin supports coc 0.0.80 now.

Install

  • from coc command :CocInstall coc-toml
  • from plugin manager
    • (e.x) dein.vim 
      [[plugins]]
repo    = 'kkiyama117/coc-toml'
depends = 'coc.nvim'
    • I checked this plugin(v1.2.5) works with dein.vim and vim-plug

Add external schemas

You can add external schema config for specific type of toml like dein.nvim config file. To read details, see vim help(If installed with plugin manager) or doc txt on the web and taplo doc.

Keymaps

This plugin has no unique keymaps now. Use your own keybinding or commands for coc.nvim. See coc.nvim document.

Features

lsp support

  • You can format and lint all kind of toml file.
  • Completion is supported on some format of toml files.
    • (e.x.) pyproject.toml, rustfmt.toml, Cargo.toml, dein.nvim ...
    • default schema and rules are here

commands

  • toml.syntaxTree -> show syntaxTree like rust-analyzer does.
  • toml.downloadSchemas -> Download all schemas to local.
  • toml.tomlToJson -> convert toml to json. If you run it with visualmode, convert toml in selected range instead of it in the whole of document.
  • toml.jsonToToml -> convert json to toml. If you run it with visualmode, convert json in selected range instead of it in the whole of document.
    • Keep in mind if coc-toml is active when using these command (especially jsonToToml).

options

there are many options for this coc-extension. see :help coc-toml-options. if you need to set these options, edit your coc-settings.json(or run :CocConfig).

Develop

if you want to build from sources or debug this repo, switch to main branch and run yarn --frozen-lockfile to build.

License

MIT.

Dependencies