Document linter rule ID naming conventions in linter authoring docs - #10856
Merged
timotheeguerin merged 3 commits intoJun 1, 2026
Conversation
3 tasks
Co-authored-by: timotheeguerin <1031227+timotheeguerin@users.noreply.github.com>
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
Member
|
@copilot use |
Co-authored-by: timotheeguerin <1031227+timotheeguerin@users.noreply.github.com>
Contributor
Author
timotheeguerin
marked this pull request as ready for review
June 1, 2026 20:07
timotheeguerin
requested review from
bterlson,
catalinaperalta,
iscai-msft,
markcowl and
witemple-msft
as code owners
June 1, 2026 20:07
|
You can try these changes here
|
timotheeguerin
enabled auto-merge
June 1, 2026 20:33
catalinaperalta
approved these changes
Jun 1, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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 tocreateRule({ name })so authors can choose consistent, user-readable rule names.Added rule naming guidance in linter authoring docs
website/src/content/docs/docs/extending-typespec/linters.mdwith a new “Naming convention” section.kebab-casenamesnameno-<thing>for prohibitionsuse-<preferred-thing>for preferred patterns<subject>-missing-<thing>,<subject>-invalid-<condition>)Clarified user-facing context for rule IDs
tspconfig.yaml, docs URLs, and suppression comments, guiding authors toward concise readable IDs.