https://github.com/creativenull/web.nvim
Web development plugin for neovim
https://github.com/creativenull/web.nvim
Last synced: 4 months ago
JSON representation
Web development plugin for neovim
- Host: GitHub
- URL: https://github.com/creativenull/web.nvim
- Owner: creativenull
- License: mit
- Created: 2023-10-02T14:27:28.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-07-14T18:20:36.000Z (11 months ago)
- Last Synced: 2024-10-06T01:22:26.154Z (8 months ago)
- Language: Lua
- Homepage:
- Size: 93.8 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# web.nvim
The all-in-one solution to setup a web development environment in neovim.
> [!IMPORTANT]
> Still under development but feel free to use and give feedback on anything missing.
## Features
- No [`lspconfig` plugin][lspconfig-url] needed, using builtin `vim.lsp.start()`
- Automatically setup lsp servers based on project (tsserver, eslint, css, html, volar, svelte, astrojs, tailwindcss, WIP: angularls)
- Automatically setup formatters (prettier, WIP: biomejs)
- Format code - `:WebLspFormat`, additional set the `format_on_save` option to format on save
- Run code actions on save feature (WIP)
- Refactor code - `:WebRefactorAction`
- Quickfix code - `:WebQuickfixAction`
- Source action - `:WebSourceAction`
- Inlay hints (if using nvim 0.10 and above, opt-out feature)
- Tsserver specific
- Organize imports - `:WebTsserverOrganizeImports`
- Go to source definition, helpful when you do not want d.ts but direct to source file (for example, go to .js file instead of d.ts definition) - `:WebTsserverGoToSourceDefinition`
- Eslint specific
- Fix eslint errors - `:WebEslintFixAll`
- Run `package.json` scripts via `:WebRun`
- Debugging: [nvim-dap][nvim-dap-url] is required (WIP)
## Install
### vim-plug
```vimscript
Plug 'creativenull/web.nvim'
```
### lazy.nvim
```lua
{
'creativenull/web.nvim',
config = function()
-- ...
end,
}
```
## Setup
You can setup the plugin using the following the minimal code example.
```lua
-- You can use that exact same on_attach you have already defined for lspconfig
-- or create one like below
local on_attach = function(client, bufnr)
-- ...
end
local capabilities = vim.lsp.protocol.make_client_capabilities()
require('web').setup({
on_attach = on_attach,
capabilities = capabilities,
})
```
Following is the code example with all the settings, to show all the options and
their default values.
```lua
-- You can use that exact same on_attach you have already defined for lspconfig
-- or create one like below
local on_attach = function(client, bufnr)
-- ...
end
local capabilities = vim.lsp.protocol.make_client_capabilities()
require('web').setup({
on_attach = on_attach,
capabilities = capabilities,
-- Format the buffer using formatting tools prettier and biomejs (WIP), if available
format_on_save = false,
-- LSP Server settings
lsp = {
json = { disabled = false },
css = { disabled = false },
html = { disabled = false },
-- Astro LSP settings
astro = {
disabled = false,
inlay_hints = vim.fn.has("nvim-0.10") == 1 and "minimal" or "",
},
-- Volar.js (Vue) LSP settings
volar = {
disabled = false,
inlay_hints = vim.fn.has("nvim-0.10") == 1,
},
-- Svelte LSP settings
svelte = {
disabled = false,
inlay_hints = vim.fn.has("nvim-0.10") == 1 and "minimal" or "",
},
-- JS/TS Server LSP settings
tsserver = {
disabled = false,
-- Enable the minimal option of inlay hints if runnning on nvim 0.10 or above
inlay_hints = vim.fn.has("nvim-0.10") == 1 and "minimal" or "",
-- Code actions to run on save, not implemented yet
-- Waiting for this PR to be stable/merged (https://github.com/neovim/neovim/pull/22598)
code_actions_on_save = {
"source.organizeImports.ts",
"source.fixAll.ts",
"source.removeUnused.ts",
"source.addMissingImports.ts",
"source.removeUnusedImports.ts",
"source.sortImports.ts",
},
},
-- Eslint LSP settings
eslint = {
disabled = false,
workspace = true,
flat_config = false,
code_actions_on_save = {
"source.fixAll.eslint",
},
},
-- Tailwind CSS LSP settings
tailwindcss = {
disabled = false,
additional_filetypes = nil,
},
},
})
```
### Capabilities
If using nvim-cmp or similar that provide you with custom capabilities, then you
can use that. For example:
```lua
local capabilities = require('cmp_nvim_lsp').default_capabilities()
```
Or if you have a custom completion plugin that doesn't come with that support
then use the following:
```lua
local capabilities = vim.lsp.protocol.make_client_capabilities()
-- Let LSP server know you support snippets too
capabilities.textDocument.completion.completionItem.snippetSupport = true
capabilities.textDocument.completion.completionItem.preselectSupport = true
capabilities.textDocument.completion.completionItem.insertReplaceSupport = true
capabilities.textDocument.completion.completionItem.resolveSupport = {
properties = {
'documentation',
'detail',
'additionalTextEdits',
},
}
```
[lspconfig-url]: https://github.com/neovim/nvim-lspconfig
[mason-url]: https://github.com/williamboman/mason.nvim
[nvim-dap-url]: https://github.com/mfussenegger/nvim-dap