feat: support docformatter

hougesen · Jun 15, 2024 · 41a1151 · 41a1151
1 parent 8356cf0
commit 41a1151
Show file tree

Hide file tree

Showing 4 changed files with 34 additions and 7 deletions.
diff --git a/README.md b/README.md
@@ -104,7 +104,7 @@ mdsf init
 
 <!-- START_SECTION:supported-languages -->
 
-`mdsf` currently supports 125 tools.
+`mdsf` currently supports 126 tools.
 
 | Formatter          | Description                                                                                                            |
 | ------------------ | ---------------------------------------------------------------------------------------------------------------------- |
@@ -137,6 +137,7 @@ mdsf init
 | deno_fmt           | [https://dart.dev/tools/dart-format](https://dart.dev/tools/dart-format)                                               |
 | dfmt               | [https://github.com/dlang-community/dfmt](https://github.com/dlang-community/dfmt)                                     |
 | djlint             | [https://www.djlint.com/](https://www.djlint.com/)                                                                     |
+| docformatter       | [https://pypi.org/project/docformatter/](https://pypi.org/project/docformatter/)                                       |
 | docstrfmt          | [https://pypi.org/project/docstrfmt/](https://pypi.org/project/docstrfmt/)                                             |
 | dprint             | [https://dprint.dev](https://dprint.dev)                                                                               |
 | efmt               | [https://github.com/sile/efmt](https://github.com/sile/efmt)                                                           |

diff --git a/schemas/v0.1.1/mdsf.schema.json b/schemas/v0.1.1/mdsf.schema.json
@@ -194,6 +194,11 @@
           "type": "string",
           "enum": ["djlint"]
         },
+        {
+          "description": "https://pypi.org/project/docformatter/",
+          "type": "string",
+          "enum": ["docformatter"]
+        },
         {
           "description": "https://pypi.org/project/docstrfmt/",
           "type": "string",

diff --git a/src/formatters/docformatter.rs b/src/formatters/docformatter.rs
@@ -0,0 +1,13 @@
+use super::execute_command;
+use crate::error::MdsfError;
+
+#[inline]
+pub fn format_using_docformatter(
+    file_path: &std::path::Path,
+) -> Result<(bool, Option<String>), MdsfError> {
+    let mut cmd = std::process::Command::new("docformatter");
+
+    cmd.arg("--in-place").arg(file_path);
+
+    execute_command(&mut cmd, file_path)
+}
diff --git a/src/formatters/mod.rs b/src/formatters/mod.rs
@@ -20,7 +20,8 @@ use crate::{
         crlfmt::format_using_crlfmt, crystal_format::format_using_crystal_format,
         csharpier::format_using_csharpier, d2::format_using_d2,
         dart_format::format_using_dart_format, deno_fmt::format_using_deno_fmt,
-        dfmt::format_using_dfmt, djlint::format_using_djlint, docstrfmt::format_using_docstrfmt,
+        dfmt::format_using_dfmt, djlint::format_using_djlint,
+        docformatter::format_using_docformatter, docstrfmt::format_using_docstrfmt,
         dprint::format_using_dprint, efmt::format_using_efmt, elm_format::format_using_elm_format,
         erb_formatter::format_using_erb_formatter, erlfmt::format_using_erlfmt,
         eslint::format_using_eslint, fantomas::format_using_fantomas,
@@ -102,6 +103,7 @@ mod dart_format;
 mod deno_fmt;
 mod dfmt;
 mod djlint;
+mod docformatter;
 mod docstrfmt;
 mod dprint;
 mod efmt;
@@ -433,6 +435,10 @@ pub enum Tooling {
     #[serde(rename = "djlint")]
     DjLint,
 
+    #[doc = "https://pypi.org/project/docformatter/"]
+    #[serde(rename = "docformatter")]
+    Docformatter,
+
     #[doc = "https://pypi.org/project/docstrfmt/"]
     #[serde(rename = "docstrfmt")]
     Docstrfmt,
@@ -851,11 +857,12 @@ impl Tooling {
             Self::Codespell => format_using_codespell(snippet_path),
             Self::CrlFmt => format_using_crlfmt(snippet_path),
             Self::CrystalFormat => format_using_crystal_format(snippet_path),
-            Self::DFmt => format_using_dfmt(snippet_path),
             Self::D2 => format_using_d2(snippet_path),
+            Self::DFmt => format_using_dfmt(snippet_path),
             Self::DartFormat => format_using_dart_format(snippet_path),
             Self::DenoFmt => format_using_deno_fmt(snippet_path),
             Self::DjLint => format_using_djlint(snippet_path),
+            Self::Docformatter => format_using_docformatter(snippet_path),
             Self::Docstrfmt => format_using_docstrfmt(snippet_path),
             Self::Dprint => format_using_dprint(snippet_path),
             Self::Efmt => format_using_efmt(snippet_path),
@@ -881,8 +888,8 @@ impl Tooling {
             Self::GoImportsReviser => format_using_goimports_reviser(snippet_path),
             Self::GoLines => format_using_golines(snippet_path),
             Self::GoogleJavaFormat => format_using_google_java_format(snippet_path),
-            Self::HamlLint => format_using_haml_lint(snippet_path),
             Self::HIndent => format_using_hindent(snippet_path),
+            Self::HamlLint => format_using_haml_lint(snippet_path),
             Self::Htmlbeautifier => format_using_htmlbeautifier(snippet_path),
             Self::Isort => format_using_isort(snippet_path),
             Self::Joker => format_using_joker(snippet_path),
@@ -985,11 +992,12 @@ impl core::fmt::Display for Tooling {
             Self::Codespell => write!(f, "codespell"),
             Self::CrlFmt => write!(f, "crlfmt"),
             Self::CrystalFormat => write!(f, "crystal_format"),
-            Self::DFmt => write!(f, "dfmt"),
             Self::D2 => write!(f, "d2"),
+            Self::DFmt => write!(f, "dfmt"),
             Self::DartFormat => write!(f, "dart_format"),
             Self::DenoFmt => write!(f, "deno_fmt"),
             Self::DjLint => write!(f, "djlint"),
+            Self::Docformatter => write!(f, "docformatter"),
             Self::Docstrfmt => write!(f, "docstrfmt"),
             Self::Dprint => write!(f, "dprint"),
             Self::Efmt => write!(f, "efmt"),
@@ -1015,8 +1023,8 @@ impl core::fmt::Display for Tooling {
             Self::GoImportsReviser => write!(f, "goimports-reviser"),
             Self::GoLines => write!(f, "golines"),
             Self::GoogleJavaFormat => write!(f, "google-java-format"),
-            Self::HamlLint => write!(f, "haml-lint"),
             Self::HIndent => write!(f, "hundent"),
+            Self::HamlLint => write!(f, "haml-lint"),
             Self::Htmlbeautifier => write!(f, "htmlbeautifier"),
             Self::Isort => write!(f, "isort"),
             Self::Joker => write!(f, "joker"),
@@ -1073,8 +1081,8 @@ impl core::fmt::Display for Tooling {
             Self::Templ => write!(f, "templ"),
             Self::TerraformFmt => write!(f, "terraform_fmt"),
             Self::TofuFmt => write!(f, "tofu_fmt"),
-            Self::Typos => write!(f, "typos"),
             Self::TsStandard => write!(f, "ts-standard"),
+            Self::Typos => write!(f, "typos"),
             Self::Usort => write!(f, "usort"),
             Self::XmlFormat => write!(f, "xmlformat"),
             Self::XmlLint => write!(f, "xmllint"),