Feature: setting to give flake8 extra arguments (#41)

Alternatively, we add support for each argument; but with all the
plugins this becomes an impossible goal to reach. So instead,
allow users to customize this action how-ever they like.

Arguments that are more commonly used will still get their own
setting.

Author: TrueBrain

.github/workflows/testing.yml

@@ -82,6 +82,16 @@ jobs:
           error_classes: W,B
           only_warn: 1
 
+  run_action_with_extra_arguments:
+    name: Test run action (extra arguments)
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - uses: ./
+      with:
+        path: example_length
+        extra_arguments: "--max-line-length 90"
+
   codespell:
     name: Check for spelling errors
     runs-on: ubuntu-latest

README.md

@@ -99,7 +99,6 @@ steps:
     max_line_length: 90
 ```
 
-
 ### Parameter: only_warn
 
 Only warn about problems.
@@ -157,3 +156,18 @@ steps:
   with:
     warning_classes: W,B,D
 ```
+
+### Parameter: extra_arguments
+
+Extra arguments to give to flake8.
+Useful when you need to give an argument this action otherwise doesn't supply (like `--max-complexity`, `--hang-closing`, ...).
+
+This parameter is optional; by default it is empty.
+
+```
+steps:
+- uses: actions/checkout@v2
+- uses: TrueBrain/actions-flake8@v2
+  with:
+    extra_arguments: "--hang-closing"
+```

action.yml

@@ -34,6 +34,10 @@ inputs:
     description: 'List of flake8 error classes to classify as Warning'
     required: false
     default: ''
+  extra_arguments:
+    description: 'Extra arguments given to flake8'
+    required: false
+    default: ''
 runs:
   using: 'composite'
   steps:
@@ -60,6 +64,7 @@ runs:
       INPUT_PLUGINS: ${{ inputs.plugins }}
       INPUT_ERROR_CLASSES: ${{ inputs.error_classes }}
       INPUT_WARNING_CLASSES: ${{ inputs.warning_classes }}
+      INPUT_EXTRA_ARGUMENTS: ${{ inputs.extra_arguments }}
 branding:
   icon: 'code'
   color: 'blue'

action/entrypoint.sh

@@ -17,17 +17,27 @@ echo "::add-matcher::${ACTION_FOLDER}/flake8-matcher.json"
 
 # Create the flake8 arguments.
 echo "Running flake8 on '${INPUT_PATH}' with the following options:"
+
 command_args=""
+
 echo " - ignoring: '${INPUT_IGNORE}'"
 if [ "x${INPUT_IGNORE}" != "x" ]; then
     command_args="${command_args} --ignore ${INPUT_IGNORE}"
 fi
+
 echo " - max line length: '${INPUT_MAX_LINE_LENGTH}'"
 if [ "x${INPUT_MAX_LINE_LENGTH}" != "x" ]; then
     command_args="${command_args} --max-line-length ${INPUT_MAX_LINE_LENGTH}"
 fi
+
 echo " - path: '${INPUT_PATH}'"
 command_args="${command_args} ${INPUT_PATH}"
+
+echo " - extra arguments: '${INPUT_EXTRA_ARGUMENTS}'"
+if [ "x${INPUT_EXTRA_ARGUMENTS}" != "x" ]; then
+    command_args="${command_args} ${INPUT_EXTRA_ARGUMENTS}"
+fi
+
 echo "Resulting command: flake8 ${command_args}"
 
 # Run flake8.

example_length/example.py

@@ -0,0 +1,2 @@
+def line_that_will_be_way_too_long_but_not_long_enough_to_trigger_with_the_set_length():
+    pass