linting and precommit

.dictionary.txt

@@ -0,0 +1 @@
+crate

.dockerignore

@@ -4,4 +4,4 @@
 .gitattributes
 READMETEMPLATE.md
 README.md
-buildx.sh
+buildx.sh

.github/workflows/cancel_dupes.yml

@@ -2,10 +2,10 @@ name: Cancelling Duplicates
 on:
   workflow_run:
     workflows:
-      - 'Deploy'
-      - 'Check Linting'
-      - 'Tests'
-    types: ['requested']
+      - "Deploy"
+      - "Check Linting"
+      - "Tests"
+    types: ["requested"]
 
 jobs:
   cancel-duplicate-workflow-runs:

.github/workflows/hadolint.yml

@@ -7,10 +7,9 @@ on:
     branches:
       - main
     paths:
-      - 'Dockerfile'
+      - "Dockerfile"
 
 jobs:
-
   hadolint:
     name: Run hadolint against docker files
     runs-on: ubuntu-latest

.github/workflows/markdownlint.yml

@@ -8,8 +8,8 @@ on:
       - main
       # only run these if markdown files are updated
     paths:
-      - '**.md'
-      - '**.MD'
+      - "**.md"
+      - "**.MD"
 
 jobs:
   markdownlint:

.github/workflows/on_pr.yml

@@ -11,16 +11,15 @@ on:
       - main
     # Don't trigger if it's just a documentation update
     paths-ignore:
-      - '**.md'
-      - '**.MD'
-      - '**.yml'
-      - 'LICENSE'
-      - '.gitattributes'
-      - '.gitignore'
-      - '.dockerignore'
+      - "**.md"
+      - "**.MD"
+      - "**.yml"
+      - "LICENSE"
+      - ".gitattributes"
+      - ".gitignore"
+      - ".dockerignore"
 
 jobs:
-
   test-build:
     name: Test
     uses: sdr-enthusiasts/common-github-workflows/.github/workflows/build_and_push_image.yml@main

.github/workflows/pre-commit-updates.yaml

@@ -0,0 +1,23 @@
+name: Update pre-commit hooks
+
+on:
+  workflow_dispatch:
+  schedule:
+    - cron: 0 0 * * *
+
+jobs:
+  update:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/[email protected]
+        with:
+          fetch-depth: 0
+      - uses: vrslev/[email protected]
+      - uses: peter-evans/create-pull-request@v5
+        with:
+          branch: pre-commit-autoupdate
+          title: "chore(deps): Update pre-commit hooks"
+          commit-message: "chore(deps): Update pre-commit hooks"
+          body: Update pre-commit hooks
+          labels: dependencies
+          delete-branch: True

.github/workflows/yamllint.yml

@@ -8,7 +8,7 @@ on:
       - main
       # only run when yaml files are updated
     paths:
-      - '**.yml'
+      - "**.yml"
 
 jobs:
   yamllint:

.hadolint.yaml

@@ -1,3 +1,3 @@
 ignored:
   - DL3008
-  - SC2086
+  - SC2086

.markdownlint.json

@@ -1,5 +1,5 @@
 {
-    "MD029": false,
-    "MD013": false,
-    "MD009": false
+  "MD029": false,
+  "MD013": false,
+  "MD009": false
 }

.pre-commit-config.yaml

@@ -0,0 +1,65 @@
+repos:
+  # lint yaml, line and whitespace
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.5.0
+    hooks:
+      - id: check-yaml
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+      - id: requirements-txt-fixer
+      - id: mixed-line-ending
+      - id: check-executables-have-shebangs
+      - id: check-shebang-scripts-are-executable
+
+  # lint the dockerfiles
+  - repo: https://github.com/hadolint/hadolint
+    rev: v2.12.1-beta
+    hooks:
+      - id: hadolint
+
+  # prettier
+  - repo: https://github.com/pre-commit/mirrors-prettier
+    rev: "v3.0.3" # Use the sha / tag you want to point at
+    hooks:
+      - id: prettier
+        types_or: [file, bash, sh, javascript, jsx, ts, tsx]
+        additional_dependencies:
+          - [email protected]
+        exclude: ^(Dockerfile*)
+
+  - repo: https://github.com/codespell-project/codespell.git
+    rev: "v2.2.6" # Use the sha / tag you want to point at
+    hooks:
+      - id: codespell
+        types: [text]
+        args: [--ignore-words=.dictionary.txt]
+        exclude: ^(Dockerfile*)
+
+  - repo: https://github.com/shellcheck-py/shellcheck-py
+    rev: v0.9.0.6
+    hooks:
+      - id: shellcheck
+
+  - repo: https://github.com/sirosen/check-jsonschema
+    rev: 0.27.0
+    hooks:
+      - id: check-github-actions
+      - id: check-github-workflows
+
+  - repo: https://github.com/doublify/pre-commit-rust
+    rev: v1.0
+    hooks:
+      - id: fmt
+      - id: cargo-check
+
+    # lint python formatting
+  - repo: https://github.com/psf/black
+    rev: 23.10.0
+    hooks:
+      - id: black
+
+  - repo: https://github.com/pycqa/flake8
+    rev: "6.1.0" # pick a git hash / tag to point to
+    hooks:
+      - id: flake8
+        args: ["--extend-ignore=W503,W504,E501"]

rootfs/etc/nginx.tar1090/nginx.conf

@@ -55,4 +55,3 @@ http {
 	include /etc/nginx/conf.d/*.conf;
 	include /etc/nginx/sites-enabled/*;
 }
-

rootfs/etc/s6-overlay/scripts/06-range-outline

@@ -9,7 +9,7 @@ if [ -n "${HEYWHATSTHAT_PANORAMA_ID}" ]; then
 
     HEYWHATSTHAT_ALTS="${HEYWHATSTHAT_ALTS:-12192m}"
 
-    if grep -e "[^0-9kmft,]" <<< "${HEYWHATSTHAT_ALTS}" >/dev/null 2>&1; then 
+    if grep -e "[^0-9kmft,]" <<< "${HEYWHATSTHAT_ALTS}" >/dev/null 2>&1; then
         echo "[$(date)][06-range-outline] FATAL: Illegal character in HEYWHATSTHAT_ALTS=${HEYWHATSTHAT_ALTS}"
         exit 1
     fi

rootfs/etc/s6-overlay/scripts/07-ngnix-logging

@@ -17,4 +17,4 @@ if ! chk_enabled "${HTTP_ERROR_LOG}"; then
 else
     # shellcheck disable=SC1003
     sed -i 's\error_log .*\error_log /dev/stdout notice;\' /etc/nginx/nginx.conf
-fi
+fi

rootfs/etc/s6-overlay/scripts/08-graphs1090-down

@@ -6,4 +6,3 @@ source /scripts/common
 if chk_enabled "${GRAPHS1090_DISABLE}"; then
     exit 0
 fi
-

rootfs/etc/s6-overlay/scripts/collectd

@@ -22,7 +22,7 @@ elif [[ -f "${PERMFILE}" ]] && ! [[ -d /var/lib/collectd/rrd/localhost ]]; then
 fi
 
 
-# wait for neccessary input file to exist before starting
+# wait for necessary input file to exist before starting
 
 loop_count=0
 # shellcheck disable=SC2016
@@ -48,5 +48,3 @@ if chk_enabled "${GRAPHS1090_REDUCE_IO}"; then
     # writeback
     s6wrap --quiet --prepend=graphs1090-writeback --timestamps --args bash /usr/share/graphs1090/writeback.sh
 fi
-
-

rootfs/etc/s6-overlay/scripts/readsb

@@ -122,7 +122,7 @@ fi
 #
 if [[ -n "$READSB_NET_API_PORT" ]]; then
     READSB_CMD+=("--net-api-port=$READSB_NET_API_PORT")
-else 
+else
     READSB_CMD+=("--net-api-port=30152")
 fi
 
@@ -250,7 +250,7 @@ fi
 if [[ -n "$READSB_GAIN" ]]; then
     if [[ "${READSB_GAIN,,}" == "autogain" ]] && [[ -f /var/globe_history/autogain/gain ]]; then
         read -r gain < /var/globe_history/autogain/gain
-        READSB_CMD+=("--gain=$gain") 
+        READSB_CMD+=("--gain=$gain")
     elif [[ -n "$READSB_GAIN" ]]; then
         [[ "${READSB_GAIN,,}" == "autogain" ]] && gain="49.6" || gain="${READSB_GAIN}"
         READSB_CMD+=("--gain=$gain")
@@ -316,9 +316,9 @@ if [[ -n "$READSB_BEAST_BAUDRATE" ]]; then
 fi
 
 #####################
-# Handle --write-prom=<filepath> 
+# Handle --write-prom=<filepath>
 
-if [[ -n "$PROMETHEUS_ENABLE" ]]; then 
+if [[ -n "$PROMETHEUS_ENABLE" ]]; then
     READSB_CMD+=("--write-prom=/run/readsb-prometheus.prom")
 fi
 

rootfs/etc/s6-overlay/scripts/timelapse1090

@@ -25,7 +25,7 @@ if chk_enabled "$ENABLE_TIMELAPSE1090" && ! chk_enabled "${TAR1090_DISABLE}"; th
     s6wrap --quiet --prepend=timelapse1090 --timestamps --args /opt/timelapse1090/timelapse1090.sh &
     wait $!
   popd || exit 1
-  
+
   sleep 30 & wait $!
 else
   exec sleep infinity

rootfs/healthcheck.sh

@@ -13,7 +13,7 @@ if [ -f "/run/readsb/aircraft.json" ]; then
     # get current timestamp
     TIMESTAMP_NOW=$(date +"%s.%N")
 
-    # makse sure readsb has updated json in past 60 seconds
+    # make sure readsb has updated json in past 60 seconds
     TIMEDELTA=$(echo "$TIMESTAMP_NOW - $TIMESTAMP_LAST_READSB_UPDATE" | bc)
     if [ "$(echo "$TIMEDELTA" \< 60 | bc)" -ne 1 ]; then
         echo "readsb last updated: ${TIMESTAMP_LAST_READSB_UPDATE}, now: ${TIMESTAMP_NOW}, delta: ${TIMEDELTA}. UNHEALTHY"

rootfs/tar1090-install.sh

@@ -173,7 +173,7 @@ if [[ -n $2 ]]; then
 elif [[ -n $1 ]] && [ "$1" != "test" ] ; then
     instances="$1 tar1090"
 elif [ -f /etc/default/tar1090_instances ]; then
-    instances=$(</etc/default/tar1090_instances)	
+    instances=$(</etc/default/tar1090_instances)
 else
     instances="$srcdir tar1090"
 fi
@@ -463,4 +463,3 @@ elif [[ $nginx == yes ]]; then
 else
     echo "All done! You'll need to configure your webserver yourself, see ${ipath}/nginx-tar1090.conf for a reference nginx configuration"
 fi
-

rootfs/usr/local/bin/autogain1090

@@ -30,7 +30,7 @@ if [[ "$1" == "reset" ]]; then
     pkill -f "/usr/local/bin/readsb"
     exit 0
 fi
- 
+
 if ! [[ -f $stats ]]; then echo "stats.json not found, is the decoder running?"; exit 1; fi
 
 oldstrong=$(cat $autogain_dir/strong 2>/dev/null)