Files
coder/scripts/check_emdash.sh

158 lines
5.1 KiB
Bash
Executable File

#!/usr/bin/env bash
set -euo pipefail
# shellcheck source=scripts/lib.sh
source "$(dirname "${BASH_SOURCE[0]}")/lib.sh"
cdroot
echo "--- check for emdash/endash characters"
mode="changed"
for arg in "$@"; do
if [[ "$arg" == "--all" ]]; then
mode="all"
fi
done
# Build the pattern from raw bytes so the script itself does not
# contain literal emdash/endash characters (which would trigger
# the check when the script is in the diff).
emdash=$'\xE2\x80\x94'
endash=$'\xE2\x80\x93'
pattern="${emdash}|${endash}"
# Git exclude_pathspecs excluded from the check. Used in both ls-files and diff comparison.
exclude_pathspecs=(
":(exclude)aibridge/fixtures/**/*.txtar"
# Generated CLI golden files embed serpent's emdash-bordered footer.
":(exclude)cli/testdata/*.golden"
":(exclude)enterprise/cli/testdata/*.golden"
# Generated notification golden files embed every stored notification
# template, and one carries an emdash from before this check existed
# (migration 000324). It lives in an applied migration, so it cannot be
# edited in place.
":(exclude)coderd/notifications/testdata/rendered-templates/**/*.golden"
# Vendored third-party source keeps upstream comments verbatim.
":(exclude)site/src/vendor/**"
# Third-party license texts, generated by gen_terminal_symbols_font.sh,
# must stay verbatim.
":(exclude)site/src/theme/fonts/terminal-symbols-LICENSE.txt"
)
scan_all_files() {
local output
output=$(git ls-files -z -- "${exclude_pathspecs[@]}" | xargs -0 grep -IEn "$pattern" 2>/dev/null || true)
if [[ -n "$output" ]]; then
echo "$output"
found=1
else
found=0
fi
}
# resolve_diff_base determines the base commit to diff against.
resolve_diff_base() {
# CI pull requests: actions/checkout checks out the PR merge commit
# (refs/pull/<n>/merge). Its first parent (HEAD^1) is the exact base
# commit GitHub merged against, so diffing HEAD^1 against the checkout
# yields every change the PR makes against its base branch. We rely on
# this commit rather than fetching the base branch by name: branch
# names are mutable and Graphite stacks target an ephemeral
# graphite-base/<n> ref that may not exist on origin. Requires the
# checkout to use fetch-depth >= 2 so HEAD^1 is present.
if [[ -n "${GITHUB_BASE_REF:-}" ]]; then
if ! git rev-parse --verify --quiet "HEAD^1" >/dev/null; then
echo "ERROR: the PR base commit (HEAD^1) is missing. Check out" >&2
echo " the PR with fetch-depth >= 2 so the merge commit's" >&2
echo " base parent is available." >&2
return 1
fi
git rev-parse "HEAD^1"
return
fi
# Local dev: use merge-base with origin/main.
if git rev-parse --verify origin/main >/dev/null 2>&1; then
git merge-base HEAD origin/main 2>/dev/null || echo "origin/main"
return
fi
}
# scan_diff checks only added lines in the diff for emdash/endash.
scan_diff() {
local base="$1"
local diff_output
if ! diff_output=$(git diff "$base" -U0 -- . "${exclude_pathspecs[@]}" 2>&1); then
echo "ERROR: git diff against $base failed:" >&2
echo "$diff_output" >&2
exit 1
fi
if [[ -z "$diff_output" ]]; then
echo "OK: no changes to check."
exit 0
fi
local current_file="" current_line=0
while IFS= read -r diff_line; do
if [[ "$diff_line" =~ ^\+\+\+\ b/(.*) ]]; then
current_file="${BASH_REMATCH[1]}"
fi
# Anchored to hunk header structure to avoid matching
# digits from trailing function context.
if [[ "$diff_line" =~ ^@@\ -[0-9,]+\ \+([0-9]+) ]]; then
current_line=${BASH_REMATCH[1]}
continue
fi
if [[ "$diff_line" =~ ^\+ ]] && [[ ! "$diff_line" =~ ^\+\+\+\ [ab/] ]]; then
if echo "$diff_line" | grep -Eq "$pattern"; then
echo "${current_file}:${current_line}:${diff_line:1}"
found=1
fi
((current_line++)) || true
fi
done <<<"$diff_output"
}
if [[ "$mode" == "all" ]]; then
scan_all_files
else
base=$(resolve_diff_base) || {
echo "ERROR: could not determine base ref." >&2
exit 1
}
if [[ -z "$base" ]]; then
# No base ref is available outside of pull requests, for
# example push builds on release branches with a shallow clone
# where neither GITHUB_BASE_REF nor origin/main is present.
# The diff check has nothing to compare against, and scanning
# every tracked file would flag pre-existing characters that
# are unrelated to the change under test. Skip instead; pass
# --all to force a full-tree scan.
echo "OK: no base ref found (not a pull request); skipping emdash check."
echo " Pass --all to scan every tracked file."
exit 0
fi
found=0
scan_diff "$base"
fi
if [[ "$found" -ne 0 ]]; then
echo ""
echo "ERROR: Found emdash (U+2014) or endash (U+2013) characters."
echo ""
echo " Do not use emdash or endash in code, comments, string literals,"
echo " or documentation. Use commas, semicolons, or periods instead."
echo " Restructure the sentence if needed. Do not replace them with"
echo " ' -- ' either."
echo ""
echo " Example:"
echo " Bad: This is slow [emdash] we should cache it."
echo " Good: This is slow. We should cache it."
echo " Good: This is slow, so we should cache it."
echo ""
exit 1
fi
echo "OK: no emdash or endash characters found."