chore(CI): add super-linter to help lint workspace

.eslintrc

@@ -19,6 +19,10 @@
   "plugins": [
     "prettier"
   ],
+  "ignorePatterns": [
+    "**/*.json",
+    "**/*.json5"
+  ],
   "rules": {
     "prettier/prettier": [
       1,

.github/FUNDING.yml

@@ -1,4 +1,7 @@
-custom: ['https://commerce.coinbase.com/checkout/466d703a-fbd7-41c9-8366-9bdd3e240755']
+---
+
+custom:
+  - https://commerce.coinbase.com/checkout/466d703a-fbd7-41c9-8366-9bdd3e240755
 ko_fi: miraclx
 liberapay: miraclx
 patreon: miraclx

.github/linters/.jscpd.json

@@ -0,0 +1,10 @@
+{
+  "threshold": 0,
+  "reporters": [
+    "consoleFull"
+  ],
+  "ignore": [
+    "**/.github/workflows/tests.yml"
+  ],
+  "absolute": true
+}

.github/workflows/ci-prep.sh

@@ -1,10 +1,12 @@
+#!/usr/bin/env bash
+
 RG_SRC="$(which rg)"
 rg() {
-  printf "rg: pattern: /$*/" > /dev/stderr
+  printf 'rg: pattern: %s' "/$*/" >/dev/stderr
   if $RG_SRC --fixed-strings --passthru "$@"; then
-    echo " (matched)" > /dev/stderr
+    echo " (matched)" >/dev/stderr
   else
-    echo " (failed to match)" > /dev/stderr
+    echo " (failed to match)" >/dev/stderr
     return 1
   fi
 }
@@ -16,7 +18,7 @@ freyr() {
   i=$($RG_SRC -n '.' .freyr_log | $RG_SRC --fixed-strings '[•] Embedding Metadata' | cut -d':' -f1)
   if [[ $i ]]; then
     echo "::group::[$attempts/3] View Download Status"
-    tail +$i .freyr_log
+    tail +"$i" .freyr_log
     echo "::endgroup::"
   fi
 }
@@ -25,9 +27,9 @@ exec_retry() {
   cmd="$(cat)" && attempts=1
   until eval "$cmd"; do
     echo "::endgroup::"
-    if (( attempts < 3 )); then
+    if ((attempts < 3)); then
       echo "::warning::[$attempts/3] Download failed, retrying.."
-      : $(( attempts += 1 ))
+      : $((attempts += 1))
     else
       echo "::error::[$attempts/3] Download failed."
       return 1
@@ -36,7 +38,7 @@ exec_retry() {
   echo "::endgroup::"
   echo "::group::View Files"
   STAGE=$(realpath --relative-to=../.. .) && cd ../..
-  tree -sh $STAGE
+  tree -sh "$STAGE"
   echo "::endgroup::"
 }
 
@@ -45,5 +47,5 @@ validate() {
   res=$(<.freyr_log)
   for arg in "[•] Collation Complete" "$@"; do
     res=$(echo "$res" | rg "$arg") || return 1
-  done > /dev/null
+  done >/dev/null
 }

.github/workflows/publish.yml

@@ -1,3 +1,4 @@
+---
 name: publish
 
 on:

.github/workflows/tests.yml

@@ -1,3 +1,4 @@
+---
 name: tests
 
 on:
@@ -238,3 +239,28 @@ jobs:
 
     - name: Test Docker Build
       run: docker build -t freyrcli/freyrjs .
+
+  linter:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout Repository
+      uses: actions/checkout@v2
+      with:
+        # Full git history is needed to get a proper list of changed files within `super-linter`
+        fetch-depth: 0
+
+    - name: Install Dependencies
+      run: npm ci
+
+    - name: Lint Code Base
+      uses: github/super-linter@v4
+      env:
+        VALIDATE_ALL_CODEBASE: false
+        DEFAULT_BRANCH: master
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+        LINTER_RULES_PATH: /
+        JAVASCRIPT_ES_CONFIG_FILE: .eslintrc
+        JSCPD_CONFIG_FILE: .github/linters/.jscpd.json
+        VALIDATE_JAVASCRIPT_STANDARD: false

Dockerfile

@@ -5,6 +5,7 @@ LABEL maintainer="Miraculous Owonubi <omiraculous@gmail.com>" \
   tag="alpine"
 
 # Install dependencies and clean cache
+# hadolint ignore=DL3018
 RUN apk add \
   --no-cache \
   git \
@@ -26,6 +27,7 @@ RUN mkdir /bins \
 ENV PATH "/bins:$PATH"
 
 # Create freyr user and group
+# hadolint ignore=DL4006
 RUN addgroup -g 1000 freyr \
   && adduser -DG freyr freyr \
   && echo freyr:freyr | chpasswd