https://github.com/kkiyama117/coc-toml

Toml extension for coc-nvim, using taplo for lsp engine
https://github.com/kkiyama117/coc-toml

coc coc-extension coc-nvim coc-toml toml

Last synced: 5 days ago
JSON representation

Toml extension for coc-nvim, using taplo for lsp engine

• Host: GitHub
• URL: https://github.com/kkiyama117/coc-toml
• Owner: kkiyama117
• License: mit
• Created: 2020-09-17T22:44:00.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2023-02-06T10:01:34.000Z (almost 2 years ago)
• Last Synced: 2024-05-01T17:13:34.286Z (6 months ago)
• Topics: coc, coc-extension, coc-nvim, coc-toml, toml
• Language: TypeScript
• Homepage: https://www.npmjs.com/package/coc-toml
• Size: 18.9 MB
• Stars: 58
• Watchers: 4
• Forks: 1
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# coc-toml

[![npm version](https://badge.fury.io/js/coc-toml.svg)](https://badge.fury.io/js/coc-toml)

toml language server extension for [coc.nvim](https://github.com/neoclide/coc.nvim).

Powered by [taplo](https://github.com/tamasfe/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](https://github.com/kkiyama117/coc-toml/blob/main/doc/coc-toml.txt) and [taplo doc](https://taplo.tamasfe.dev/configuration/#schemas).

## Keymaps

This plugin has no unique keymaps now.

Use your own keybinding or commands for coc.nvim.

See [coc.nvim document](https://github.com/neoclide/coc.nvim/blob/a1688fc34143b1b7a25ab8c98438088199863e35/doc/coc.txt#L1291).

## 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](https://taplo.tamasfe.dev/configuration/#builtin-schemas)

### 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

- [taplo](https://github.com/tamasfe/taplo)

  - to parse toml and some commands

- [coc.nvim](https://github.com/neoclide/coc.nvim)