ci: add style check for doc comments (#2575)

Co-authored-by: Alexander Courtis <[email protected]>
nvim-tree · Dec 9, 2023 · 2fed5e1 · 2fed5e1
1 parent 13f967f
commit 2fed5e1
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 0 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -40,3 +40,5 @@ jobs:
           version: "0.19"
           args: --check lua
 
+      - name: doc-comments
+        run: ./scripts/doc-comments.sh
diff --git a/scripts/doc-comments.sh b/scripts/doc-comments.sh
@@ -0,0 +1,16 @@
+#!/bin/bash
+
+out=$(grep -nr "^--- @" lua)
+
+if [ "$out" ]; then
+	last_file=""
+	while read -r line; do
+		file="$(echo "$line" | cut -d: -f1)"
+		if [[ "$file" != "$last_file" ]]; then
+			echo "$file:" >&2
+			last_file="$file"
+		fi
+		echo "$line" | awk -F: '{ printf("  line %s: %s\n", $2, $3) }' >&2
+	done <<< "$out"
+	exit 1
+fi