Add docformatter builtin

Fixes jose-elias-alvarez#1619
mskelton · Jul 14, 2023 · 835ea4d · 835ea4d
1 parent ea1a453
commit 835ea4d
Show file tree

Hide file tree

Showing 4 changed files with 41 additions and 1 deletion.
diff --git a/doc/BUILTINS.md b/doc/BUILTINS.md
@@ -3027,6 +3027,23 @@ local sources = { null_ls.builtins.formatting.djlint }
 - Command: `djlint`
 - Args: `{ "--reformat", "-" }`
 
+### [docformatter](https://github.com/PyCQA/docformatter)
+
+Python formatter complaint with the PEP 257 standard
+
+#### Usage
+
+```lua
+local sources = { null_ls.builtins.formatting.docformatter }
+```
+
+#### Defaults
+
+- Filetypes: `{ "python" }`
+- Method: `formatting`
+- Command: `docformatter`
+- Args: `{ "-" }`
+
 ### [dprint](https://dprint.dev/)
 
 A pluggable and configurable code formatting platform written in Rust.

diff --git a/lua/null-ls/builtins/_meta/filetype_map.lua b/lua/null-ls/builtins/_meta/filetype_map.lua
@@ -325,7 +325,7 @@ return {
   python = {
     code_actions = { "refactoring" },
     diagnostics = { "flake8", "mypy", "pycodestyle", "pydocstyle", "pylama", "pylint", "pyproject_flake8", "ruff", "semgrep", "vulture" },
-    formatting = { "autoflake", "autopep8", "black", "blackd", "blue", "isort", "isortd", "pyflyby", "pyink", "reorder_python_imports", "ruff", "usort", "yapf" }
+    formatting = { "autoflake", "autopep8", "black", "blackd", "blue", "docformatter", "isort", "isortd", "pyflyby", "pyink", "reorder_python_imports", "ruff", "usort", "yapf" }
   },
   qml = {
     diagnostics = { "qmllint" },

diff --git a/lua/null-ls/builtins/_meta/formatting.lua b/lua/null-ls/builtins/_meta/formatting.lua
@@ -94,6 +94,9 @@ return {
   djlint = {
     filetypes = { "django", "jinja.html", "htmldjango" }
   },
+  docformatter = {
+    filetypes = { "python" }
+  },
   dprint = {
     filetypes = { "javascript", "javascriptreact", "typescript", "typescriptreact", "json", "markdown", "toml", "rust", "roslyn" }
   },

diff --git a/lua/null-ls/builtins/formatting/docformatter.lua b/lua/null-ls/builtins/formatting/docformatter.lua
@@ -0,0 +1,20 @@
+local h = require("null-ls.helpers")
+local methods = require("null-ls.methods")
+
+local FORMATTING = methods.internal.FORMATTING
+
+return h.make_builtin({
+    name = "docformatter",
+    meta = {
+        url = "https://github.com/PyCQA/docformatter",
+        description = "Python formatter complaint with the PEP 257 standard",
+    },
+    method = { FORMATTING },
+    filetypes = { "python" },
+    generator_opts = {
+        command = "docformatter",
+        args = { "-" },
+        to_stdin = true,
+    },
+    factory = h.formatter_factory,
+})