Merge pull request #87 from elixir-lang/heredoc

Add syntax highlighting for heredocs & failing tests for indentation.

Author: mattdeboard

elixir-mode.el

@@ -226,6 +226,10 @@
 (eval-when-compile
   (defconst elixir-rx-constituents
     `(
+      ;; Match `@doc' or `@moduledoc' syntax, with or without triple quotes.
+      (heredocs . ,(rx symbol-start
+                       (or "@doc" "@moduledoc" "~s")
+                       symbol-end))
       (keywords . ,(rx symbol-start
                       (or "->" "bc" "lc" "in" "inbits" "inlist" "quote"
                           "unquote" "unquote_splicing" "var" "do" "after" "for"
@@ -328,6 +332,10 @@
                  (group module-names))
      1 font-lock-type-face)
 
+    ;; Heredoc
+    (,(elixir-rx (group heredocs))
+     1 font-lock-builtin-face)
+
     ;; Keywords
     (,(elixir-rx (group keywords))
      1 font-lock-keyword-face)

elixir-smie.el

@@ -30,7 +30,7 @@
     (modify-syntax-entry ?\[ "(]" table)
     (modify-syntax-entry ?\] ")[" table)
     (modify-syntax-entry ?\: "'" table)
-    (modify-syntax-entry ?\@ "'" table)
+    (modify-syntax-entry ?@ "_" table)
     table)
   "Elixir mode syntax table.")
 

test/elixir-mode-font-tests.el

@@ -99,3 +99,28 @@ end"
 end"
     (should (eq (elixir-test-face-at 5) 'font-lock-function-name-face))
     (should (eq (elixir-test-face-at 8) 'font-lock-function-name-face))))
+
+(ert-deftest elixir-mode-syntax-table/fontify-heredoc/1 ()
+  :tags '(fontification heredoc syntax-table)
+  (elixir-test-with-temp-buffer
+      "@doc \"\"\""
+    (should (eq (elixir-test-face-at 1) 'font-lock-builtin-face))
+    (should (eq (elixir-test-face-at 2) 'font-lock-builtin-face))
+    (should (eq (elixir-test-face-at 6) 'font-lock-string-face))))
+
+(ert-deftest elixir-mode-syntax-table/fontify-heredoc/2 ()
+  :tags '(fontification heredoc syntax-table)
+  (elixir-test-with-temp-buffer
+      "@moduledoc \"\"\""
+    (should (eq (elixir-test-face-at 1) 'font-lock-builtin-face))
+    (should (eq (elixir-test-face-at 2) 'font-lock-builtin-face))
+    (should (eq (elixir-test-face-at 12) 'font-lock-string-face))))
+
+(ert-deftest elixir-mode-syntax-table/fontify-heredoc/3 ()
+  :tags '(fontification heredoc syntax-table)
+  (elixir-test-with-temp-buffer
+      "~s\"\"\""
+    (should (eq (elixir-test-face-at 1) 'font-lock-builtin-face))
+    (should (eq (elixir-test-face-at 2) 'font-lock-builtin-face))
+    (should (eq (elixir-test-face-at 3) 'font-lock-string-face))))
+

test/elixir-mode-indentation-tests.el

@@ -437,3 +437,28 @@ end"
     end
   end
 end")
+
+(elixir-def-indentation-test indent-heredoc
+    (:expected-result :failed)
+  "
+defmodule Foo do
+@doc \"\"\"
+this is a heredoc string
+
+\"\"\"
+def convert do
+x = 15
+end
+end
+"
+  "
+defmodule Foo do
+  @doc \"\"\"
+  this is a heredoc string
+
+  \"\"\"
+  def convert do
+    x = 15
+  end
+end
+")