1
0
Fork 0
mirror of synced 2024-11-26 18:55:34 -05:00
ultimate-vim/sources_non_forked/vim-javascript/README.md
2017-11-27 13:43:13 +08:00

2.7 KiB
Raw Blame History

vim-javascript

JavaScript bundle for vim, this bundle provides syntax highlighting and improved indentation.

Installation

Install with Vundle

Add to vimrc:

Plugin 'pangloss/vim-javascript'

And install it:

:so ~/.vimrc
:PluginInstall

Install with vim-plug

Add to vimrc:

Plug 'pangloss/vim-javascript'

And install it:

:so ~/.vimrc
:PlugInstall

Install with pathogen

  git clone https://github.com/pangloss/vim-javascript.git ~/.vim/bundle/vim-javascript

Configuration Variables

The following variables control certain syntax highlighting plugins. You can add them to your .vimrc to enable their features.


let g:javascript_plugin_jsdoc = 1

Enables syntax highlighting for JSDocs.

Default Value: 0


let g:javascript_plugin_ngdoc = 1

Enables some additional syntax highlighting for NGDocs. Requires JSDoc plugin to be enabled as well.

Default Value: 0


let g:javascript_plugin_flow = 1

Enables syntax highlighting for Flow.

Default Value: 0


set foldmethod=syntax

Enables code folding based on our syntax file.

Please note this can have a dramatic effect on performance and because it is a global vim option, we do not set it ourselves.

Concealing Characters

You can customize concealing characters by defining one or more of the following variables:

let g:javascript_conceal_function       = "ƒ"
let g:javascript_conceal_null           = "ø"
let g:javascript_conceal_this           = "@"
let g:javascript_conceal_return         = "⇚"
let g:javascript_conceal_undefined      = "¿"
let g:javascript_conceal_NaN            = ""
let g:javascript_conceal_prototype      = "¶"
let g:javascript_conceal_static         = "•"
let g:javascript_conceal_super          = "Ω"
let g:javascript_conceal_arrow_function = "⇒"

Contributing

This project uses the git flow model for development. There's a handy git module for git flow. If you'd like to be added as a contributor, the price of admission is 1 pull request. Please follow the general code style guides (read the code) and in your pull request explain the reason for the proposed change and how it is valuable.

Bug Reports

Report a bug on GitHub Issues.

License

Distributed under the same terms as Vim itself. See :help license.