1
0
Fork 0
mirror of synced 2024-11-26 18:55:34 -05:00
ultimate-vim/sources_non_forked/nginx.vim/README.md

73 lines
2.3 KiB
Markdown
Raw Normal View History

2017-11-24 08:59:41 -05:00
# nginx.vim
## Description
2019-08-22 11:36:17 -04:00
2017-11-24 08:59:41 -05:00
[Vim](http://www.vim.org/) plugin for [Nginx](http://www.nginx.org)
2019-08-22 11:36:17 -04:00
2017-11-24 08:59:41 -05:00
## Features
2019-08-22 11:36:17 -04:00
2017-11-24 08:59:41 -05:00
The plugin is based on the recent vim-plugin distributed with `nginx-1.12.0` and additionally features the following syntax improvements:
- Highlight IPv4 and IPv6 addresses
- Mark insecure `ssl_protocols` as errors
- Inline template syntax highlight for **ERB** and **Jinja**
- Inline syntax highlight for **LUA**
- Improve integer matching
- Syntax highlighting for `proxy_next_upstream` options
- Syntax highlighting for `sticky` options
- Syntax highlighting for `upstream` `server` options
- More to come!
Furthermore:
- Remove annoying delimiters, resulting in strange word-boundaries
*Note: Also check out [sslsecure.vim](https://github.com/chr4/sslsecure.vim): it supports highlighting insecure SSL/TLS cipher suites and protocols in all your files!*
## Screenshots
2019-08-22 11:36:17 -04:00
2017-11-24 08:59:41 -05:00
A `server` block with highlighting of insecure `ssl_protocol` options:
![nginx server block with SSL configuration](https://chr4.org/images/nginx_ssl.png)
An `upstream` block with highlighted options:
![nginx upstream configuration](https://chr4.org/images/nginx_upstream.png)
Embedded highlighting for ERB and Jinja templates:
![Embedded highlighting for ERB and Jinja templates](https://chr4.org/images/nginx_templating.png)
Embedded LUA syntax highlighting:
![Embedded LUA syntax highlighting](https://chr4.org/images/nginx_lua.png)
## References
2019-08-22 11:36:17 -04:00
2017-11-24 08:59:41 -05:00
- Based on the original `nginx-1.12.0/contrib/vim`
- IPv4 and IPv6 address highlighting, based on expressions found in [this forum post](http://vim.1045645.n5.nabble.com/IPv6-support-for-quot-dns-quot-zonefile-syntax-highlighting-td1197292.html)
- [Blog post](https://chr4.org/blog/2017/04/14/better-syntax-highlighting-and-snippets-for-nginx-in-vim/) introducing this plugin including some more examples
2019-08-22 11:36:17 -04:00
For help with secure cipher selection, visit [Mozillas SSL Configuration Generator](https://ssl-config.mozilla.org/)
2017-11-24 08:59:41 -05:00
## Installation
2018-11-01 06:03:42 -04:00
### Pathogen
2019-08-22 11:36:17 -04:00
2018-11-01 06:03:42 -04:00
```bash
git clone https://github.com/chr4/nginx.vim ~/.vim/bundle/nginx.vim
```
2017-11-24 08:59:41 -05:00
2018-11-01 06:03:42 -04:00
### Other (Plug, Dein.vim, Vundle)
2017-11-24 08:59:41 -05:00
```vim
" Plug
Plug 'chr4/nginx.vim'
" Dein.vim
call dein#add('chr4/nginx.vim')
" Vundle
Plugin 'chr4/nginx.vim'
```
Optionally, if you like [Jinja](http://jinja.pocoo.org/) template syntax highlighting, install `lepture/vim-jinja`, too.