From 747f267214563a9375edc29012cc5c3d7cd8033b Mon Sep 17 00:00:00 2001 From: Jose Elera Date: Wed, 24 Feb 2016 03:29:18 -0600 Subject: [PATCH 1/3] Add git-flow instructions for new commits --- README.markdown | 52 ++++++++++++++++++++++++++++++++----------------- 1 file changed, 34 insertions(+), 18 deletions(-) diff --git a/README.markdown b/README.markdown index 19b4ecd..9517dc9 100644 --- a/README.markdown +++ b/README.markdown @@ -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 From 783f31a8ea217715ff140794d783d1afa99b0a75 Mon Sep 17 00:00:00 2001 From: Jose Elera Date: Wed, 24 Feb 2016 03:35:16 -0600 Subject: [PATCH 2/3] Bump the date and the version This convention must be followed in order to have better documentation and support while debugging and testing. --- syntax/javascript.vim | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/syntax/javascript.vim b/syntax/javascript.vim index 3bdf249..494cc35 100644 --- a/syntax/javascript.vim +++ b/syntax/javascript.vim @@ -1,13 +1,12 @@ " Vim syntax file " Language: JavaScript " Maintainer: Jose Elera Campana -" Last Modified: Mon 09 Dec 2013 01:20:46 PM CST -" Version: 0.8.1 -" Changes: Go to https://github.com/jelera/vim-javascript-syntax for -" recent changes. +" Last Modified: Wed 24 Feb 2016 03:35:03 AM CST +" Version: 0.8.2 " Credits: Zhao Yi, Claudio Fleiner, Scott Shattuck (This file is based " on their hard work), gumnos (From the #vim IRC Channel in -" Freenode) +" Freenode), all the contributors at this project's github page +" (https://github.com/jelera/vim-javascript-syntax/graphs/contributors) if !exists("main_syntax") if version < 600 From e1ac4336810108dfe5a237a4cd42c5fc4e251bf7 Mon Sep 17 00:00:00 2001 From: Jose Elera Date: Wed, 24 Feb 2016 03:42:41 -0600 Subject: [PATCH 3/3] Add instructions for version numbering --- README.markdown | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.markdown b/README.markdown index 9517dc9..db8f2fa 100644 --- a/README.markdown +++ b/README.markdown @@ -63,7 +63,8 @@ The project is unmaintained for now, but you could fork it and improve upon it. ### Contributions 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. +this will keep the master branch clean for new stable releases. Also the +version numbering convention will be [this one](http://stackoverflow.com/a/65750) More about Git-flow at: - [Daniel Kummer's Git Flow cheatsheet](http://danielkummer.github.io/git-flow-cheatsheet/) @@ -76,7 +77,7 @@ Follow this steps - 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. +- Bump the date and version number on the syntax file. - When done, don't forget to push the `develop` branch. - Submit a pull request.