shishantbiswas/coder
1
0
Fork 0
mirror of https://github.com/coder/coder.git synced 2026-06-02 20:48:20 +00:00
Code Issues Packages Projects Releases Wiki Activity

chore: add no-emdash/endash rule to agent instructions and CI lint (#24375)

Browse Source 
Add a lint check that prevents introduction of Unicode emdash (U+2014)
and endash (U+2013) characters. These are almost exclusively introduced
by AI agents and conflict with the project writing style.

The lint script (scripts/check_emdash.sh) checks only added lines in
the current diff by default, so existing violations do not block CI.
Pass --all to scan the entire repo for auditing.

Agent instructions in AGENTS.md, site/AGENTS.md, and the docs style
guide now explicitly ban emdash, endash, and " -- " as punctuation,
with guidance to use commas, semicolons, or periods instead.
This commit is contained in:
Mathias Fredriksson
2026-04-21 13:55:24 +03:00
committed by GitHub
parent 9d0469fc4c
commit 623e72d72d
5 changed files with 146 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.claude/docs/DOCS_STYLE_GUIDE.md
+7
View File
@@ -150,6 +150,13 @@ Then ask: "Could you provide a screenshot of the Template Insights page? I've ad
- Inline: `` `coder server` ``
- Blocks: Use triple backticks with language identifier
### Punctuation
- Do not use emdash (U+2014), endash (U+2013), or ` -- ` as punctuation
in code, comments, string literals, or documentation. Use commas,
semicolons, or periods instead. Restructure the sentence if needed.
For numeric ranges, use a plain hyphen (e.g., `0-100`).
### Instructions
- **Numbered lists** for sequential steps
AGENTS.md
+16
View File
@@ -286,6 +286,22 @@ ctx, cancel := context.WithTimeout(ctx, 5*time.Minute)
ctx, cancel := context.WithTimeout(ctx, 5*time.Minute)
```
### No Emdash or Endash
Do not use emdash (U+2014), endash (U+2013), or ` -- ` as punctuation
in code, comments, string literals, or documentation. Use commas,
semicolons, or periods instead. Restructure the sentence if needed.
Do not replace an emdash with ` -- `. Unicode emdash and endash are
caught by `make lint/emdash`.
```go
// Good: uses a period to separate the clauses.
// This is slow. We should cache it.
// Good: uses a comma to join related clauses.
// This is slow, so we should cache it.
```
### Avoid Unnecessary Changes
When fixing a bug or adding a feature, don't modify code unrelated to your
Makefile
+6 -2
View File
@@ -699,11 +699,11 @@ endif
# GitHub Actions linters are run in a separate CI job (lint-actions) that only
# triggers when workflow files change, so we skip them here when CI=true.
LINT_ACTIONS_TARGETS := $(if $(CI),,lint/actions/actionlint)
lint: lint/shellcheck lint/go lint/ts lint/examples lint/helm lint/site-icons lint/markdown lint/check-scopes lint/migrations lint/bootstrap $(LINT_ACTIONS_TARGETS)
lint: lint/shellcheck lint/go lint/ts lint/examples lint/helm lint/site-icons lint/markdown lint/check-scopes lint/migrations lint/bootstrap lint/emdash $(LINT_ACTIONS_TARGETS)
.PHONY: lint
# Subset of lint that does not require Go or Node toolchains.
lint-light: lint/shellcheck lint/markdown lint/helm lint/bootstrap lint/migrations lint/actions/actionlint lint/typos
lint-light: lint/shellcheck lint/markdown lint/helm lint/bootstrap lint/migrations lint/actions/actionlint lint/typos lint/emdash
.PHONY: lint-light
lint/site-icons:
@@ -738,6 +738,10 @@ lint/bootstrap:
bash scripts/check_bootstrap_quotes.sh
.PHONY: lint/bootstrap
lint/emdash:
bash scripts/check_emdash.sh
.PHONY: lint/emdash
lint/helm:
cd helm/
scripts/check_emdash.sh
Executable
+113
View File
@@ -0,0 +1,113 @@
#!/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}"
scan_all_files() {
local output
output=$(git ls-files -z | xargs -0 grep -IEn "$pattern" 2>/dev/null || true)
if [[ -n "$output" ]]; then
echo "$output"
found=1
else
found=0
fi
}
if [[ "$mode" == "all" ]]; then
scan_all_files
else
base=""
if [[ -n "${GITHUB_BASE_REF:-}" ]]; then
base="origin/${GITHUB_BASE_REF}"
elif git rev-parse --verify origin/main >/dev/null 2>&1; then
base=$(git merge-base HEAD origin/main 2>/dev/null || echo "origin/main")
fi
if [[ -z "$base" ]]; then
echo "WARNING: no base ref found, scanning all tracked files."
scan_all_files
else
# Ensure the base ref is fetchable. CI shallow clones
# (fetch-depth: 1) may not have the base branch available.
if ! git rev-parse --verify "$base" >/dev/null 2>&1; then
ref="${base#origin/}"
echo "Base ref $base not found locally, fetching $ref..."
git fetch origin "$ref" --depth=1 2>/dev/null || true
if ! git rev-parse --verify "$base" >/dev/null 2>&1; then
echo "ERROR: could not fetch base ref $base."
exit 1
fi
fi
found=0
if ! diff_output=$(git diff "$base" -U0 -- . 2>&1); then
echo "ERROR: git diff against $base failed:"
echo "$diff_output"
exit 1
fi
if [[ -z "$diff_output" ]]; then
echo "OK: no changes to check."
exit 0
fi
# Parse the diff to check only added lines for emdash/endash.
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"
fi
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."
site/AGENTS.md
+4 -1
View File
@@ -71,8 +71,11 @@ When investigating or editing TypeScript/React code, always use the TypeScript l
If sibling components initialize state with `useMemo`, don't switch to
`useState(initialFn)` in the same file without reason.
- Match errors by error code or HTTP status, never by comparing error
message strings. String matching is brittle — messages change, get
message strings. String matching is brittle; messages change, get
localized, or get reformatted.
- Do not use emdash (U+2014), endash (U+2013), or ` -- ` as punctuation
in code, comments, string literals, or documentation. Use commas,
semicolons, or periods instead. Restructure the sentence if needed.
## TypeScript Type Safety