feat: add support for scala (resolves #288)

ftplugin/scala.vim

@@ -0,0 +1,16 @@
+" ==============================================================================
+" The Scala documentation should follow the 'ScalaDoc' conventions.
+" see https://docs.scala-lang.org/style/scaladoc.html
+" ==============================================================================
+
+let s:save_cpo = &cpoptions
+set cpoptions&vim
+
+let b:doge_parser = 'scala'
+let b:doge_insert = 'above'
+
+let b:doge_supported_doc_standards = ['scaladoc']
+let b:doge_doc_standard = doge#buffer#get_doc_standard('scala')
+
+let &cpoptions = s:save_cpo
+unlet s:save_cpo

helper/.editorconfig

@@ -9,5 +9,8 @@ charset = utf-8
 trim_trailing_whitespace = true
 insert_final_newline = true
 
+[*.yaml]
+indent_size = 2
+
 [*.md]
 trim_trailing_whitespace = false

helper/Cargo.toml

@@ -27,3 +27,4 @@ tree-sitter-cpp = { git = "https://github.com/tree-sitter/tree-sitter-cpp", rev
 tree-sitter-typescript = { git = "https://github.com/tree-sitter/tree-sitter-typescript", rev = "3429d8c" }
 tree-sitter-php = { git = "https://github.com/tree-sitter/tree-sitter-php", rev = "d43130f" }
 tree-sitter-r = { git = "https://github.com/r-lib/tree-sitter-r", rev = "c55f8b4" }
+tree-sitter-scala = { git = "https://github.com/tree-sitter/tree-sitter-scala", rev = "f14629b" }

helper/src/config.rs

@@ -34,6 +34,7 @@ pub fn load_doc_config_str<'a>(parser_name: &'a str, doc_name: &'a str) -> &'a s
         "bash_google" => include_str!("bash/docs/google.yaml"),
         "rust_rustdoc" => include_str!("rust/docs/rustdoc.yaml"),
         "r_roxygen2" => include_str!("r/docs/roxygen2.yaml"),
+        "scala_scaladoc" => include_str!("scala/docs/scaladoc.yaml"),
 
         _ => panic!("Unsupported {} doc: {}", parser_name, doc_name),
     }

helper/src/docblock.rs

@@ -18,6 +18,7 @@ use crate::ruby::parser::RubyParser;
 use crate::rust::parser::RustParser;
 use crate::typescript::parser::TypescriptParser;
 use crate::r::parser::RParser;
+use crate::scala::parser::ScalaParser;
 
 
 fn replace_indent_placeholders(docblock: &str, use_tabs: bool, indent: usize) -> String {
@@ -139,6 +140,7 @@ pub fn generate(
             "cpp" => Box::new(CppParser::new(code, line, &node_types)) as Box<dyn BaseParser>,
             "typescript" => Box::new(TypescriptParser::new(code, line, &node_types, options)) as Box<dyn BaseParser>,
             "r" => Box::new(RParser::new(code, line, &node_types)) as Box<dyn BaseParser>,
+            "scala" => Box::new(ScalaParser::new(code, line, &node_types)) as Box<dyn BaseParser>,
             _ => panic!("Unsupported parser: {}", &parser_name),
         };
 

helper/src/lib.rs

@@ -16,3 +16,4 @@ pub mod c;
 pub mod cpp;
 pub mod typescript;
 pub mod r;
+pub mod scala;

helper/src/r/docs/roxygen2.yaml

@@ -5,21 +5,21 @@ templates:
     node_types:
       - function_definition
     template: |
-        #' [TODO:title of the function]
-        #'
-        #' [TODO:brief description]
-        {% if params %}
-        #'
-            {% for param in params %}
-        #' @param {{ param.name }} [TODO:description]{% if param.default_value %}. Default is {{ param.default_value }}.{% endif %}
-            {% endfor %}
-        {% endif %}
-        #'
-        #' @return [TODO:description]
-        #'
-        #' @examples
-        #' {{ func_name }}([TODO:parameters])
-        #'
-        #' @rdname {{ func_name }}
-        #'
-        #' @method {{ func_name }}
+      #' [TODO:title of the function]
+      #'
+      #' [TODO:brief description]
+      {% if params %}
+      #'
+        {% for param in params %}
+      #' @param {{ param.name }} [TODO:description]{% if param.default_value %}. Default is {{ param.default_value }}.{% endif %}
+        {% endfor %}
+      {% endif %}
+      #'
+      #' @return [TODO:description]
+      #'
+      #' @examples
+      #' {{ func_name }}([TODO:parameters])
+      #'
+      #' @rdname {{ func_name }}
+      #'
+      #' @method {{ func_name }}

helper/src/scala/docs/scaladoc.yaml

@@ -0,0 +1,45 @@
+# https://docs.scala-lang.org/style/scaladoc.html
+
+templates:
+  lambda_expression:
+    node_types:
+      - lambda_expression
+    template: |
+      /** [TODO:description]
+       *
+      {% if params %}
+        {% for param in params %}
+       * @param {{ param.name }} [TODO:description]
+        {% endfor %}
+      {% endif %}
+       * @return [TODO:description]
+       */
+
+  function:
+    node_types:
+      - function_definition
+    template: |
+      /** [TODO:description]
+       *
+      {% if params %}
+        {% for param in params %}
+       * @param {{ param.name }} [TODO:description]
+        {% endfor %}
+      {% endif %}
+       * @return [TODO:description]
+       */
+
+  class:
+    node_types:
+      - class_definition
+    template: |
+      {% if params %}
+      /** [TODO:description]
+       *
+        {% for param in params %}
+       * @param {{ param.name }} [TODO:description]
+        {% endfor %}
+       */
+       {% else %}
+      /** [TODO:description] */
+       {% endif %}

helper/src/scala/mod.rs

@@ -0,0 +1 @@
+pub mod parser;