Merge pull request #3 from alex-rakowski/linters_test

my suggest GA linters actions

Former-commit-id: 18ddf65

Author: bsavitzky

.github/workflows/linter.yml

@@ -1,4 +1,4 @@
-name: Lint with super-linter@v4
+name: Lint with super-linter@v5-slim
 
 on:
   push:
@@ -17,10 +17,14 @@ jobs:
           fetch-depth: 0
 
       - name: Lint Code Base
-        uses: github/super-linter@v4
+        uses: super-linter/super-linter/slim@v5 # updated to latest slim as quicker to download 
         env:
-          VALIDATE_ALL_CODEBASE: false
-          VALIDATE_PYTHON_FLAKE8: true
-          DEFAULT_BRANCH: "dev"
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-
+          VALIDATE_ALL_CODEBASE: false # only check changes
+          VALIDATE_PYTHON_FLAKE8: true # lint with flake8
+          DEFAULT_BRANCH: "dev" # set default branch to dev
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # for github things
+          # FILTER_REGEX_EXCLUDE: .*test/.* # exclude test dirs
+          FILTER_REGEX_EXCLUDE: .*__init__.py/.* # exclude test dirs
+          FILTER_REGEX_INCLUDE: .*py4DSTEM/.* # only look for py4DSTEM
+          LINTER_RULES_PATH: / # set toplevel dir as the path to look for rules
+          PYTHON_FLAKE8_CONFIG_FILE: .flake8 # set specific config file