VimPlug/vim-javascript-syntax
1
0
Fork 0
mirror of https://github.com/jelera/vim-javascript-syntax.git synced 2025-12-07 13:24:36 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Add git-flow instructions for new commits

Browse Source
This commit is contained in:
Jose Elera
2016-02-24 03:29:18 -06:00
parent 7064a6e555
commit 747f267214
1 changed files with 34 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

52
README.markdown
View File

@@ -17,12 +17,20 @@ This version of this file features the following text highlights:
- Operation, comparison and logical symbols (`=`,`==`,`===`,`!=`,etc.).
- Separate highlight of the arguments. Thanks to [Billychan](https://github.com/jelera/vim-javascript-syntax/commit/b03f40ff6ddf605ac146634a651632d6c1e8a50b).
To enable code folding add the following to your `.vimrc`.
```vim
au FileType javascript call JavaScriptFold()
```
### [Screenshots](http://imgur.com/a/7bnu3)
This is the stock Javascript syntax file
#### Solarized Light
![Stock Vim JavaScript syntax file](http://i.imgur.com/FCVLMgl.png)
This is with the Enhanced Syntax file
![Enhanced JavaScript Vim syntax](http://i.imgur.com/yGY3Cmm.png)
#### Hybrid
![Stock Vim JavaScript syntax file](http://i.imgur.com/cGb3EjH.png)
This is with the Enhanced Syntax file
![Enhanced JavaScript Vim syntax](http://i.imgur.com/cmgdlO6.png)
### Installation
- Using [NeoBundle](https://github.com/Shougo/neobundle.vim) **(Which I recommend)**,
add this line to your `.vimrc`
@@ -44,29 +52,37 @@ Plugin 'jelera/vim-javascript-syntax'
```bash
git clone https://github.com/jelera/vim-javascript-syntax.git ~/.vim/bundle/vim-javascript-syntax
```
### Suggested Companion Plugins
- **Indentation**, 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** by [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
Always welcome, make sure your commit message should follow this
This project follows the
[Git-flow](http://nvie.com/posts/a-successful-git-branching-model/) methodology,
this will keep the master branch clean for new stable releases.
More about Git-flow at:
- [Daniel Kummer's Git Flow cheatsheet](http://danielkummer.github.io/git-flow-cheatsheet/)
- [Sayanee Basu's Build Podcast - Git Flow](https://www.youtube.com/watch?v=Hh-jJcJ5IJ8)
#### For new contributors
Follow this steps
- Clone this repository.
- Using the command line, run `git flow init -d`.
- Checkout the `develop` branch.
- For new features: Create a new `feature` branch using git-flow.
- For bugfixes: Commit in the `develop` branch.
- Bump the date on the syntax file.
- When done, don't forget to push the `develop` branch.
- Submit a pull request.
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)
### [Screenshots](http://imgur.com/a/7bnu3)
This is the stock Javascript syntax file
#### Solarized Light
![Stock Vim JavaScript syntax file](http://i.imgur.com/FCVLMgl.png)
This is with the Enhanced Syntax file
![Enhanced JavaScript Vim syntax](http://i.imgur.com/yGY3Cmm.png)
#### Hybrid
![Stock Vim JavaScript syntax file](http://i.imgur.com/cGb3EjH.png)
This is with the Enhanced Syntax file
![Enhanced JavaScript Vim syntax](http://i.imgur.com/cmgdlO6.png)
### License
The same as Vim