Merge pull request #12 from steffenhaug/main

Docstrings on lone identifiers and SQLStrings language injection

Author: piechologist

languages/julia/highlights.scm

@@ -567,6 +567,29 @@
     (function_definition)
     (assignment)
     (const_statement)
+  ])
+
+((macrocall_expression
+  (macro_identifier "@" (identifier)) @function.macro
+  (macro_argument_list
+    .
+    (string_literal) @comment.doc))
+  (#eq? @function.macro "@doc"))
+
+(source_file
+  (string_literal) @comment.doc
+  .
+  [
+    (identifier)
+    (open_tuple
+      (identifier))
+  ])
+
+(module_definition
+  (string_literal) @comment.doc
+  .
+  [
+    (identifier)
     (open_tuple
       (identifier))
   ])

languages/julia/injections.scm

@@ -9,12 +9,38 @@
     (function_definition)
     (assignment)
     (const_statement)
-    (open_tuple
-      (identifier))
   ]
   (#match? @content "^\"\"\"")
   (#set! "language" "markdown"))
 
+((macrocall_expression
+  (macro_identifier "@" (identifier)) @function.macro
+  (macro_argument_list
+    .
+    (string_literal) @content))
+  (#eq? @function.macro "@doc")
+  (#set! "language" "markdown"))
+
+((source_file
+  (string_literal) @content
+  .
+  [
+    (identifier)
+    (open_tuple
+      (identifier))
+  ])
+  (#set! "language" "markdown"))
+
+((module_definition
+  (string_literal) @content
+  .
+  [
+      (identifier)
+      (open_tuple
+        (identifier))
+  ])
+  (#set! "language" "markdown"))
+
 ([
   (line_comment)
   (block_comment)
@@ -25,3 +51,8 @@
   prefix: (identifier) @_prefix) @content
   (#eq? @_prefix "r")
   (#set! "language" "regex"))
+
+((prefixed_command_literal
+  prefix: (identifier) @_prefix) @content
+  (#eq? @_prefix "sql")
+  (#set! "language" "sql"))

syntax-test-cases/docstrings.jl

@@ -0,0 +1,74 @@
+# (module_definition)
+"""
+This _should_ have `markdown` injected!
+"""
+module A end
+
+# (abstract_definition)
+"""
+This _should_ have `markdown` injected!
+"""
+abstract type AbstractT end
+
+# (struct_definition)
+"""
+This _should_ have `markdown` injected!
+"""
+struct S end
+
+# (function_definition)
+"""
+This _should_ have `markdown` injected!
+"""
+function f end
+
+# (assignment)
+"""
+This _should_ have `markdown` injected!
+"""
+x = 73
+
+# (const_statement)
+"""
+This _should_ have `markdown` injected!
+"""
+const y = 42
+
+# (macrocall_expression) with (macro_identifier) eq. "@doc"
+@doc "This _should_ have `markdown` injected!" x
+
+# (macrocall_expression) with (macro_identifier) not eq. "@doc"
+@info "This should _not_ have `markdown` injected!" x
+
+# (source_file (string_literal) (identifier))
+"""
+This _should_ have `markdown` injected!
+"""
+x
+
+module B
+# (identifier)
+"""
+This _should_ have `markdown` injected!
+"""
+x
+end
+
+begin
+# (identifier)
+"""
+This _should_ have `markdown` injected!
+"""
+x
+end
+
+let
+# (identifier)
+"""
+This _should_ have `markdown` injected!
+"""
+x
+end
+
+# (call_expression)
+foobar("This should _not_ have `markdown` injected!", x)