Meta

• License: GNU General Public License v3 (GPLv3) (GPL-3.0-only)
• Author:Sam Roeca
• Tags nginx, completion, refactoring, vim, neovim, lsp, language-server-protocol
• Requires: Python <3.14, >=3.9

Classifiers

• Development Status
  • 2 - Pre-Alpha
• Intended Audience
  • Developers
• License
  • OSI Approved :: GNU General Public License v3 (GPLv3)
• Operating System
  • OS Independent
• Programming Language
  • Python :: 3
  • Python :: 3.9
  • Python :: 3.10
  • Python :: 3.11
  • Python :: 3.12
  • Python :: 3.13
• Topic
  • Software Development :: Code Generators
  • Software Development :: Libraries :: Python Modules
  • Text Editors :: Integrated Development Environments (IDE)
  • Utilities
• Typing
  • Typed

Nginx Language Server

ALanguage Server fornginx.conf.

Still under construction, expect big / potentially 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

• textDocument/completion
• textDocument/hover

Installation

From your command line (bash / zsh), run:

pipinstall-Unginx-language-server

-U ensures that you're pulling the latest version from pypi.

Alternatively, consider usingpipx 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

Withcoc.nvim, put the following incoc-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 correctly:

augroup custom_nginx  autocmd!  autocmdFileType nginxsetlocaliskeyword+=$  autocmdFileType nginxletb:coc_additional_keywords= ['$']augroupend

Alternatively, you can usecoc-nginx.

letg:coc_global_extensions= ['@yaegassy/coc-nginx']

Note: this list is non-exhaustive. If you know of a great choice not included in this list, please submit a PR!

Command line

nginx-language-server can be run directly from the command line.

$nginx-language-server--helpusage: nginx-language-server [-h] [--version] [--tcp] [--host HOST]                             [--port PORT] [--log-file LOG_FILE] [-v]Nginx language server: an LSP server for nginx.conf.optional arguments:  -h, --help           show this help message and exit  --version            display version information and exit  --tcp                use TCP server instead of stdio  --host HOST          host for TCP server (default 127.0.0.1)  --port PORT          port for TCP server (default 2088)  --log-file LOG_FILE  redirect logs to the given file instead of writing to                       stderr  -v, --verbose        increase verbosity of log outputExamples:    Run from stdio: nginx-language-server

Inspiration

The useful language data for nginx is ported fromvscode-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 Roecasamuel.roeca@gmail.com

Verified details

Maintainers

pappasam

Unverified details

Project links

• Homepage
• Changelog
• Issues
• Repository

• Download URL:nginx_language_server-0.9.0.tar.gz
• Upload date: Apr 18, 2025
• Size: 226.5 kB
• Tags: Source
• Uploaded using Trusted Publishing? No
• Uploaded via: poetry/2.1.2 CPython/3.13.3 Linux/6.8.0-1021-azure

See more details on using hashes here.

• Download URL:nginx_language_server-0.9.0-py3-none-any.whl
• Upload date: Apr 18, 2025
• Size: 232.3 kB
• Tags: Python 3
• Uploaded using Trusted Publishing? No
• Uploaded via: poetry/2.1.2 CPython/3.13.3 Linux/6.8.0-1021-azure

See more details on using hashes here.