feat: replace super-linter with custom linter list

.github/etc/dictionary.txt

@@ -1,2 +1,5 @@
 capricornis
 crispus
+hadolint
+kubeconform
+textlint

.github/workflows/commit.yml

@@ -1,7 +1,7 @@
 ---
 name: "CI"
 
-on:
+on: # yamllint disable-line rule:truthy
   push:
     branches:
       - main

.github/workflows/security.yml

@@ -1,15 +1,15 @@
 ---
 name: "Security"
 
-on:
+on: # yamllint disable-line rule:truthy
   push:
     branches:
       - main
   pull_request:
     branches:
       - main
   schedule:
-    - cron: '2 3 * * *'
+    - cron: "2 3 * * *"
 
 env:
   python_version: "3.10"

CONTRIBUTING.md

@@ -1,12 +1,12 @@
 # GOAT Development Notes
 
-## Environmental Setup
+## Environment Setup
 
-Ensure you have `docker` and `pipenv` installed locally, and the `docker` daemon is running.  
-Then run the following command to install the dependencies onto your local system:  
+Ensure you have `docker` and `pipenv` installed locally, and the `docker` daemon is running.
+Then run the following command to install the dependencies onto your local system:
 
 ```bash
-pipenv install --deploy --ignore-pipfile --dev 
+pipenv install --deploy --ignore-pipfile --dev
 ```
 
 ## Running the goat against the goat project locally
@@ -25,9 +25,63 @@ There are two ways of running the `goat` locally:
 
     ```bash
     docker build .
-    docker run -e RUN_LOCAL=true -v $PWD:/goat/ --rm <first several character of the hash output from the build step>
+    docker run -v $PWD:/goat/ --rm <first several character of the hash output from the build step>
     ```
 
+3. To pass in custom configs for individual linters or to exclude files with regular expressions, set environment variables:
+
+    ```bash
+    docker run -e INPUT_EXCLUDE='.*\.json$' -e BLACK_CONFIG='--required-version 21.9b0' -v $PWD:/goat/ --rm <hash>
+
+    Running Seiso Linter
+    --------------------------
+
+    Running linter: ruff
+    Running linter: hadolint
+    Running linter: kubeconform
+    Running linter: dockerfile_lint
+    Running linter: markdown-link-check
+    Running linter: cspell
+    Running linter: cfn-lint
+    Running linter: jscpd
+    Running linter: actionlint
+    Running linter: markdownlint
+    Running linter: textlint
+    Running linter: black
+    Running linter: mypy
+    Running linter: shfmt
+    Running linter: shellcheck
+    Running linter: yamllint
+    ===============================
+    BLACK
+    -------------------------------
+    Oh no! 💥 💔 💥 The required version `21.9b0` does not match the running version `23.3.0`!
+
+    Scanned 45 files in 6 seconds
+    Excluded 575 files
+
+    INFO:  hadolint completed successfully
+    INFO:  dockerfile_lint completed successfully
+    INFO:  cfn-lint completed successfully
+    INFO:  textlint completed successfully
+    INFO:  markdownlint completed successfully
+    INFO:  mypy completed successfully
+    INFO:  jscpd completed successfully
+    INFO:  kubeconform completed successfully
+    INFO:  shellcheck completed successfully
+    INFO:  shfmt completed successfully
+    INFO:  ruff completed successfully
+    INFO:  cspell completed successfully
+    INFO:  actionlint completed successfully
+    INFO:  markdown-link-check completed successfully
+    INFO:  yamllint completed successfully
+    ERROR:  black found errors
+    ERROR:  Linting failed
+    ```
+
+    Note: Linter env variables must be formatted as <LINTER_CONFIG>, i.e. RUFF_CONFIG, CFN_LINT_CONFIG,
+    etc., and the values supplied will overwrite the default arguments supplied in the goat.
+
 ### Note
 
 If adding linters to `linters.json`, the `executor` is an optional member of the linter object.

Dockerfile

@@ -1,8 +1,10 @@
-# Based on python:alpine as of February 2021
-FROM github/super-linter:slim-v5.0.0
+FROM ghcr.io/yannh/kubeconform:v0.6.1 as kubeconform
+FROM hadolint/hadolint:v2.12.0-alpine as hadolint
+FROM koalaman/shellcheck:v0.9.0 as shellcheck
+FROM mvdan/shfmt:v3.6.0 as shfmt
+FROM rhysd/actionlint:1.6.24 as actionlint
 
-# Required for the github/super-linter log (cannot be disabled)
-RUN mkdir -p /tmp/lint/
+FROM python:3.10-alpine3.17 as base_image
 
 ENV LANG=C.UTF-8
 ENV LC_ALL=C.UTF-8
@@ -21,21 +23,31 @@ LABEL org.opencontainers.image.licenses="MIT"
 WORKDIR /etc/opt/goat/
 ENV PIP_NO_CACHE_DIR=1
 COPY Pipfile Pipfile.lock ./
+COPY --from=kubeconform /kubeconform /usr/bin/
+COPY --from=hadolint /bin/hadolint /usr/bin/
+COPY --from=shellcheck /bin/shellcheck /usr/bin/
+COPY --from=shfmt /bin/shfmt /usr/bin/
+COPY --from=actionlint /usr/local/bin/actionlint /usr/bin/
+
 # hadolint ignore=DL3016,DL3018,DL3013
 RUN pip install pipenv \
-    && pipenv install --deploy --ignore-pipfile \
-    && pip install shed ruff \
+    && pipenv install --system --deploy --ignore-pipfile \
     && apk upgrade \
     && apk --no-cache add go \
     jq \
     npm \
     tini \
-    ruby \
-    && gem install \
-    rubocop \
-    rubocop-github \
-    && npm install --no-cache -g dockerfile_lint \
+    bash \
+    git \
+    && npm install --save-dev --no-cache -g dockerfile_lint \
+    markdownlint-cli \
+    textlint \
+    textlint-filter-rule-allowlist \
+    textlint-filter-rule-comments \
+    textlint-rule-terminology \
+    textlint-plugin-rst \
     cspell \
+    jscpd \
     markdown-link-check \
     && mkdir -p /opt/goat/log
 

Pipfile

@@ -4,6 +4,11 @@ verify_ssl = true
 name = "pypi"
 
 [packages]
+ruff = "*"
+mypy = "*"
+cfn-lint = "*"
+black = "*"
+yamllint = "*" 
 
 [dev-packages]
 docker = "*"