add code formatting (#465)

* add script to use clang-format to reformat all c/cpp source
* add clang formatting workflow to fail if code isn't formatted
* add clang format to development container and vscode config
* remove ubuntu-20..04 version of dev container leaving only ubuntu-latest
* add pre-commit hook
* add basic .clang-format config file
* run pre-commit checks on all files and update them
* add code formatting badge to readme

.clang-format

@@ -0,0 +1,5 @@
+---
+BasedOnStyle: Chromium
+IndentWidth: 4
+ObjCBlockIndentWidth: 4
+ColumnLimit: 200

.devcontainer/Dockerfile.ubuntu-latest → .devcontainer/Dockerfile

@@ -10,10 +10,14 @@ RUN DEBIAN_FRONTEND=noninteractive \
         tzdata\
         git \
         sudo \
-        gdb
+        gdb \
+        clang-format-14 \
+        python3-pip
 
 WORKDIR /app
 COPY .github/install_dependencies /app/
 RUN /app/install_dependencies
 
+RUN pip install pre-commit
+
 RUN apt-get clean && rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/*

.devcontainer/devcontainer.json

@@ -6,11 +6,11 @@
 	// Sets the run context to one level up instead of the .devcontainer folder.
 	"context": "..",
 
-	"dockerFile": "Dockerfile.ubuntu-latest",
+	"dockerFile": "Dockerfile",
 
 	"updateContentCommand" : "apt-get install git",
 
-	"postCreateCommand" : "cmake -B /app/build -DCMAKE_BUILD_TYPE=Debug -DNFM=TRUE -DBUILD_UNITTESTS=true",
+	"postCreateCommand" : "cmake -B /app/build -DCMAKE_BUILD_TYPE=Debug -DNFM=TRUE -DBUILD_UNITTESTS=true ; pre-commit install",
 
 	// vs code extensions to install in the dev container
 	"customizations": {
@@ -22,7 +22,8 @@
 				"twxs.cmake",
 				"streetsidesoftware.code-spell-checker",
 				"ms-azuretools.vscode-docker",
-				"GitHub.vscode-github-actions"
+				"GitHub.vscode-github-actions",
+				"xaver.clang-format"
 			]
 		}
 	},

.devcontainer/shell.ubuntu-20.04 → .devcontainer/shell

@@ -3,8 +3,7 @@
 cd `dirname $0`/../
 
 # build container
-docker build -t rtl_airband.ubuntu-20.04 -f .devcontainer/Dockerfile.ubuntu-20.04 .
+docker build -t rtl_airband-dev -f .devcontainer/Dockerfile .
 
 # run bash in container
-docker run --rm -v $(pwd):/app/ -it --entrypoint bash rtl_airband.ubuntu-20.04
-
+docker run --rm -v $(pwd):/app/ -it --entrypoint bash rtl_airband-dev

.github/ISSUE_TEMPLATE/bug_report.md

@@ -16,7 +16,7 @@ Please use this template to create your bug report. By providing as much info as
   - RTLSDR-Airband version you are using (stable release number or branch/commit):
   - `make` options used to build the program:
   - Hardware platform (eg. x86_64, Raspberry Pi v4):
-  - Operating system name and version: 
+  - Operating system name and version:
 
 **What happened?**
 

.github/workflows/build_docker_containers.yml

@@ -7,7 +7,7 @@ on:
   pull_request:
   workflow_dispatch:
   schedule:
-    - cron: '29 13 * * *' # run daily 
+    - cron: '29 13 * * *' # run daily
 
 jobs:
   build_docker_containers:
@@ -51,4 +51,3 @@ jobs:
         push: true
         tags: ${{ steps.metadata.outputs.tags }}
         labels: ${{ steps.metadata.outputs.labels }}
-

.github/workflows/ci_build.yml

@@ -7,7 +7,7 @@ on:
   pull_request:
   workflow_dispatch:
   schedule:
-    - cron: '39 13 * * *' # run daily 
+    - cron: '39 13 * * *' # run daily
 
 jobs:
   ci_build:

.github/workflows/code_formatting.yml

@@ -0,0 +1,25 @@
+name: Code Formatting
+
+on:
+  pull_request:
+  schedule:
+    - cron: '39 13 * * *' # run daily
+
+jobs:
+  code_formatting:
+    runs-on: ubuntu-latest
+    steps:
+
+    - name: Runner Info
+      run: printenv | sort
+
+    - name: Checkout
+      uses: actions/checkout@v4
+
+    - name: Install Clang Format
+      run: sudo apt-get install clang-format-14
+
+    - name: Run Clang Format
+      run: |
+        ./scripts/reformat_code
+        git diff --exit-code

.github/workflows/platform_build.yml

@@ -7,7 +7,7 @@ on:
   pull_request:
   workflow_dispatch:
   schedule:
-    - cron: '39 13 * * *' # run daily 
+    - cron: '39 13 * * *' # run daily
 
 jobs:
   platform_build:

.github/workflows/version_bump.yml

@@ -36,7 +36,7 @@ jobs:
           --repo="$GITHUB_REPOSITORY" \
           --title="Version ${tag#v}" \
           --generate-notes
-  
+
     - name: Run CI on ${{ steps.tag.outputs.new_tag }}
       env:
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.pre-commit-config.yaml

@@ -0,0 +1,14 @@
+repos:
+-   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: check-shebang-scripts-are-executable
+
+- repo: https://github.com/pre-commit/mirrors-clang-format
+  rev: v14.0.6
+  hooks:
+  - id: clang-format
+    files: src/.*\.cpp|src/.*\.h

.vscode/c_cpp_properties.json

@@ -16,4 +16,4 @@
         }
     ],
     "version": 4
-}
+}

.vscode/launch.json

@@ -30,4 +30,4 @@
         }
 
     ]
-}
+}

.vscode/settings.json

@@ -0,0 +1,7 @@
+{
+    "editor.formatOnPaste": true,
+    "editor.formatOnSave": true,
+    "editor.formatOnType": true,
+    "editor.defaultFormatter": "xaver.clang-format",
+    "clang-format.executable": "clang-format-14"
+}

Dockerfile

@@ -22,10 +22,10 @@ RUN apt-get update && \
       && \
     apt-get clean && \
     rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/*
-  
+
 # set working dir for compiling dependencies
 WORKDIR /build_dependencies
- 
+
 # compile / install rtl-sdr-blog version of rtl-sdr for v4 support
 RUN git clone https://github.com/rtlsdrblog/rtl-sdr-blog && \
     cd rtl-sdr-blog/ && \

NEWS.md

@@ -6,7 +6,7 @@ Version 5.0.0 (Jan 21, 2024):
 
 * NOTE: Going forward a release tag will be automatically created on each merge to `main`, and changes will not be reflected in this file.  For changes between versions see the repo's [release history](https://github.com/charlie-foxtrot/RTLSDR-Airband/releases).
 * NOTE: Going forward PRs will be opened directly against `main` and the `unstable` branch will no longer be used.
-* NOTE: This repo has significantly diverged from the original project [microtony/RTLSDR-Airband](https://github.com/microtony/RTLSDR-Airband) so it has been been detached (ie no longer a fork). 
+* NOTE: This repo has significantly diverged from the original project [microtony/RTLSDR-Airband](https://github.com/microtony/RTLSDR-Airband) so it has been been detached (ie no longer a fork).
 
 * Changes in this release, see [#444](https://github.com/charlie-foxtrot/RTLSDR-Airband/pull/444):
   * build and publish docker containers

README.md

@@ -3,6 +3,7 @@
 ![main](https://github.com/charlie-foxtrot/RTLSDR-Airband/actions/workflows/ci_build.yml/badge.svg?branch=main)
 ![main](https://github.com/charlie-foxtrot/RTLSDR-Airband/actions/workflows/platform_build.yml/badge.svg?branch=main)
 ![main](https://github.com/charlie-foxtrot/RTLSDR-Airband/actions/workflows/build_docker_containers.yml/badge.svg?branch=main)
+![main](https://github.com/charlie-foxtrot/RTLSDR-Airband/actions/workflows/code_formatting.yml/badge.svg?branch=main)
 
 NOTE: Changes as of v5.0.0:
  - PRs will be opened directly against `main` and the `unstable` branch will no longer be used
@@ -95,4 +96,3 @@ SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 * Copyright (C) 2012 by Steve Markgraf <steve@steve-m.de>
 * Copyright (C) 2015 by Kyle Keen <keenerd@gmail.com>
 * GNU General Public License Version 2
-

config/mixers.conf

@@ -39,7 +39,7 @@ mixers: {
   },
   mixer2: {
     outputs: (
-        {          
+        {
           type = "icecast";
           server = "icecast.server.example.org";
           port = 8080;

init.d/rtl_airband-gentoo.sh

@@ -38,4 +38,3 @@ stop() {
 	    --pidfile "${RTLAIRBAND_PIDFILE}" --quiet
 	eend $?
 }
-

scripts/reformat_code

@@ -0,0 +1,3 @@
+#!/bin/bash
+
+find src/*.h src/*.cpp src/hello_fft/*.h src/hello_fft/*.c | xargs clang-format-14 -i

src/CMakeLists.txt

@@ -354,7 +354,7 @@ if(BUILD_UNITTESTS)
 	enable_testing()
 
 	file(GLOB_RECURSE TEST_FILES "test_*.cpp")
-	list(APPEND TEST_FILES 
+	list(APPEND TEST_FILES
 		squelch.cpp
 		logging.cpp
 		filters.cpp
@@ -383,4 +383,3 @@ if(BUILD_UNITTESTS)
 	gtest_discover_tests(unittests)
 
 endif()
-

src/CMakeModules/FindMiriSDR.cmake

@@ -33,4 +33,3 @@ if(NOT MIRISDR_FOUND)
     mark_as_advanced(MIRISDR_INCLUDE_DIR MIRISDR_LIBRARY)
 
 endif(NOT MIRISDR_FOUND)
-

src/CMakeModules/FindRTLSDR.cmake

@@ -55,4 +55,3 @@ if(NOT RTLSDR_FOUND)
     mark_as_advanced(RTLSDR_INCLUDE_DIR RTLSDR_LIBRARY)
 
 endif(NOT RTLSDR_FOUND)
-