Docs: supported editors page (#483)

Signed-off-by: Ievgenii Shepeliuk <eshepelyuk@gmail.com>
StyraInc · Nov 17, 2023 · e71ff0a · e71ff0a
1 parent 227e454
commit e71ff0a
Show file tree

Hide file tree

Showing 2 changed files with 31 additions and 0 deletions.
diff --git a/docs/assets/editors-neovim.png b/docs/assets/editors-neovim.png
diff --git a/docs/editor-support.md b/docs/editor-support.md
@@ -0,0 +1,31 @@
+# Editor support
+
+## Neovim via none-ls
+
+[none-ls](https://github.com/nvimtools/none-ls.nvim) - Use Neovim as a language server to inject LSP diagnostics, code actions, and more via Lua.
+
+Minimal installation via [VimPlug](https://github.com/junegunn/vim-plug)
+
+```vim
+Plug 'nvim-lua/plenary.nvim'
+Plug 'nvimtools/none-ls.nvim'
+
+lua <<EOF
+local null_ls = require("null-ls")
+null_ls.setup {
+    sources = { null_ls.builtins.diagnostics.regal }
+}
+EOF
+```
+
+Using sample rego file `test.rego` with following content
+
+```rego
+package test
+
+default allowRbac := true
+```
+
+diagnostics may look like this.
+
+![regal in none-ls](./assets/editors-neovim.png)