Taught the lint harness to police itself

Author: flyingrobots

.clang-tidy

@@ -15,8 +15,6 @@ HeaderFilterRegex: '^(include|src|libgitledger)/.*\.(h|c)$'
 CheckOptions:
   - key: readability-identifier-naming.TypedefCase
     value: lower_case
-  - key: readability-identifier-naming.TypedefSuffix
-    value: '_t'
   - key: readability-identifier-naming.StructCase
     value: lower_case
   - key: readability-identifier-naming.UnionCase
@@ -79,7 +77,5 @@ CheckOptions:
     value: 'false'
   - key: performance-no-automatic-move.AllowedTypes
     value: ''
-  - key: portability-restrict-system-includes.Includes
-    value: '*'
   - key: misc-misplaced-const.CheckPrimitiveCasts
     value: 'true'

.editorconfig

@@ -14,9 +14,13 @@ indent_size = 4
 indent_style = space
 indent_size = 2
 
+[*.md]
+trim_trailing_whitespace = false
+
 [Makefile]
 indent_style = tab
-indent_size = 4
+indent_size = tab
+tab_width = 4
 
 [*.sh]
 indent_style = space

.github/workflows/ci.yml

@@ -75,6 +75,9 @@ jobs:
         # tools/lint/run_clang_tidy.sh filters compile_commands.json to exclude test TU entries
         run: make tidy
 
+      - name: Validate activity log schema
+        run: tools/lint/validate_activity_log.sh
+
   windows-msvc:
     name: MSVC (Windows)
     runs-on: windows-latest

.markdownlint.yaml

@@ -2,6 +2,7 @@ MD013:
   line_length: 240
   code_blocks: false
   tables: false
+MD041: true
 MD024:
   siblings_only: true
 MD029:

ACTIVITY.log.jsonl

@@ -0,0 +1,79 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "oneOf": [
+    {
+      "type": "object",
+      "required": [
+        "timestamp",
+        "branches",
+        "activity",
+        "prs"
+      ],
+      "properties": {
+        "timestamp": {
+          "type": "string"
+        },
+        "branches": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "activity": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "prs": {
+          "type": "array",
+          "items": {
+            "type": "string",
+            "pattern": "^https?://"
+          }
+        }
+      },
+      "additionalProperties": false
+    },
+    {
+      "type": "object",
+      "required": [
+        "who",
+        "what",
+        "where",
+        "when",
+        "why",
+        "how",
+        "protip"
+      ],
+      "properties": {
+        "who": {
+          "type": "string"
+        },
+        "what": {
+          "type": "string"
+        },
+        "where": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "when": {
+          "type": "string",
+          "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?Z$"
+        },
+        "why": {
+          "type": "string"
+        },
+        "how": {
+          "type": "string"
+        },
+        "protip": {
+          "type": "string"
+        }
+      },
+      "additionalProperties": false
+    }
+  ]
+}

ACTIVITY.schema.json

@@ -56,10 +56,16 @@ ACTIVITY.log.jsonl
 
 Each line is a JSON object. No merging. No overwriting. No sorting. No reordering. End it with a `\n`.
 
-***APPEND*** to this file, for example:
+***APPEND*** to this file. Use the helper to keep the schema compliant:
 
 ```bash
-echo "<message>" >> ACTIVITY.log.jsonl
+tools/log_activity.py \
+  --who AGENT \
+  --what "Describe the work" \
+  --where path/to/file \
+  --why "Explain the reason" \
+  --how "Explain the process" \
+  --protip "Share something useful"
 ```
 
 Some of you may choke on that, since I know, it's hard to escape quotes and write JSON to the command line. But you'll get the hang of it.
@@ -69,7 +75,7 @@ Required keys:
 - `who` (your name, AGENT)
 - `what` (did you do?)
 - `where` (files, etc)
-- `when` (timestamp POSIX)
+- `when` (timestamp RFC 3339 – the helper writes this for you)
 - `why` (and if you leave this out, may God have mercy on your stack trace)
 - `how` (discuss your work)
 - `protip` (leave some wisdom for the next AGENT who reads this file)

AGENTS.md

@@ -7,7 +7,7 @@ set(CMAKE_C_EXTENSIONS OFF)
 set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
 
 if(MSVC)
-    set(PROJECT_WARNING_FLAGS /W4 /WX)
+    set(PROJECT_WARNING_FLAGS /W4 /WX /we4244 /we4267 /we4456 /we4457 /we4458 /we4459)
 else()
     # Keep Unix builds strict and hide unintended symbol exports.
     set(PROJECT_WARNING_FLAGS -Wall -Wextra -Werror -Wpedantic -Wshadow -Wconversion -fvisibility=hidden)

CMakeLists.txt

@@ -1,6 +1,7 @@
 .PHONY: all test cmake meson both test-cmake test-meson test-both clean format format-check tidy lint tidy-build \
         host-cmake host-meson host-both host-test-cmake host-test-meson host-test-both \
-        host-format-check host-tidy host-lint container-format-check container-tidy container-lint
+        host-format-check host-tidy host-lint container-format-check container-tidy container-lint \
+        activity-validate
 
 all: both
 
@@ -124,12 +125,10 @@ tidy-build:
 	tools/lint/run_clang_tidy.sh $(CLANG_TIDY)
 
 markdownlint:
-	@files="$(shell git ls-files '*.md')"; \
-	if [ -z "$$files" ]; then \
-		echo "markdownlint: no markdown files found"; \
-	else \
-		$(MARKDOWNLINT) $(MARKDOWNLINT_ARGS) $$files; \
-	fi
+	@files="$(shell git ls-files '*.md')"; if [ -z "$$files" ]; then echo "markdownlint: no markdown files found"; else $(MARKDOWNLINT) $(MARKDOWNLINT_ARGS) $$files; fi
+
+activity-validate:
+	./tools/lint/validate_activity_log.sh
 
 clean:
 	rm -rf build build-debug build-release build-tidy meson-debug meson-release meson-* compile_commands.json