feat: support kdoc-formatter (#521)

hougesen · Oct 27, 2024 · 4b59f4d · 4b59f4d
1 parent d2ed0fc
commit 4b59f4d
Show file tree

Hide file tree

Showing 6 changed files with 65 additions and 1 deletion.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,6 +6,7 @@ Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 
 #### [Unreleased](https://github.com/hougesen/mdsf/compare/v0.2.7...HEAD)
 
+- feat: support kdoc-formatter [`#521`](https://github.com/hougesen/mdsf/pull/521)
 - feat: support djade [`#520`](https://github.com/hougesen/mdsf/pull/520)
 - feat: support tsqllint [`#519`](https://github.com/hougesen/mdsf/pull/519)
 - feat: support pyment [`#518`](https://github.com/hougesen/mdsf/pull/518)

diff --git a/README.md b/README.md
@@ -184,7 +184,7 @@ mdsf init
 
 <!-- START_SECTION:supported-tools -->
 
-`mdsf` currently supports 211 commands. Feel free to open an issue/pull-request if your favorite tool is missing! 😃
+`mdsf` currently supports 212 commands. Feel free to open an issue/pull-request if your favorite tool is missing! 😃
 
 | Name                     | Command                                                                                |
 | ------------------------ | -------------------------------------------------------------------------------------- |
@@ -288,6 +288,7 @@ mdsf init
 | `just`                   | `just --fmt --unstable --justfile PATH`                                                |
 | `kcl:fmt`                | `kcl fmt PATH`                                                                         |
 | `kdlfmt`                 | `kdlfmt format PATH`                                                                   |
+| `kdoc-formatter`         | `kdoc-formatter --quiet PATH`                                                          |
 | `ktfmt`                  | `ktfmt --format --log-level=error PATH`                                                |
 | `ktlint`                 | `ktlint --format --log-level=error PATH`                                               |
 | `kulala-fmt`             | `kulala-fmt PATH`                                                                      |

diff --git a/mdsf/src/tools/kdoc_formatter.rs b/mdsf/src/tools/kdoc_formatter.rs
@@ -0,0 +1,35 @@
+use std::process::Command;
+
+use crate::{error::MdsfError, execution::execute_command, runners::CommandType};
+
+#[inline]
+fn set_kdoc_formatter_args(mut cmd: Command, file_path: &std::path::Path) -> Command {
+    cmd.arg("--quiet");
+    cmd.arg(file_path);
+    cmd
+}
+
+#[inline]
+pub fn run(file_path: &std::path::Path) -> Result<(bool, Option<String>), MdsfError> {
+    let commands = [CommandType::Direct("kdoc-formatter")];
+
+    for (index, cmd) in commands.iter().enumerate() {
+        let cmd = set_kdoc_formatter_args(cmd.build(), file_path);
+        let execution_result = execute_command(cmd, file_path);
+
+        if index == commands.len() - 1 {
+            return execution_result;
+        }
+
+        if let Ok(r) = execution_result {
+            if !r.0 {
+                return Ok(r);
+            }
+        }
+    }
+
+    Ok((true, None))
+}
+
+#[cfg(test)]
+mod test_kdoc_formatter {}
diff --git a/mdsf/src/tools/mod.rs b/mdsf/src/tools/mod.rs
@@ -98,6 +98,7 @@ pub mod juliaformatter_jl;
 pub mod just;
 pub mod kcl_fmt;
 pub mod kdlfmt;
+pub mod kdoc_formatter;
 pub mod ktfmt;
 pub mod ktlint;
 pub mod kulala_fmt;
@@ -614,6 +615,10 @@ pub enum Tooling {
     /// `kdlfmt format $PATH`
     Kdlfmt,
 
+    #[serde(rename = "kdoc-formatter")]
+    /// `kdoc-formatter --quiet $PATH`
+    KdocFormatter,
+
     #[serde(rename = "ktfmt")]
     /// `ktfmt --format --log-level=error $PATH`
     Ktfmt,
@@ -1167,6 +1172,7 @@ impl Tooling {
             Self::Just => just::run(snippet_path),
             Self::KclFmt => kcl_fmt::run(snippet_path),
             Self::Kdlfmt => kdlfmt::run(snippet_path),
+            Self::KdocFormatter => kdoc_formatter::run(snippet_path),
             Self::Ktfmt => ktfmt::run(snippet_path),
             Self::Ktlint => ktlint::run(snippet_path),
             Self::KulalaFmt => kulala_fmt::run(snippet_path),
@@ -1387,6 +1393,7 @@ impl AsRef<str> for Tooling {
             Self::Just => "just",
             Self::KclFmt => "kcl_fmt",
             Self::Kdlfmt => "kdlfmt",
+            Self::KdocFormatter => "kdoc_formatter",
             Self::Ktfmt => "ktfmt",
             Self::Ktlint => "ktlint",
             Self::KulalaFmt => "kulala_fmt",

diff --git a/schemas/v0.2.7/mdsf.schema.json b/schemas/v0.2.7/mdsf.schema.json
@@ -558,6 +558,11 @@
           "type": "string",
           "enum": ["kdlfmt"]
         },
+        {
+          "description": "`kdoc-formatter --quiet $PATH`",
+          "type": "string",
+          "enum": ["kdoc-formatter"]
+        },
         {
           "description": "`ktfmt --format --log-level=error $PATH`",
           "type": "string",

diff --git a/tools/kdoc-formatter/plugin.json b/tools/kdoc-formatter/plugin.json
@@ -0,0 +1,15 @@
+{
+  "$schema": "../tool.schema.json",
+  "binary": "kdoc-formatter",
+  "categories": ["formatter"],
+  "commands": {
+    "": ["--quiet", "$PATH"]
+  },
+  "description": "Reformats Kotlin KDoc comments, reflowing text and other cleanup",
+  "homepage": "https://github.com/tnorbye/kdoc-formatter",
+  "languages": ["kotlin"],
+  "name": null,
+  "npm": null,
+  "php": null,
+  "tests": []
+}