From dc4dac78315529d64176900b51d233aea7fa1aeb Mon Sep 17 00:00:00 2001
From: Greg Medding <gregory.medding@gm.com>
Date: Wed, 10 Jul 2024 18:48:09 -0700
Subject: [PATCH 1/2] Add clang-tidy linter script

The CI job, it turns out, has not actually been running clang-tidy
against our code. As a result, linter issues have been sneaking in to
the codebase. This script can be run to scan the entire source tree with
clang-tidy.
---
 lint/clang-tidy.sh | 42 ++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 42 insertions(+)
 create mode 100755 lint/clang-tidy.sh

diff --git a/lint/clang-tidy.sh b/lint/clang-tidy.sh
new file mode 100755
index 000000000..c45f3a94b
--- /dev/null
+++ b/lint/clang-tidy.sh
@@ -0,0 +1,42 @@
+#!/bin/bash
+
+PROJECT_ROOT="$(realpath "$(dirname "$0")/../")"
+
+if [ -n "$(which clang-tidy-12)" ]; then
+    # NOTE: Using clang-tidy-12 in CI system, too
+    LINTER=clang-tidy-12
+elif [ -n "$(which clang-tidy)" ]; then
+    echo "Did not find clang-tidy-12. Trying clang-tidy. Results may not"
+    echo "match formatting in GitHub CI process."
+    LINTER=clang-tidy
+else
+    echo "Could not find clang-tidy. Please make sure it is installed" 1>&2
+    exit 2
+fi
+
+compile_database="$1"
+
+if [ -z "$compile_database" ]; then
+	echo "No compile database specified. Make sure cmake was configured" 1>&2
+	echo "with '-DCMAKE_EXPORT_COMPILE_COMMANDS=yes' and re-run the build" 1>&2
+	exit 1
+elif [ ! -f "$compile_database" ]; then
+	echo "Compile database file not found. Make sure cmake was configured" 1>&2
+	echo "with '-DCMAKE_EXPORT_COMPILE_COMMANDS=yes' and re-run the build" 1>&2
+	exit 1
+fi
+
+compile_database="$(realpath "$compile_database")"
+
+echo "Running $LINTER on all files in '$PROJECT_ROOT'"
+shopt -s globstar
+
+pushd "$PROJECT_ROOT" > /dev/null
+for f in **/*.h **/*.cpp; do
+	if [[ ! ("$f" =~ "build/") ]]; then
+		echo
+		echo "Checking file '$f'"
+		$LINTER -p "$(dirname "$compile_database")" "$f"
+	fi
+done
+popd > /dev/null

From 95007225c61bd619ee4cfa3bb1f7bd35dedfeff8 Mon Sep 17 00:00:00 2001
From: Greg Medding <gregory.medding@gm.com>
Date: Mon, 15 Jul 2024 09:47:52 -0700
Subject: [PATCH 2/2] Allow linting a single file with clang-tidy.sh

It can take a really long time to lint the whole source tree. No
developer wants to wait around for that. This change allows developers
to run clang-tidy against the source files they are working on.
---
 lint/clang-tidy.sh | 63 +++++++++++++++++++++++++++++++++++++---------
 1 file changed, 51 insertions(+), 12 deletions(-)

diff --git a/lint/clang-tidy.sh b/lint/clang-tidy.sh
index c45f3a94b..67e9242e8 100755
--- a/lint/clang-tidy.sh
+++ b/lint/clang-tidy.sh
@@ -14,29 +14,68 @@ else
     exit 2
 fi
 
+usage() {
+	echo "$(basename "$0") path/to/compile_commands.json [source_to_lint]" 1>&2
+	echo 1>&2
+	echo "    compile_commands.json" 1>&2
+	echo "        Produced during a cmake build when configured with the" 1>&2
+	echo "        -DCMAKE_EXPORT_COMPILE_COMMANDS=yes flag" 1>&2
+	echo 1>&2
+	echo "    source_to_lint (optional)" 1>&2
+	echo "        Source file to run clang-tidy against. If not specified," 1>&2
+	echo "        all source files in the repo will be scanned." 1>&2
+}
+
+if [ "$1" == "-h" ] || [ "$1" == "--help" ] || [ "$1" == "/h" ] || [ "$1" == "/?" ]; then
+	usage
+	exit
+fi
+
 compile_database="$1"
 
 if [ -z "$compile_database" ]; then
 	echo "No compile database specified. Make sure cmake was configured" 1>&2
 	echo "with '-DCMAKE_EXPORT_COMPILE_COMMANDS=yes' and re-run the build" 1>&2
+	echo 1>&2
+	echo "Usage:" 1>&2
+	usage
 	exit 1
 elif [ ! -f "$compile_database" ]; then
 	echo "Compile database file not found. Make sure cmake was configured" 1>&2
 	echo "with '-DCMAKE_EXPORT_COMPILE_COMMANDS=yes' and re-run the build" 1>&2
+	echo 1>&2
+	echo "Usage:" 1>&2
+	usage
 	exit 1
 fi
 
 compile_database="$(realpath "$compile_database")"
 
-echo "Running $LINTER on all files in '$PROJECT_ROOT'"
-shopt -s globstar
-
-pushd "$PROJECT_ROOT" > /dev/null
-for f in **/*.h **/*.cpp; do
-	if [[ ! ("$f" =~ "build/") ]]; then
-		echo
-		echo "Checking file '$f'"
-		$LINTER -p "$(dirname "$compile_database")" "$f"
-	fi
-done
-popd > /dev/null
+target_source="$2"
+
+if [ -z "$target_source" ]; then
+	echo "Running $LINTER on all files in '$PROJECT_ROOT'"
+	shopt -s globstar
+
+	pushd "$PROJECT_ROOT" > /dev/null
+	for f in **/*.h **/*.cpp; do
+		if [[ ! ("$f" =~ "build/") ]]; then
+			echo
+			echo "Checking file '$f'"
+			$LINTER -p "$(dirname "$compile_database")" "$f"
+		fi
+	done
+	popd > /dev/null
+	exit
+fi
+
+if [ ! -f "$target_source" ]; then
+	echo "Target source file '$target_source' not found." 1>&2
+	echo 1>&2
+	echo "Usage:" 1>&2
+	usage
+	exit 1
+fi
+
+echo "Running $LINTER on '$target_source'"
+$LINTER -p "$(dirname "$compile_database")" "$target_source"