mirror of
https://github.com/jelera/vim-javascript-syntax.git
synced 2025-12-10 06:31:55 +08:00
Add git-flow instructions for new commits
This commit is contained in:
@@ -17,12 +17,20 @@ This version of this file features the following text highlights:
|
|||||||
- Operation, comparison and logical symbols (`=`,`==`,`===`,`!=`,etc.).
|
- Operation, comparison and logical symbols (`=`,`==`,`===`,`!=`,etc.).
|
||||||
- Separate highlight of the arguments. Thanks to [Billychan](https://github.com/jelera/vim-javascript-syntax/commit/b03f40ff6ddf605ac146634a651632d6c1e8a50b).
|
- 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
|
### [Screenshots](http://imgur.com/a/7bnu3)
|
||||||
au FileType javascript call JavaScriptFold()
|
This is the stock Javascript syntax file
|
||||||
```
|
#### Solarized Light
|
||||||
|

|
||||||
|
|
||||||
|
This is with the Enhanced Syntax file
|
||||||
|

|
||||||
|
|
||||||
|
#### Hybrid
|
||||||
|

|
||||||
|
|
||||||
|
This is with the Enhanced Syntax file
|
||||||
|

|
||||||
### Installation
|
### Installation
|
||||||
- Using [NeoBundle](https://github.com/Shougo/neobundle.vim) **(Which I recommend)**,
|
- Using [NeoBundle](https://github.com/Shougo/neobundle.vim) **(Which I recommend)**,
|
||||||
add this line to your `.vimrc`
|
add this line to your `.vimrc`
|
||||||
@@ -44,29 +52,37 @@ Plugin 'jelera/vim-javascript-syntax'
|
|||||||
```bash
|
```bash
|
||||||
git clone https://github.com/jelera/vim-javascript-syntax.git ~/.vim/bundle/vim-javascript-syntax
|
git clone https://github.com/jelera/vim-javascript-syntax.git ~/.vim/bundle/vim-javascript-syntax
|
||||||
```
|
```
|
||||||
|
|
||||||
### Suggested Companion Plugins
|
### 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.
|
- **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.
|
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)
|
- **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)
|
- Popular **third-party libraries support** like jQuery, YUI, Prototype, by [javascript-libraries-syntax](https://github.com/othree/javascript-libraries-syntax.vim)
|
||||||
|
|
||||||
|
|
||||||
### Contributions
|
### 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)
|
[**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
|
|
||||||

|
|
||||||
|
|
||||||
This is with the Enhanced Syntax file
|
|
||||||

|
|
||||||
|
|
||||||
#### Hybrid
|
|
||||||

|
|
||||||
|
|
||||||
This is with the Enhanced Syntax file
|
|
||||||

|
|
||||||
|
|
||||||
### License
|
### License
|
||||||
The same as Vim
|
The same as Vim
|
||||||
|
|||||||
Reference in New Issue
Block a user