Enable spellcheck in comments -- ches

Author: Derek Wyatt

syntax/scala.vim

@@ -9,13 +9,19 @@ endif
 
 scriptencoding utf-8
 
+let b:current_syntax = "scala"
+
 " Allows for embedding, see #59; main_syntax convention instead? Refactor TOP
+"
+" The @Spell here is a weird hack, it means *exclude* if the first group is
+" TOP. Otherwise we get spelling errors highlighted on code elements that
+" match scalaBlock, even with `syn spell notoplevel`.
 function! s:ContainedGroup()
   try
     silent syn list @scala
-    return '@scala'
+    return '@scala,@NoSpell'
   catch /E392/
-    return 'TOP'
+    return 'TOP,@Spell'
   endtry
 endfunction
 
@@ -157,7 +163,7 @@ syn match scalaTypeAnnotationParameter /@\<[`_A-Za-z0-9$]\+\>/ contained
 hi link scalaTypeOperator Keyword
 hi link scalaTypeAnnotationParameter Function
 
-syn region scalaMultilineComment start="/\*" end="\*/" contains=scalaMultilineComment,scalaDocLinks,scalaParameterAnnotation,scalaCommentAnnotation,scalaCommentCodeBlock,@scalaHtml keepend
+syn region scalaMultilineComment start="/\*" end="\*/" contains=scalaMultilineComment,scalaDocLinks,scalaParameterAnnotation,scalaCommentAnnotation,scalaCommentCodeBlock,@scalaHtml,@Spell keepend
 syn match scalaCommentAnnotation "@[_A-Za-z0-9$]\+" contained
 syn match scalaParameterAnnotation "@param" nextgroup=scalaParamAnnotationValue skipwhite contained
 syn match scalaParamAnnotationValue /[`_A-Za-z0-9$]\+/ contained
@@ -173,7 +179,7 @@ hi link scalaCommentCodeBlock String
 syn match scalaAnnotation /@\<[`_A-Za-z0-9$]\+\>/
 hi link scalaAnnotation PreProc
 
-syn match scalaTrailingComment "//.*$"
+syn match scalaTrailingComment "//.*$" contains=@Spell
 hi link scalaTrailingComment Comment
 
 syn match scalaAkkaFSM /goto([^)]*)\_s\+\<using\>/ contains=scalaAkkaFSMGotoUsing

syntax/testfile.scala

@@ -43,7 +43,7 @@ def x(): Unit = {
 
 class ScalaClass(i: Int = 12, b: Trait[A, Trait[B, C]]) extends B with SomeTrait[A, B[String], D] {
   /**
-   * I forgot comments! [[scala.Option]]
+   * I forgot comments! We spelcheck them. [[scala.Option]]
    *
    * {{{
    * scala> This is a REPL line
@@ -52,10 +52,10 @@ class ScalaClass(i: Int = 12, b: Trait[A, Trait[B, C]]) extends B with SomeTrait
    *
    * <li></li>
    *
-   * @param parameter Explanation of the parameter.
+   * @param parameter Explanation of the parameter. Speling.
    * @return 
    */
-  val thing = "A String" // this is a trailing comment
+  val thing = "A String" // this is a trailing comment, spelchecked too
   val thing = "A String with a \" in it"
   val intString = "A string with $stuff // and a comment in it"
   val intString = s"A string /* a comment and */ with $stuff and ${stuff} in it"
@@ -162,6 +162,7 @@ class ScalaClass(i: Int = 12, b: Trait[A, Trait[B, C]]) extends B with SomeTrait
   val something = s"""bar="foo""""
   val something = f"""bar="foo""""
   val something = """bar="foo""""
+  val something = s"Interpolatin' fancy expressions ${bar map (_.toString)}"
 
   def someFunc[A <: B, X =:= Y]