## Merge order This PR was stacked on #30879, which has merged. It now targets `main` and has no remaining dependency. ## Summary The axe Linter checks only one rule in Markdown, `heading-order`, and markdownlint `MD001` already covers it for Markdown headings. This PR adds owned checks for the raw HTML in docs Markdown that neither tool sees, so the coverage stays when the licence ends. - `Coder.HeadingOrder` (Vale) flags heading-level skips and counts raw `<hN>` headings, such as the `<h3>` headings `scripts/apidocgen` emits, which `MD001` ignores. - `Coder.EmptyHeading` (Vale) flags headings with no text, in Markdown and raw HTML. - `Coder.LinkName` (Vale) flags links with no text: `[](url)`, links whose only content is an image with empty alt text, and empty `<a href>`. - `docshtmlcheck` now rejects `aria-*`, `role`, `tabindex`, and `lang` attributes, and `iframe`, `object`, `area`, `form`, `input`, `select`, `textarea`, `button`, and `meta` elements. No docs page uses any of them, so the 32 axe HTML rules that check them have nothing to check, and this keeps it that way. - The style guide's decorative-image example changes from ``, which `MD045` rejects, to `<img src="…" alt="">`. No docs page used the old form. - The style guide's checks table gains a row per new check, and the coverage counts move the descriptive-link-text section from planned to tool-checked (22 of 90 rules tool-checked, up from 21 on `main`). ## Design All three Vale rules are `script` rules on `raw` scope, because heading levels, empty headings, and links with no text only show up in the raw source. Raw scope also reaches YAML front matter, fenced code, HTML comments, and inline code, so the scripts skip those themselves. Fence tracking matches the opening marker's character and length, so a four-backtick fence holding a three-backtick one stays closed correctly. The patterns use only capture groups that always participate, because Tengo's `text.re_find` panics on a group that didn't match. `Coder.HeadingOrder` is built to agree with `MD001` without reporting the same skip twice. It tracks the previous heading of any kind and the previous Markdown heading. It stays quiet on a Markdown heading that `MD001` already reports (a skip measured against the previous Markdown heading) and reports the skips `MD001` can't see: a raw HTML heading that skips, and a Markdown heading that skips only because a raw HTML heading sits before it. On a probe file covering each case, the two tools reported disjoint lines. The one remaining divergence is by design: after `## A`, `<h3>B</h3>`, `#### C`, `MD001` reports C (it sees H2 to H4) while this rule sees a clean H2, H3, H4 sequence and stays quiet, so the author still gets exactly one finding. The `docshtmlcheck` guard is a separate `guard.go` that runs on each start tag the existing tokenizer already walks. The elements stay in `allowedElements`, so authors get a message explaining why the element doesn't belong rather than the generic unknown-element one, and a closed `<button>` still balances. Guard findings get their own kinds (`disallowed-element`, `disallowed-attribute`) and their own summary footer. I included `form` alongside the form controls the issue lists, since a form with no controls has no use either. Known gaps, documented in each rule's header and none hit by the current corpus: setext headings, headings inside block quotes or list items, raw HTML headings or links split across lines, reference-style links, and inline code delimited by more than one backtick. There is no Vale rule test harness in the repository, so the hit and non-hit probe files used below live outside the tree. ## QA I ran each Vale rule against a probe file with hits and non-hits, with the repository `.vale.ini` and the pinned Vale 3.7.1. - `Coder.HeadingOrder`: reported the raw `<h4>` after an `##` and the `###` that follows a raw `<h1>` after a `###`. It stayed quiet on the two skips `MD001` reports, on `#` lines in front matter, fenced code, and an HTML comment, and on a clean sequence. markdownlint on the same file reported only the two `MD001` lines, so no line got both. - `Coder.EmptyHeading`: reported `##`, `### ###`, `<h2></h2>`, `<h3> </h3>`, and `<h4> <br/> </h4>`. It stayed quiet on text headings, seven `#` marks, an empty `<h2>` in inline code, and lone `#` lines in front matter, fences, and comments. - `Coder.LinkName`: reported all 7 hit cases (empty, whitespace, `![]()` inside a link, raw empty-alt `<img>` inside a link, empty `<a href>`, `<a href>` around an empty-alt image, `<a href>` holding only ` `). It stayed quiet on all 9 non-hit cases, including a bare decorative image, `<a id>` anchors, inline code, comments, and fenced code. Findings on the current corpus (`docs/`, excluding the exempt style guide): `Coder.HeadingOrder` 0, `Coder.EmptyHeading` 0, `Coder.LinkName` 0, `docshtmlcheck` guard 0. The other Vale findings are unchanged from before the PR. No corpus pages changed. ## Testing - `go test ./scripts/docshtmlcheck/ ./scripts/styleclaims/`: 140 passed. The guard tests were written first and failed before `guard.go` existed. They cover each element, each attribute (including case-insensitive names and attributes wrapped across lines), lookalike names such as `data-role`, code and comment exclusion, the reported line and message, and the `run` exit code and footer. - `make lint/docs-html`: clean. - `make lint/style-claims`: clean, so the checks table, the coverage counts, and the annotations agree with `.vale.ini` and the rule files. - `make lint/emdash`: clean. - `pnpm check-docs` (markdownlint and table formatting): 0 errors across 515 files. - Vale 3.7.1 over `docs/` with `--no-exit`, run directly rather than through `make lint/prose` because the worktree's mise config isn't trusted: no findings from the new rules. ## Upstream Not applicable. These checks are specific to the Coder docs corpus and its style guide, so there's nothing to send to Vale, markdownlint, or goldmark. ## Linear https://linear.app/codercom/issue/DOCS-1318 --- 🤖 Built with AI assistance.
79 lines
3.0 KiB
Go
79 lines
3.0 KiB
Go
package main
|
|
|
|
import (
|
|
"fmt"
|
|
"strings"
|
|
|
|
"golang.org/x/net/html"
|
|
)
|
|
|
|
// Elements and attributes that docs pages have no use for. Each one carries
|
|
// accessibility requirements of its own (an accessible name, a valid role, a
|
|
// sensible focus order, a valid language tag) that no docs check verifies, so
|
|
// keeping them out of docs Markdown keeps those requirements out too. Content
|
|
// that seems to need one belongs in Markdown or in the docs site's components.
|
|
const (
|
|
kindDisallowedElement findingKind = "disallowed-element"
|
|
kindDisallowedAttribute findingKind = "disallowed-attribute"
|
|
)
|
|
|
|
// disallowedElements maps each element to why it doesn't belong in a page.
|
|
// The elements stay in allowedElements, so the dedicated message here is what
|
|
// an author sees rather than the generic unknown-element one.
|
|
var disallowedElements = map[string]string{
|
|
"iframe": "embedded frames need a title and are opaque to search; link to the content instead",
|
|
"object": "embedded objects need a text alternative; link to the content or use an image with alt text",
|
|
"area": "image maps need alt text on every area; use an image with alt text and ordinary links",
|
|
"form": "docs pages don't submit forms",
|
|
"input": "form controls need labels and do nothing on a docs page",
|
|
"select": "form controls need labels and do nothing on a docs page",
|
|
"textarea": "form controls need labels and do nothing on a docs page",
|
|
"button": "buttons need an accessible name and do nothing on a docs page; use a link, or bold text for a UI label",
|
|
"meta": "page metadata belongs to the docs site, not to page content",
|
|
}
|
|
|
|
// disallowedAttributes maps each attribute to why it doesn't belong in a page.
|
|
// Any aria-* attribute is also disallowed; see disallowedAttribute.
|
|
var disallowedAttributes = map[string]string{
|
|
"role": "roles override the element's native semantics",
|
|
"tabindex": "tabindex changes the keyboard focus order",
|
|
"lang": "the docs site sets the page language",
|
|
}
|
|
|
|
// disallowedAttribute returns why the attribute is disallowed, or "" when it
|
|
// is allowed. The tokenizer lowercases attribute names.
|
|
func disallowedAttribute(name string) string {
|
|
if strings.HasPrefix(name, "aria-") {
|
|
return "ARIA attributes override what the element and its text already convey"
|
|
}
|
|
return disallowedAttributes[name]
|
|
}
|
|
|
|
// guardTag reports a disallowed element, and each disallowed attribute, on one
|
|
// start tag. name is the lowercased tag name.
|
|
func guardTag(z *html.Tokenizer, name string, line int) []finding {
|
|
var out []finding
|
|
if why, ok := disallowedElements[name]; ok {
|
|
out = append(out, finding{
|
|
line: line,
|
|
kind: kindDisallowedElement,
|
|
tag: name,
|
|
msg: fmt.Sprintf("<%s> is not allowed in docs pages: %s", name, why),
|
|
})
|
|
}
|
|
for {
|
|
key, _, more := z.TagAttr()
|
|
if why := disallowedAttribute(string(key)); why != "" {
|
|
out = append(out, finding{
|
|
line: line,
|
|
kind: kindDisallowedAttribute,
|
|
tag: name,
|
|
msg: fmt.Sprintf("%s on <%s> is not allowed in docs pages: %s", key, name, why),
|
|
})
|
|
}
|
|
if !more {
|
|
return out
|
|
}
|
|
}
|
|
}
|