feat: add docformatter and pydocstyle support

Author: weibullguy

action.yml

@@ -1,5 +1,5 @@
 name: "Python Code Quality and Lint"
-description: "Supports Pylint, pycodestyle, Flake8, black, mypy and isort"
+description: "Supports Pylint, pycodestyle, pydocstyle, Flake8, black, mypy, docformatter, and isort"
 inputs:
   python-root-list:
     description: "A list of all paths to test"
@@ -13,6 +13,10 @@ inputs:
     description: "Use pycodestyle"
     required: false
     default: true
+  use-pydocstyle:
+    description: "Use pydocstyle"
+    required: false
+    default: true
   use-flake8:
     description: "Use Flake8"
     required: false
@@ -25,6 +29,10 @@ inputs:
     description: "Use mypy"
     required: false
     default: true
+  use-docformatter:
+    description: "Use docformatter"
+    required: false
+    default: true
   use-isort:
     description: "Use isort"
     required: false
@@ -37,6 +45,10 @@ inputs:
     description: "Extra options: pycodestyle $(extra-pycodestyle-options) $(python-root-list)"
     required: false
     default: ""
+  extra-pydocstyle-options:
+    description: "Extra options: pydocstyle $(extra-pydocstyle-options) $(python-root-list)"
+    required: false
+    default: ""
   extra-flake8-options:
     description: "Extra options: flake8 $(extra-flake8-options) $(python-root-list)"
     required: false
@@ -49,6 +61,10 @@ inputs:
     description: "Extra options: mypy $(extra-mypy-options) $(python-root-list)"
     required: false
     default: ""
+  extra-docformatter-options:
+    description: "Extra options: docformatter $(extra-docformatter-options) $(python-root-list)"
+    required: false
+    default: ""
   extra-isort-options:
     description: "Extra options: isort -rc $(extra-isort-options) $(python-root-list) -c --diff "
     required: false
@@ -61,15 +77,18 @@ runs:
     - ${{ inputs.python-root-list }}
     - ${{ inputs.use-pylint }}
     - ${{ inputs.use-pycodestyle }}
+    - ${{ inputs.use-pydocstyle }}
     - ${{ inputs.use-flake8 }}
     - ${{ inputs.use-black }}
     - ${{ inputs.use-mypy }}
+    - ${{ inputs.use-docformatter }}
     - ${{ inputs.use-isort }}
     - ${{ inputs.extra-pylint-options }}
     - ${{ inputs.extra-pycodestyle-options }}
     - ${{ inputs.extra-flake8-options }}
     - ${{ inputs.extra-black-options }}
     - ${{ inputs.extra-mypy-options }}
+    - ${{ inputs.extra-docformatter-options }}
     - ${{ inputs.extra-isort-options }}
 branding:
   icon: "terminal"

entrypoint.sh

@@ -17,6 +17,8 @@
 # ${13} - extra-black-options
 # ${14} - extra-mypy-options
 # ${15} - extra-isort-options
+# ${16} - extra-docformatter-options
+# ${17} - extra-pydocstyle-options
 
 if [ "$2" = true ] ; then
 
@@ -117,9 +119,9 @@ fi
 
 if [ "$8" = true ] ; then
 
-    echo Running: docformatter $1
+    echo Running: docformatter ${16} $1
 
-    docformatter $1
+    docformatter ${16} $1
     exit_code=$?
 
     if [ "$exit_code" = "0" ]; then
@@ -132,9 +134,9 @@ fi
 
 if [ "$9" = true ] ; then
 
-    echo Running: pydocstyle $1
+    echo Running: pydocstyle ${17} $1
 
-    pydocstyle $1
+    pydocstyle ${17} $1
     exit_code=$?
 
     if [ "$exit_code" = 0 ]; then
@@ -144,3 +146,4 @@ if [ "$9" = true ] ; then
         echo $exit_code
     fi
 fi
+