linting / precommit

.dictionary.txt

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

.github/workflows/cancel_dupes.yml

@@ -1,15 +1,14 @@
 ---
-
 # Cancels duplicate github actions when superseded
 
 name: Cancelling Duplicates
 on:
   workflow_run:
     workflows:
-      - 'Pull Request'
-      - 'Deploy'
-      - 'Linting (Non-Image)'
-    types: ['requested']
+      - "Pull Request"
+      - "Deploy"
+      - "Linting (Non-Image)"
+    types: ["requested"]
 
 jobs:
   cancel-duplicate-workflow-runs:

.github/workflows/check_versions.yml

@@ -1,5 +1,4 @@
 ---
-
 name: Check upstream versions
 
 on:
@@ -8,7 +7,6 @@ on:
     - cron: "0 12 * * *"
 
 jobs:
-
   version_in_container:
     name: Check version in 'latest' image
     runs-on: ubuntu-latest

.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

@@ -7,8 +7,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

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

.pre-commit-config.yaml

@@ -0,0 +1,66 @@
+repos:
+  # lint yaml, line and whitespace
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.4.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
+        exclude: fa_services.tcl
+      - 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.5" # 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.9.1
+    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"]

Dockerfile

@@ -7,6 +7,7 @@ SHELL ["/bin/bash", "-o", "pipefail", "-c"]
 
 COPY rootfs/ /
 
+# hadolint ignore=DL3008,SC2086,SC2039,SC2068
 RUN set -x && \
   TEMP_PACKAGES=() && \
   KEPT_PACKAGES=() && \

README.DockerHub.md

@@ -11,8 +11,8 @@ For more information on what PiAware is, see here: [FlightAware - PiAware](https
 
 This container can operate in "net only" mode and pull ADS-B Mode-S & UAT data from another host/container. **This is the recommended way of deploying the container**, and I'd humbly suggest [`sdr-enthusiasts/docker-readsb-protobuf`](https://github.com/sdr-enthusiasts/docker-readsb-protobuf) and [`sdr-enthusiasts/docker-dump978`](https://github.com/sdr-enthusiasts/docker-dump978) (if you live in an area that uses UAT).
 
-*Note:* `bladerf`/`hackrf`/`limesdr`/`radarcape` - Support for these is compiled in, but I need to complete the wrapper/helper scripts. I don't have access to these devices. If you do, and would be willing to test, please get in touch with me!
+_Note:_ `bladerf`/`hackrf`/`limesdr`/`radarcape` - Support for these is compiled in, but I need to complete the wrapper/helper scripts. I don't have access to these devices. If you do, and would be willing to test, please get in touch with me!
 
 ## Documentation
 
-Please [read this container's detailed and thorough documentation in the GitHub repository.](https://github.com/sdr-enthusiasts/docker-piaware/blob/main/README.md)
+Please [read this container's detailed and thorough documentation in the GitHub repository.](https://github.com/sdr-enthusiasts/docker-piaware/blob/main/README.md)