Skip to content

Document linter rule ID naming conventions in linter authoring docs - #10856

Merged
timotheeguerin merged 3 commits into
mainfrom
copilot/document-naming-conventions-linter-ids
Jun 1, 2026
Merged

Document linter rule ID naming conventions in linter authoring docs#10856
timotheeguerin merged 3 commits into
mainfrom
copilot/document-naming-conventions-linter-ids

Conversation

Copilot AI commented Jun 1, 2026

Copy link
Copy Markdown
Contributor

TypeSpec linter docs explain how to define rules but did not provide guidance for naming rule IDs beyond examples, which made non-no-* rules less predictable. This PR adds concise naming conventions next to createRule({ name }) so authors can choose consistent, user-readable rule names.

  • Added rule naming guidance in linter authoring docs

    • Updated website/src/content/docs/docs/extending-typespec/linters.md with a new “Naming convention” section.
    • Documented:
      • short kebab-case names
      • excluding package/library prefix from name
      • no-<thing> for prohibitions
      • use-<preferred-thing> for preferred patterns
      • subject-oriented forms for domain checks (e.g. <subject>-missing-<thing>, <subject>-invalid-<condition>)
  • Clarified user-facing context for rule IDs

    • Explicitly notes rule names are surfaced in diagnostics, tspconfig.yaml, docs URLs, and suppression comments, guiding authors toward concise readable IDs.
export const rule = createRule({
  name: "use-standard-resource-model",
  // ...
});

Co-authored-by: timotheeguerin <1031227+timotheeguerin@users.noreply.github.com>
@microsoft-github-policy-service microsoft-github-policy-service Bot added the meta:website TypeSpec.io updates label Jun 1, 2026
Copilot AI changed the title [WIP] Document naming conventions for TypeSpec linter rule IDs Document linter rule ID naming conventions in linter authoring docs Jun 1, 2026
Copilot AI requested a review from timotheeguerin June 1, 2026 19:02
@timotheeguerin

Copy link
Copy Markdown
Member

@copilot use Naming convention as the heading

Co-authored-by: timotheeguerin <1031227+timotheeguerin@users.noreply.github.com>

Copilot AI commented Jun 1, 2026

Copy link
Copy Markdown
Contributor Author

@copilot use Naming convention as the heading

Updated in commit 8552679.

@azure-sdk-automation

Copy link
Copy Markdown

You can try these changes here

🛝 Playground 🌐 Website 🛝 VSCode Extension

@timotheeguerin
timotheeguerin enabled auto-merge June 1, 2026 20:33
@timotheeguerin
timotheeguerin added this pull request to the merge queue Jun 1, 2026
Merged via the queue into main with commit a54846f Jun 1, 2026
29 checks passed
@timotheeguerin
timotheeguerin deleted the copilot/document-naming-conventions-linter-ids branch June 1, 2026 23:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

meta:website TypeSpec.io updates

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document naming conventions for TypeSpec linter rule IDs

3 participants