Merge pull request #395 from pangloss/develop

Develop -> Master

Author: amadeus

README.md

@@ -1,67 +1,74 @@
-# vim-javascript v0.10.0
+# vim-javascript v1.0.0
 
-JavaScript bundle for vim, this bundle provides syntax and indent plugins.
+JavaScript bundle for vim, this bundle provides syntax highlighting and
+improved indentation.
 
-## A Quick Note on Regexes
 
-Vim 7.4 was released recently, and unfortunately broke how this plugin
-handles regexes. There was no real easy way for us to fix this unless we
-completely rewrote how regexes work.
+## Installation
 
-Good News: There was a recent update to Vim 7.4 that fixes this issue.
+### Install with [Vundle](https://github.com/gmarik/vundle)
 
-Make sure you are at least using Vim 7.4, with patches 1-7.
+Add to vimrc:
 
-If you are stuck on an older version of Vim 7.4 with no way to update,
-then simply perform the following commands to fix your current buffer:
+    Plugin 'pangloss/vim-javascript'
 
-```
-:set regexpengine=1
-:syntax enable
-```
+And install it:
 
-## Installation
+    :so ~/.vimrc
+    :PluginInstall
 
-### Install with [Vundle](https://github.com/gmarik/vundle)
+### Install with [vim-plug](https://github.com/junegunn/vim-plug)
 
 Add to vimrc:
 
-    Plugin 'pangloss/vim-javascript'
+    Plug 'pangloss/vim-javascript'
 
 And install it:
 
     :so ~/.vimrc
-    :PluginInstall
+    :PlugInstall
 
 ### Install with [pathogen](https://github.com/tpope/vim-pathogen)
 
       git clone https://github.com/pangloss/vim-javascript.git ~/.vim/bundle/vim-javascript
 
-## Configuration
+
+## Configuration Variables
 
 The following variables control certain syntax highlighting features. You can
 add them to your `.vimrc` to enable/disable their features.
 
-#### javascript_enable_domhtmlcss
+```
+let g:javascript_enable_domhtmlcss = 1
+```
 
 Enables HTML/CSS syntax highlighting in your JavaScript file.
 
 Default Value: 0
 
-#### b:javascript_fold
+-----------------
 
-Enables JavaScript code folding.
+```
+let g:javascript_ignore_javaScriptdoc = 1
+```
 
-Default Value: 1
+Disables JSDoc syntax highlighting
 
+Default Value: 0
 
-#### javascript_ignore_javaScriptdoc
+-----------------
 
-Disables JSDoc syntax highlighting
+```
+set foldmethod=syntax
+```
 
-Default Value: 0
+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
+
+## Concealing Characters
 
 You can customize concealing characters by defining one or more of the following
 variables:
@@ -77,6 +84,7 @@ variables:
     let g:javascript_conceal_super          = "Ω"
     let g:javascript_conceal_arrow_function = "⇒"
 
+
 ## Contributing
 
 This project uses the [git
@@ -87,6 +95,24 @@ 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 report
+
+## Bug Reports
 
 Report a bug on [GitHub Issues](https://github.com/pangloss/vim-javascript/issues).
+
+
+## A Quick Note on Regexes
+
+Vim 7.4 with patches LESS than 1-7 exhibits a bug that broke how we handle
+javascript regexes. Please update to a newer version or run the following
+commands to fix:
+
+```
+:set regexpengine=1
+:syntax enable
+```
+
+
+## License
+
+Distributed under the same terms as Vim itself. See `:help license`.

indent/javascript.vim

@@ -43,7 +43,10 @@ endif
 let s:js_keywords = '^\s*\(break\|catch\|const\|continue\|debugger\|delete\|do\|else\|finally\|for\|function\|if\|in\|instanceof\|let\|new\|return\|switch\|this\|throw\|try\|typeof\|var\|void\|while\|with\)'
 let s:expr_case = '^\s*\(case\s\+[^\:]*\|default\)\s*:\s*'
 " Regex of syntax group names that are or delimit string or are comments.
-let s:syng_strcom = 'string\|regex\|comment\c'
+let s:syng_strcom = '\%(\%(template\)\@<!string\|regex\|comment\)\c'
+
+" Regex of syntax group names that are or delimit template strings
+let s:syng_template = 'template\c'
 
 " Regex of syntax group names that are strings.
 let s:syng_string = 'regex\c'
@@ -60,25 +63,24 @@ let s:skip_expr = "synIDattr(synID(line('.'),col('.'),1),'name') =~ '".s:syng_st
 let s:line_term = '\s*\%(\%(\/\/\).*\)\=$'
 
 " Regex that defines continuation lines, not including (, {, or [.
-let s:continuation_regex = '\%([\\*+/.:]\|\%(<%\)\@<![=-]\|\W[|&?]\|||\|&&\|[^=]=[^=].*,\)' . s:line_term
+let s:continuation_regex = '\%([\\*/.:]\|+\@<!+\|-\@<!-\|\%(<%\)\@<!=\|\W[|&?]\|||\|&&\|[^=]=[^=>].*,\)' . s:line_term
 
 " Regex that defines continuation lines.
 " TODO: this needs to deal with if ...: and so on
-let s:msl_regex = s:continuation_regex.'|'.s:expr_case
+let s:msl_regex = s:continuation_regex.'\|'.s:expr_case
 
-let s:one_line_scope_regex = '\%(\<else\>\|\<\%(if\|for\|while\)\>\s*(.*)\)' . s:line_term
+let s:one_line_scope_regex = '\%(\%(\<else\>\|\<\%(if\|for\|while\)\>\s*(\%([^()]*\|[^()]*(\%([^()]*\|[^()]*(\%([^()]*\|[^()]*([^()]*)[^()]*\))[^()]*\))[^()]*\))\)\|=>\)' . s:line_term
 
 " Regex that defines blocks.
-let s:block_regex = '\%([{[]\)\s*\%(|\%([*@]\=\h\w*,\=\s*\)\%(,\s*[*@]\=\h\w*\)*|\)\=' . s:line_term
+let s:block_regex = '\%([{([]\)\s*\%(|\%([*@]\=\h\w*,\=\s*\)\%(,\s*[*@]\=\h\w*\)*|\)\=' . s:line_term
+
+let s:operator_first = '^\s*\%([*/.:?]\|\([-+]\)\1\@!\|||\|&&\)'
 
-let s:var_stmt = '^\s*(const\|let\|var)'
+let s:var_stmt = '^\s*\%(const\|let\|var\)'
 
 let s:comma_first = '^\s*,'
 let s:comma_last = ',\s*$'
 
-let s:ternary = '^\s\+[?|:]'
-let s:ternary_q = '^\s\+?'
-
 let s:case_indent = s:sw()
 let s:case_indent_after = s:sw()
 let s:m = matchlist(&cinoptions, ':\(.\)')
@@ -102,6 +104,11 @@ function s:IsInString(lnum, col)
   return synIDattr(synID(a:lnum, a:col, 1), 'name') =~ s:syng_string
 endfunction
 
+" Check if the character at lnum:col is inside a template string.
+function s:IsInTempl(lnum, col)
+  return synIDattr(synID(a:lnum, a:col, 1), 'name') =~ s:syng_template
+endfunction
+
 " Check if the character at lnum:col is inside a multi-line comment.
 function s:IsInMultilineComment(lnum, col)
   return !s:IsLineComment(a:lnum, a:col) && synIDattr(synID(a:lnum, a:col, 1), 'name') =~ s:syng_multiline
@@ -120,13 +127,13 @@ function s:PrevNonBlankNonString(lnum)
     " Go in and out of blocks comments as necessary.
     " If the line isn't empty (with opt. comment) or in a string, end search.
     let line = getline(lnum)
-    if line =~ '/\*'
+    if s:IsInMultilineComment(lnum, matchend(line, '/\*') - 1)
       if in_block
         let in_block = 0
       else
         break
       endif
-    elseif !in_block && line =~ '\*/'
+    elseif !in_block && s:IsInMultilineComment(lnum, matchend(line, '\*/') - 1)
       let in_block = 1
     elseif !in_block && line !~ '^\s*\%(//\).*$' && !(s:IsInStringOrComment(lnum, 1) && s:IsInStringOrComment(lnum, strlen(line)))
       break
@@ -146,9 +153,21 @@ function s:GetMSL(lnum, in_one_line_scope)
     " Otherwise, terminate search as we have found our MSL already.
     let line = getline(lnum)
     let col = match(line, s:msl_regex) + 1
+    let line2 = getline(msl)
+    let col2 = matchend(line2, ')')
     if (col > 0 && !s:IsInStringOrComment(lnum, col)) || s:IsInString(lnum, strlen(line))
       let msl = lnum
+
+    " if there are more closing brackets, continue from the line which has the matching opening bracket
+    elseif col2 > 0 && !s:IsInStringOrComment(msl, col2) && s:LineHasOpeningBrackets(msl)[0] == '2' && !a:in_one_line_scope
+      call cursor(msl, 1)
+      if searchpair('(', '', ')', 'bW', s:skip_expr) > 0
+        let lnum = line('.')
+        let msl = lnum
+      endif
+
     else
+
       " Don't use lines that are part of a one line scope as msl unless the
       " flag in_one_line_scope is set to 1
       "
@@ -159,7 +178,7 @@ function s:GetMSL(lnum, in_one_line_scope)
       if msl_one_line == 0
         break
       endif
-    endif
+    end
     let lnum = s:PrevNonBlankNonString(lnum - 1)
   endwhile
   return msl
@@ -240,7 +259,7 @@ function s:LineHasOpeningBrackets(lnum)
     endif
     let pos = match(line, '[][(){}]', pos + 1)
   endwhile
-  return (open_0 > 0) . (open_2 > 0) . (open_4 > 0)
+  return (open_0 > 0 ? 1 : (open_0 == 0 ? 0 : 2)) . (open_2 > 0) . (open_4 > 0)
 endfunction
 
 function s:Match(lnum, regex)
@@ -378,12 +397,45 @@ function GetJavascriptIndent()
     return indent(prevline) + s:case_indent_after
   endif
 
-  if (line =~ s:ternary)
-    if (getline(prevline) =~ s:ternary_q)
+  " If line starts with an operator...
+  if (s:Match(v:lnum, s:operator_first))
+    if (s:Match(prevline, s:operator_first))
+      " and so does previous line, don't indent
       return indent(prevline)
-    else
+    end
+    let counts = s:LineHasOpeningBrackets(prevline)
+    if counts[0] == '2'
+      call cursor(prevline, 1)
+      " Search for the opening tag
+      let mnum = searchpair('(', '', ')', 'bW', s:skip_expr)
+      if mnum > 0 && s:Match(mnum, s:operator_first)
+        return indent(mnum)
+      end
+    elseif counts[0] != '1' && counts[1] != '1' && counts[2] != '1'
+      " otherwise, indent 1 level
+      return indent(prevline) + s:sw()
+    end
+    " If previous line starts with an operator...
+  elseif s:Match(prevline, s:operator_first) && !s:Match(prevline, s:comma_last) && !s:Match(prevline, '};\=' . s:line_term)
+    let counts = s:LineHasOpeningBrackets(prevline)
+    if counts[0] == '2' && counts[1] == '1'
+      call cursor(prevline, 1)
+      " Search for the opening tag
+      let mnum = searchpair('(', '', ')', 'bW', s:skip_expr)
+      if mnum > 0 && !s:Match(mnum, s:operator_first)
+        return indent(mnum) + s:sw()
+      end
+    elseif counts[0] != '1' && counts[1] != '1' && counts[2] != '1'
+      return indent(prevline) - s:sw()
+    end
+  end
+
+  if getline(prevline) =~ '^\s*`$' && s:IsInTempl(v:lnum, 1)
+    if line !~ '^\s*`$'
       return indent(prevline) + s:sw()
     endif
+  elseif line =~ '^\s*`$' && s:IsInTempl(prevline, 1)
+    return indent(prevline) - s:sw()
   endif
 
   " If we are in a multi-line comment, cindent does the right thing.
@@ -438,17 +490,36 @@ function GetJavascriptIndent()
   if line =~ '[[({]'
     let counts = s:LineHasOpeningBrackets(lnum)
     if counts[0] == '1' && searchpair('(', '', ')', 'bW', s:skip_expr) > 0
-      if col('.') + 1 == col('$')
+      if col('.') + 1 == col('$') || line =~ s:one_line_scope_regex
         return ind + s:sw()
       else
         return virtcol('.')
       endif
-    elseif counts[1] == '1' || counts[2] == '1'
+    elseif counts[1] == '1' || counts[2] == '1' && counts[0] != '2'
       return ind + s:sw()
     else
       call cursor(v:lnum, vcol)
     end
-  endif
+  elseif line =~ '.\+};\=' . s:line_term
+    call cursor(lnum, 1)
+    " Search for the opening tag
+    let mnum = searchpair('{', '', '}', 'bW', s:skip_expr)
+    if mnum > 0
+      return indent(s:GetMSL(mnum, 0)) 
+    end
+  elseif line =~ '.\+);\=' || line =~ s:comma_last
+    let counts = s:LineHasOpeningBrackets(lnum)
+    if counts[0] == '2'
+      call cursor(lnum, 1)
+      " Search for the opening tag
+      let mnum = searchpair('(', '', ')', 'bW', s:skip_expr)
+      if mnum > 0
+        return indent(s:GetMSL(mnum, 0)) 
+      end
+    elseif line !~ s:var_stmt
+      return indent(prevline)
+    end
+  end
 
   " 3.4. Work on the MSL line. {{{2
   " --------------------------