Inline Disable Comments for Go Markdown Linter

说明与用途

gomarklint 的内联禁用注释功能允许开发者仅在特定行或块上抑制 lint 警告，减少噪音并提升可读性。实现采用简单的数据模型和高效过滤，并通过测试验证正确性。

问题

Users of gomarklint needed a way to suppress lint violations on specific lines or blocks, similar to ESLint’s inline disable comments, to handle legitimate exceptions such as URLs in changelogs or generated code blocks.

结果

The feature reduces lint noise, improves developer experience, and keeps the linter fast by parsing directives only when needed. Tests confirm correct parsing, priority handling, and that invalid rule names are ignored.

工作流

• 1. Define four directive types: disable/enable, disable‑line/enable‑line, disable‑next‑line/enable‑next‑line.
• 2. Create data models: lineDisable, disabledSet, blockState to represent per‑line and block‑level disable states.
• 3. Implement parseDirectiveLine to extract directives from HTML comments.
• 4. Build parseDisableComments to scan lines, maintain blockState, and populate disabledSet.
• 5. Apply priority rules: all‑disabled beats named‑disable; line‑specific directives beat block‑level.
• 6. In the linter, detect presence of "gomarklint-disable" to skip parsing for files without directives.
• 7. Filter collected lint errors by checking disabled.isDisabled(e.Line, e.Rule).
• 8. Add unit, integration, and E2E tests to cover parsing, priority, and frontmatter offset handling.
• 9. Document silent failure for invalid rule names to match markdownlint behavior.

证据

"We need a way to suppress violations inline, scoped to exactly the lines that need it — just like markdownlint does with HTML comments:"

来源

"The core challenge is representing "which rules are disabled on line N" efficiently."

来源

"We only call parseDisableComments if the file body actually contains the string \"gomarklint-disable\"."

来源

"If the name doesn't match any known rule, the function returns false and the violation passes through."

来源