https://github.com/yaegassy/coc-nginx

nginx-language-server extension for coc.nvim
https://github.com/yaegassy/coc-nginx

coc coc-extensions coc-nvim neovim nginx vim

Last synced: 2 days ago
JSON representation

nginx-language-server extension for coc.nvim

• Host: GitHub
• URL: https://github.com/yaegassy/coc-nginx
• Owner: yaegassy
• License: mit
• Created: 2021-04-20T01:09:15.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2023-05-16T06:54:03.000Z (over 1 year ago)
• Last Synced: 2024-10-18T11:02:02.821Z (23 days ago)
• Topics: coc, coc-extensions, coc-nvim, neovim, nginx, vim
• Language: TypeScript
• Homepage: https://www.npmjs.com/package/@yaegassy/coc-nginx
• Size: 91.8 KB
• Stars: 29
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# coc-nginx

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



## Features

- Completion

- Hover

- Format by [nginxfmt](https://pypi.org/project/nginxfmt/)

- Built-in installer

## Install

**CocInstall**:

```vim

:CocInstall @yaegassy/coc-nginx

```

> scoped packages

**vim-plug**:

```vim

Plug 'yaegassy/coc-nginx', {'do': 'yarn install --frozen-lockfile'}

```

## Detect: nginx-language-server

1. `nginx.server.commandPath`

2. current environment PATH (e.g. nginx-language-server in venv, or global)

3. builtin nginx-language-server (Installation commands are also provided)

## Bult-in install

coc-nginx allows you to create an extension-only "venv" and install "nginx-language-server".

The first time you use coc-nginx, if nginx-language-server is not detected, you will be prompted to do a built-in installation.

You can also run the installation command manually.

```vim

:CocCommand nginx.installLanguageServer

```

## Configuration options

- `nginx.enable`: Enable coc-nginx extension, default: `true`

- `nginx.server.commandPath`: The custom path to the nginx-language-server (Absolute path), default: `""`

- `nginx.builtin.pythonPath`: Python 3.x path (Absolute path) to be used for built-in install, default: `""`

- `nginx.nginxfmt.commandPath`: The custom path to the nginxfmt (Absolute path), default: `""`

- `nginx.nginxfmt.indent`: Specify number of spaces for indentation, default: `4`

## Commands

- `nginx.installLanguageServer`: Install/Upgrade nginx-language-server and more tools (builtin)

  - It will be installed in this path:

    - Mac/Linux: `~/.config/coc/extensions/@yaegassy/coc-nginx-data/nginx-language-server/venv/bin/nginx-language-server`

    - Windows: `~/AppData/Local/coc/extensions/@yaegassy/coc-nginx-data/nginx-language-server/venv/Scripts/nginx-language-server.exe`

- `nginx.format`: Run nginxfmt

## Known issue I have identified

There seems to be an error when saving the file.

**Repro**:

`:CocCommand workspace.showOutput` -> `Choose by number:` -> "Enter" the number of the `nginx-language-server`.

## Thanks

- [pappasam/nginx-language-server](https://github.com/pappasam/nginx-language-server)

## License

MIT

---

> This extension is built with [create-coc-extension](https://github.com/fannheyward/create-coc-extension)