Feature: add support for flake8 plugins like flake8-bugbear (#36)

Author: lt-mayonesa

.github/workflows/testing.yml

@@ -58,6 +58,30 @@ jobs:
       with:
         path: example_valid_py39
 
+  run_action_with_plugin:
+    name: Test run action (plugins)
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ./
+        with:
+          plugins: flake8-bugbear
+          path: example_bugbear
+          only_warn: 1
+
+  run_action_with_classes:
+    name: Test run action (classes)
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ./
+        with:
+          plugins: flake8-bugbear
+          path: example_bugbear
+          warning_classes: E,F
+          error_classes: W,B
+          only_warn: 1
+
   codespell:
     name: Check for spelling errors
     runs-on: ubuntu-latest

README.md

@@ -15,7 +15,7 @@ steps:
 - uses: TrueBrain/actions-flake8@v2
 ```
 
-By default it uses the default Python version as installed on the GitHub Runner.
+By default, it uses the default Python version as installed on the GitHub Runner.
 
 ### Different Python version
 
@@ -115,3 +115,45 @@ steps:
   with:
     only_warn: 1
 ```
+
+### Parameter: plugins
+
+List of plugins to install before running, This is passed directly to `pip install`.
+
+This parameter is optional; setting this to any value will enable it.
+
+```
+steps:
+- uses: actions/checkout@v2
+- uses: TrueBrain/actions-flake8@v2
+  with:
+    plugins: flake8-bugbear cohesion==0.9.1
+```
+
+### Parameter: error_classes
+
+List of flake8 [error classes](https://flake8.pycqa.org/en/latest/glossary.html#term-error-class) to classify as Error.
+
+This parameter is optional; by default `E` and `F` classes will be considered errors.
+
+```
+steps:
+- uses: actions/checkout@v2
+- uses: TrueBrain/actions-flake8@v2
+  with:
+    error_classes: E,H
+```
+
+### Parameter: warning_classes
+
+List of flake8 [error classes](https://flake8.pycqa.org/en/latest/glossary.html#term-error-class) to classify as Warning.
+
+This parameter is optional; by default all classes not contained in `error_classes` will be considered a warning.
+
+```
+steps:
+- uses: actions/checkout@v2
+- uses: TrueBrain/actions-flake8@v2
+  with:
+    warning_classes: W,B,D
+```

action.yml

@@ -22,6 +22,18 @@ inputs:
     description: 'What flake8 version to use, if none is installed (default is latest)'
     required: false
     default: ''
+  plugins:
+    description: 'List of plugins to install before running, this is passed directly to pip install'
+    required: false
+    default: ''
+  error_classes:
+    description: 'List of flake8 error classes to classify as Error'
+    required: false
+    default: 'E,F'
+  warning_classes:
+    description: 'List of flake8 error classes to classify as Warning'
+    required: false
+    default: ''
 runs:
   using: 'composite'
   steps:
@@ -31,7 +43,11 @@ runs:
       else
         flake8_version="==${{ inputs.flake8_version }}"
       fi
-      pip install flake8${flake8_version}
+      plugins=
+      if [ -n "${{ inputs.plugins }}" ]; then
+        plugins="${{ inputs.plugins }}"
+      fi
+      pip install flake8${flake8_version} ${plugins}
     shell: bash
   - run: ${{ github.action_path }}/action/entrypoint.sh
     shell: bash
@@ -41,6 +57,9 @@ runs:
       INPUT_MAX_LINE_LENGTH: ${{ inputs.max_line_length }}
       INPUT_ONLY_WARN: ${{ inputs.only_warn }}
       INPUT_FLAKE8_VERSION: ${{ inputs.flake8_version }}
+      INPUT_PLUGINS: ${{ inputs.plugins }}
+      INPUT_ERROR_CLASSES: ${{ inputs.error_classes }}
+      INPUT_WARNING_CLASSES: ${{ inputs.warning_classes }}
 branding:
   icon: 'code'
   color: 'blue'

action/entrypoint.sh

@@ -2,6 +2,17 @@
 
 # Enable the matcher.
 ACTION_FOLDER=$(dirname ${0})
+echo " - error_classes: '${INPUT_ERROR_CLASSES}'"
+error_classes=$(echo "${INPUT_ERROR_CLASSES}" | sed "s/,//g")
+sed -i "s/{{error_classes}}/${error_classes}/g" "${ACTION_FOLDER}/flake8-matcher.json"
+
+echo " - warning_classes: '${INPUT_WARNING_CLASSES}'"
+if [ -n "${INPUT_WARNING_CLASSES}" ]; then
+  warning_classes=$(echo "${INPUT_WARNING_CLASSES}" | sed "s/,//g")
+  sed -i "s/{{warning_classes}}/${warning_classes}/g" "${ACTION_FOLDER}/flake8-matcher.json"
+else
+  sed -i "s/{{warning_classes}}/^${error_classes}/g" "${ACTION_FOLDER}/flake8-matcher.json"
+fi
 echo "::add-matcher::${ACTION_FOLDER}/flake8-matcher.json"
 
 # Create the flake8 arguments.

action/flake8-matcher.json

@@ -5,7 +5,7 @@
             "severity": "error",
             "pattern": [
                 {
-                    "regexp": "^([^:]*):(\\d+):(\\d+): ([EF]\\d\\d\\d) (.*)$",
+                    "regexp": "^([^:]*):(\\d+):(\\d+): ([{{error_classes}}]\\d\\d\\d) (.*)$",
                     "file": 1,
                     "line": 2,
                     "column": 3,
@@ -19,7 +19,7 @@
             "severity": "warning",
             "pattern": [
                 {
-                    "regexp": "^([^:]*):(\\d+):(\\d+): ([W]\\d\\d\\d) (.*)$",
+                    "regexp": "^([^:]*):(\\d+):(\\d+): ([{{warning_classes}}]\\d\\d\\d) (.*)$",
                     "file": 1,
                     "line": 2,
                     "column": 3,

example_bugbear/example.py

@@ -0,0 +1,2 @@
+def good_buggy_code(mutable=[]):
+    pass