A language server for nginx.conf
Project description
Nginx Language Server
A Language Server for nginx.conf
.
Still under constructions, expect big changes and breaking changes for a while.
Capabilities
nginx-language-server currently partially supports the following Language Server capabilities with more to be added in the future.
Language Features
Installation
From your command line (bash / zsh), run:
pip install -U nginx-language-server
-U
ensures that you're pulling the latest version from pypi.
Alternatively, consider using pipx to keep nginx-language-server isolated from your other Python dependencies.
Editor Setup
The following instructions show how to use nginx-language-server with your development tooling. The instructions assume you have already installed nginx-language-server.
Vim / Neovim
With coc.nvim, put the following in coc-settings.json
:
"languageserver": {
"nginx-language-server": {
"command": "nginx-language-server",
"filetypes": ["nginx"],
"rootPatterns": ["nginx.conf", ".git"]
}
},
In your vimrc, I recommend putting in the following lines to ensure variables complete / hover correcty:
augroup custom_nginx
autocmd!
autocmd FileType nginx set iskeyword+=$
autocmd FileType nginx let b:coc_additional_keywords = ['$']
augroup end
Note: this list is non-exhaustive. If you know of a great choice not included in this list, please submit a PR!
Inspiration
The useful language data for nginx is ported from vscode-nginx-conf-hint. I would have used this library directly, but alas! It's written only for VSCode and I use Neovim.
Written by
Samuel Roeca samuel.roeca@gmail.com
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for nginx-language-server-0.5.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | eb03f639c37e343d1939cf59df12676f91c4165352f6c1d075a13160859d6c69 |
|
MD5 | 0e9e4864db05859508f823691b2848df |
|
BLAKE2b-256 | 61713fb41301e955ba0a48129ee07f90a76446c672d7508ca4088e34a876e03c |
Hashes for nginx_language_server-0.5.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0f24d6d4e110063defe3d2f105e90d8467a360d6e3ed2431eee54569340e42cc |
|
MD5 | 25f8452a65b85e1ed63412723c18e88c |
|
BLAKE2b-256 | c9275f4809488b2d13ee6c3b9d17d6e6e976beba1d38c38e20d4a7222f651c30 |