mirror of
https://github.com/jelera/vim-javascript-syntax.git
synced 2025-12-08 21:54:52 +08:00
78 lines
3.1 KiB
Markdown
78 lines
3.1 KiB
Markdown
# Enhanced JavaScript Syntax for Vim
|
|
|
|
## Credits
|
|
- Zhao Yi, Claudio Fleiner, Scott Shattuck (This file is based on their hard work)
|
|
- gumnos (From the #vim IRC Channel in Freenode) (Who helped me figured out the
|
|
crazy Vim Regexes)
|
|
|
|
## Description
|
|
This file is a fork of [this file](http://www.vim.org/scripts/script.php?script_id=1491)
|
|
and [the stock one](http://fleiner.com/vim/download.html)
|
|
|
|
This version of this file features the following text highlights:
|
|
|
|
- Parenthesis, curly and regular brackets.
|
|
- The semicolon or comma at the end of line.
|
|
- Browser, DOM and "Ajax" keywords like objects, methods, properties and others.
|
|
- Operation, comparison and logical symbols (`=`,`==`,`===`,`!=`,etc.).
|
|
- Separate highlight of the arguments. Thanks to [Billychan](https://github.com/jelera/vim-javascript-syntax/commit/b03f40ff6ddf605ac146634a651632d6c1e8a50b).
|
|
|
|
### Rationale
|
|
While there are already a few syntax files in the wild (some even forks from this project), the goal is to have a syntax file that has current keywords for modern ES/JS development and to be fairly lean and quick on loading.
|
|
|
|
## Screenshots
|
|
This is the stock Javascript syntax file
|
|
#### Solarized Light
|
|
|
|
|
|
This is with the Enhanced Syntax file
|
|
|
|
|
|
More screenshots [here](http://imgur.com/a/7bnu3).
|
|
|
|
#### Hybrid
|
|
|
|
|
|
This is with the Enhanced Syntax file
|
|
|
|
|
|
## Installation
|
|
- Using [Vim-Plug](https://github.com/junegunn/vim-plug) **(Which I recommend)**,
|
|
add this line to your `.vimrc`
|
|
|
|
```vim
|
|
Plug 'jelera/vim-javascript-syntax'
|
|
```
|
|
|
|
- Using [Vundle](https://github.com/gmarik/vundle),
|
|
add this line to your `.vimrc`
|
|
|
|
```vim
|
|
Plugin 'jelera/vim-javascript-syntax'
|
|
```
|
|
|
|
- Using [Pathogen](https://github.com/tpope/vim-pathogen),
|
|
run this command in your shell
|
|
|
|
```bash
|
|
git clone https://github.com/jelera/vim-javascript-syntax.git ~/.vim/bundle/vim-javascript-syntax
|
|
```
|
|
|
|
## Suggested Companion Plugins
|
|
- **Indentation**
|
|
The recommended way is to use [Prettier](https://prettier.io/docs/en/vim.html) and [ALE](https://github.com/dense-analysis/ale).
|
|
|
|
~~It can be achieved with [Javascript-Indent](https://github.com/vim-scripts/JavaScript-Indent) by Preston Koprivica. On my testing, it has proved to be the most capable and also indents HTML and JS inside HTML.
|
|
The project is unmaintained for now, but you could fork it and improve upon it.~~
|
|
- **Autocompletion**
|
|
- [Coc.vim](https://github.com/neoclide/coc.nvim), as it supports **Language Server Protocol** as VSCode.
|
|
- [Tern for Vim](https://github.com/marijnh/tern_for_vim)
|
|
- Popular **third-party libraries support** like jQuery, YUI, Prototype, by [javascript-libraries-syntax](https://github.com/othree/javascript-libraries-syntax.vim)
|
|
|
|
## Contributions
|
|
While all contributions are always welcome, make sure your commit message follow this
|
|
[**convention**](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
|
|
|
|
## License
|
|
The same as Vim
|