Show @doc with sigil_S as elixirDocString. (elixir-editors#185)

* Test to show @doc with sigil_S don't show as elixirDocString. * Make the tests pending until they're fixed. * Fix pending elixirDocString tests. * Keep elixirVariable for `@doc`. * Triple single quoted docs aren't valid unless with `sigil_[Ss]`. * Documentation delimiters are no longer included in `elixirDocString`.

Author: lmarlow

spec/syntax/heredoc_spec.rb

@@ -4,28 +4,56 @@
 
 describe 'Heredoc syntax' do
  describe 'binary' do
- it 'with multiline content' do
- expect(<<~EOF).to include_elixir_syntax('elixirDocString', 'foo')
- @doc """
+ it 'doc with multiline content' do
+ ex = <<~EOF
+ @callbackdoc """
  foo
  """
  EOF
+ expect(ex).to include_elixir_syntax('elixirVariable', 'doc')
+ expect(ex).to include_elixir_syntax('elixirDocString', 'foo')
  end
 
- it 'escapes quotes unless only preceded by whitespace' do
- expect(<<~EOF).to include_elixir_syntax('elixirDocString', %q(^\s*\zs"""))
- @doc """
- foo """
+ it 'doc with sigil_S triple double-quoted multiline content' do
+ ex = <<~EOF
+ @doc ~S"""
+ foo
  """
  EOF
+ expect(ex).to include_elixir_syntax('elixirVariable', 'doc')
+ expect(ex).to include_elixir_syntax('elixirSigilDelimiter', 'S"""')
+ expect(ex).to include_elixir_syntax('elixirDocString', 'foo')
+ end
+
+ it 'doc with sigil_S triple single-quoted multiline content' do
+ ex = <<~EOF
+ @doc ~S'''
+ foo
+ '''
+ EOF
+ expect(ex).to include_elixir_syntax('elixirVariable', 'doc')
+ expect(ex).to include_elixir_syntax('elixirSigilDelimiter', "S'''")
+ expect(ex).to include_elixir_syntax('elixirDocString', 'foo')
+ end
+
+ it 'doc with triple single-quoted multiline content is not a doc string' do
+ ex = <<~EOF
+ @doc '''
+ foo
+ '''
+ EOF
+ expect(ex).not_to include_elixir_syntax('elixirDocString', 'foo')
  end
 
- it 'with interpolation' do
- expect(<<~EOF).to include_elixir_syntax('elixirInterpolation', 'bar')
+ it 'doc with interpolation' do
+ ex = <<~EOF
  @doc """
  foo \#{bar}
  """
  EOF
+ expect(ex).to include_elixir_syntax('elixirDocString', 'foo')
+ expect(ex).to include_elixir_syntax('elixirStringDelimiter', '"""')
+ expect(ex).to include_elixir_syntax('elixirInterpolation', 'bar')
  end
 
  it 'interpolation in heredoc must be string' do

syntax/elixir.vim

@@ -85,8 +85,6 @@ syn region elixirString matchgroup=elixirStringDelimiter start=+\z('''\)+ end=+
 syn region elixirString matchgroup=elixirStringDelimiter start=+\z("""\)+ end=+^\s*\z1+ skip=+"\|\\\\+ contains=@elixirStringContained
 syn region elixirInterpolation matchgroup=elixirInterpolationDelimiter start="#{" end="}" contained contains=ALLBUT,elixirComment,@elixirNotTop
 
-syn match elixirDocString +\(@\w*doc\s*\)\@<=\%("""\_.\{-}\_^\s*"""\|".\{-\}"\)+ contains=elixirTodo,elixirInterpolation,@Spell fold
-
 syn match elixirAtomInterpolated ':\("\)\@=' contains=elixirString
 syn match elixirString "\(\w\)\@<!?\%(\\\(x\d{1,2}\|\h{1,2}\h\@!\>\|0[0-7]{0,2}[0-7]\@!\>\|[^x0MC]\)\|(\\[MC]-)+\w\|[^\s\\]\)"
 
@@ -111,8 +109,11 @@ syn region elixirSigil matchgroup=elixirSigilDelimiter start="\~\l\["
 syn region elixirSigil matchgroup=elixirSigilDelimiter start="\~\l(" end=")" skip="\\\\\|\\)" contains=@elixirStringContained,elixirRegexEscapePunctuation fold
 
 " Sigils surrounded with docString
-syn region elixirSigil matchgroup=elixirSigilDelimiter start=+\~\a\z("""\)+ end=+^\s*\zs\z1+ skip=+\\"+ fold
-syn region elixirSigil matchgroup=elixirSigilDelimiter start=+\~\a\z('''\)+ end=+^\s*\zs\z1+ skip=+\\'+ fold
+syn region elixirSigil matchgroup=elixirSigilDelimiter start=+\~\a\z("""\)+ end=+^\s*\zs\z1\s*$+ skip=+\\"+ fold
+syn region elixirSigil matchgroup=elixirSigilDelimiter start=+\~\a\z('''\)+ end=+^\s*\zs\z1\s*$+ skip=+\\'+ fold
+
+syn region elixirDocString matchgroup=elixirStringDelimiter start=+\%(@\w*doc\s\+\)\@<=\z("""\)+ end=+\z1+ contains=elixirTodo,elixirInterpolation,@Spell fold
+syn region elixirDocString matchgroup=elixirSigilDelimiter start=+\%(@\w*doc\s\+\)\@<=\~[Ss]\z('''\|"""\)+ end=+\z1+ contains=elixirTodo,elixirInterpolation,@Spell fold
 
 " Defines
 syn keyword elixirDefine def nextgroup=elixirFunctionDeclaration skipwhite skipnl