tenseleyflow/shithub / 2d175a5

+#!/usr/bin/env bash

+# SPDX-License-Identifier: AGPL-3.0-or-later

+#

+# Verify that every /api/v1 route registered in

+# internal/web/handlers/api/ appears in docs/public/api/.

+#

+# We don't enforce on a per-page basis — the route just needs to

+# show up *somewhere* under docs/public/api/. The page-organization

+# is the human's call; the script catches the most common drift

+# bug (a new endpoint shipped, no doc updated).

+#

+# Excluded by design: planned-only endpoints in the docs that

+# the source doesn't yet implement (routes mentioned in tables

+# under "## Planned routes" headings). The verifier is route →

+# doc, not doc → route.

+

+set -euo pipefail

+

+ROOT="$(cd "$(dirname "$0")/.." && pwd)"

+cd "$ROOT"

+

+# Collect every /api/v1 route literal from chi route registrations.

+# Pattern: r.<Method>("/api/v1/<path>", ...)

+ROUTES_FILE="$(mktemp)"

+trap 'rm -f "$ROUTES_FILE"' EXIT

+

+grep -rhoE 'r\.(Get|Post|Put|Patch|Delete|Head|Options)\("/api/v1[^"]*"' \

+     internal/web/handlers/api 2>/dev/null \

+  | sed -E 's/^r\.[A-Z][a-z]+\("([^"]+)".*$/\1/' \

+  | sort -u > "$ROUTES_FILE"

+

+route_count=$(wc -l < "$ROUTES_FILE" | tr -d ' ')

+if [[ "$route_count" -eq 0 ]]; then

+  echo "verify-api-docs: no API routes found — is the package layout right?" >&2

+  exit 2

+fi

+

+# Concatenate every doc page into one searchable blob.

+DOC_BLOB="$(cat docs/public/api/*.md 2>/dev/null || true)"

+if [[ -z "$DOC_BLOB" ]]; then

+  echo "verify-api-docs: docs/public/api/ is empty" >&2

+  exit 2

+fi

+

+missing_count=0

+while IFS= read -r route; do

+  if ! grep -qF "$route" <<<"$DOC_BLOB"; then

+    if [[ "$missing_count" -eq 0 ]]; then

+      echo "verify-api-docs: the following routes are not documented under docs/public/api/:" >&2

+    fi

+    echo "  $route" >&2

+    missing_count=$((missing_count + 1))

+  fi

+done < "$ROUTES_FILE"

+

+if [[ "$missing_count" -gt 0 ]]; then

+  echo "" >&2

+  echo "Add a section that mentions the route literal verbatim." >&2

+  exit 1

+fi

+

+echo "verify-api-docs: all ${route_count} routes documented"

+#!/usr/bin/env bash

+# SPDX-License-Identifier: AGPL-3.0-or-later

+#

+# Every Go source file in this repo must carry an SPDX header

+# identifying the license. The convention:

+#

+#   // SPDX-License-Identifier: AGPL-3.0-or-later

+#

+# Exemptions:

+# - sqlc-generated files under */sqlc/ — the sqlc tool emits a

+#   different header. We don't maintain those by hand.

+# - Test fixtures under testdata/.

+# - Vendored code (we don't vendor today; this is forward-looking).

+#

+# Run: ./scripts/verify-spdx-headers.sh

+

+set -euo pipefail

+

+ROOT="$(cd "$(dirname "$0")/.." && pwd)"

+cd "$ROOT"

+

+WANT='// SPDX-License-Identifier: AGPL-3.0-or-later'

+missing=()

+

+# Find every committed .go file outside the exemptions, then

+# check the first 3 lines for the header.

+while IFS= read -r f; do

+  case "$f" in

+    */sqlc/*) continue ;;

+    */testdata/*) continue ;;

+    */vendor/*) continue ;;

+  esac

+  if ! head -n 3 "$f" | grep -qF "$WANT"; then

+    missing+=("$f")

+  fi

+done < <(git ls-files '*.go')

+

+if [[ ${#missing[@]} -gt 0 ]]; then

+  echo "verify-spdx-headers: the following files are missing the SPDX header:" >&2

+  printf '  %s\n' "${missing[@]}" >&2

+  echo "" >&2

+  echo "Add this line at the top (line 1 ideally, line 3 max):" >&2

+  echo "  $WANT" >&2

+  exit 1

+fi

+

+# Also enforce the same on shell scripts in scripts/ and deploy/.

+sh_missing=()

+SH_WANT='# SPDX-License-Identifier: AGPL-3.0-or-later'

+while IFS= read -r f; do

+  if ! head -n 5 "$f" | grep -qF "$SH_WANT"; then

+    sh_missing+=("$f")

+  fi

+done < <(git ls-files 'scripts/*.sh' 'deploy/**/*.sh')

+

+if [[ ${#sh_missing[@]} -gt 0 ]]; then

+  echo "verify-spdx-headers: the following shell scripts are missing the SPDX header:" >&2

+  printf '  %s\n' "${sh_missing[@]}" >&2

+  echo "" >&2

+  echo "Add this line within the first 5 lines:" >&2

+  echo "  $SH_WANT" >&2

+  exit 1

+fi

+

+echo "verify-spdx-headers: ok"