refactor: arrange tools to execute in order

Run autoformatters first, then check the results with style checkers.
Type check and lint after this.

Author: weibullguy

README.md

@@ -13,6 +13,8 @@ This action may be used to execute the following applications:
 - [pycodestyle](https://pycodestyle.readthedocs.io)
 - [flake8](http://flake8.pycqa.org)
 - [mypy](http://mypy-lang.org/)
+- [docformatter](https://github.com/myint/docformatter)
+- [pydocstyle](https://github.com/PyCQA/pydocstyle/)
 
 ## Usage
 
@@ -48,6 +50,8 @@ steps:
       extra-black-options: ""
       extra-mypy-options: ""
       extra-isort-options: ""
+      extra-docformatter-options: ""
+      extra-pydocstyle-options: ""
 ```
 
 Command build logic list:
@@ -65,9 +69,9 @@ mypy $(extra-mypy-options) $(python-root-list)
 
 isort $(extra-isort-options) $(python-root-list) -c --diff
 
-docformatter ${python-root-list}
+docformatter $(extra-docformatter-options) $(python-root-list)
 
-pydocstyle ${python-root-list}
+pydocstyle $(extra-pydocstyle-options) $(python-root-list)
 ```
 
 ## Versions used

action.yml

@@ -5,68 +5,68 @@ inputs:
     description: "A list of all paths to test"
     required: false
     default: "."
-  use-pylint:
-    description: "Use Pylint"
+  use-black:
+    description: "Use Black"
     required: false
     default: true
-  use-pycodestyle:
-    description: "Use pycodestyle"
+  use-isort:
+    description: "Use isort"
     required: false
     default: true
-  use-pydocstyle:
-    description: "Use pydocstyle"
+  use-docformatter:
+    description: "Use docformatter"
     required: false
     default: true
-  use-flake8:
-    description: "Use Flake8"
+  use-pycodestyle:
+    description: "Use pycodestyle"
     required: false
     default: true
-  use-black:
-    description: "Use Black"
+  use-pydocstyle:
+    description: "Use pydocstyle"
     required: false
     default: true
   use-mypy:
     description: "Use mypy"
     required: false
     default: true
-  use-docformatter:
-    description: "Use docformatter"
+  use-pylint:
+    description: "Use Pylint"
     required: false
     default: true
-  use-isort:
-    description: "Use isort"
+  use-flake8:
+    description: "Use Flake8"
     required: false
     default: true
-  extra-pylint-options:
-    description: "Extra options: pylint $(extra-pylint-options) $(python-root-list)"
+  extra-black-options:
+    description: "Extra options: black --check $(extra-black-options) $(python-root-list)"
     required: false
     default: ""
-  extra-pycodestyle-options:
-    description: "Extra options: pycodestyle $(extra-pycodestyle-options) $(python-root-list)"
+  extra-isort-options:
+    description: "Extra options: isort -rc $(extra-isort-options) $(python-root-list) -c --diff "
     required: false
     default: ""
-  extra-pydocstyle-options:
-    description: "Extra options: pydocstyle $(extra-pydocstyle-options) $(python-root-list)"
+  extra-docformatter-options:
+    description: "Extra options: docformatter $(extra-docformatter-options) $(python-root-list)"
     required: false
     default: ""
-  extra-flake8-options:
-    description: "Extra options: flake8 $(extra-flake8-options) $(python-root-list)"
+  extra-pycodestyle-options:
+    description: "Extra options: pycodestyle $(extra-pycodestyle-options) $(python-root-list)"
     required: false
     default: ""
-  extra-black-options:
-    description: "Extra options: black --check $(extra-black-options) $(python-root-list)"
+  extra-pydocstyle-options:
+    description: "Extra options: pydocstyle $(extra-pydocstyle-options) $(python-root-list)"
     required: false
     default: ""
   extra-mypy-options:
     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)"
+  extra-pylint-options:
+    description: "Extra options: pylint $(extra-pylint-options) $(python-root-list)"
     required: false
     default: ""
-  extra-isort-options:
-    description: "Extra options: isort -rc $(extra-isort-options) $(python-root-list) -c --diff "
+  extra-flake8-options:
+    description: "Extra options: flake8 $(extra-flake8-options) $(python-root-list)"
     required: false
     default: ""
 

entrypoint.sh

@@ -20,38 +20,55 @@
 # ${16} - extra-docformatter-options
 # ${17} - extra-pydocstyle-options
 
-if [ "$8" = true ] ; then
+# Run the autoformatters first.
+if [ "$5" = true ] ; then
 
-    echo Running: docformatter ${16} $1
+    echo Running: black --check ${13} $1
 
-    docformatter ${16} $1
+    black --check ${13} $1
     exit_code=$?
 
     if [ "$exit_code" = "0" ]; then
-        echo "docformetter ok"
+        echo "Black ok"
     else
-        echo "docformatter error"
-        echo $exit_code
+        echo "Black error"
+        exit $exit_code
     fi
+
 fi
 
-if [ "$2" = true ] ; then
+if [ "$7" = true ] ; then
 
-    echo Running: pylint ${10} $1
+    echo Running: isort ${15} $1 -c --diff
 
-    pylint ${10} $1
+    isort ${15} $1 -c --diff
     exit_code=$?
 
     if [ "$exit_code" = "0" ]; then
-        echo "Pylint ok"
+        echo "isort ok"
     else
-        echo "Pylint error"
+        echo "isort error"
         exit $exit_code
     fi
 
 fi
 
+if [ "$8" = true ] ; then
+
+    echo Running: docformatter ${16} $1
+
+    docformatter ${16} $1
+    exit_code=$?
+
+    if [ "$exit_code" = "0" ]; then
+        echo "docformatter ok"
+    else
+        echo "docformatter error"
+        echo $exit_code
+    fi
+fi
 
+# Then check the autoformatter results.
 if [ "$3" = true ] ; then
 
     echo Running: pycodestyle ${11} $1
@@ -83,65 +100,51 @@ if [ "$9" = true ] ; then
     fi
 fi
 
-if [ "$4" = true ] ; then
-
-    echo Running: flake8 ${12} $1
-
-    flake8 ${12} $1
-    exit_code=$?
-
-    if [ "$exit_code" = "0" ]; then
-        echo "Flake8 ok"
-    else
-        echo "Flake8 error"
-        exit $exit_code
-    fi
-
-fi
-
-if [ "$5" = true ] ; then
+# Next type check everything.
+if [ "$6" = true ] ; then
 
-    echo Running: black --check ${13} $1
+    echo Running: mypy ${14} $1
 
-    black --check ${13} $1
+    mypy ${14} $1
     exit_code=$?
 
     if [ "$exit_code" = "0" ]; then
-        echo "Black ok"
+        echo "mypy ok"
     else
-        echo "Black error"
+        echo "mypy error"
         exit $exit_code
     fi
 
 fi
 
-if [ "$6" = true ] ; then
+# Finally, lint the code.
+if [ "$2" = true ] ; then
 
-    echo Running: mypy ${14} $1
+    echo Running: pylint ${10} $1
 
-    mypy ${14} $1
+    pylint ${10} $1
     exit_code=$?
 
     if [ "$exit_code" = "0" ]; then
-        echo "mypy ok"
+        echo "Pylint ok"
     else
-        echo "mypy error"
+        echo "Pylint error"
         exit $exit_code
     fi
 
 fi
 
-if [ "$7" = true ] ; then
+if [ "$4" = true ] ; then
 
-    echo Running: isort ${15} $1 -c --diff
+    echo Running: flake8 ${12} $1
 
-    isort ${15} $1 -c --diff
+    flake8 ${12} $1
     exit_code=$?
 
     if [ "$exit_code" = "0" ]; then
-        echo "isort ok"
+        echo "Flake8 ok"
     else
-        echo "isort error"
+        echo "Flake8 error"
         exit $exit_code
     fi