Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Azure Core linter rules docs and cleanup - Pass 2 #1545

Open
wants to merge 16 commits into
base: main
Choose a base branch
from

Conversation

timotheeguerin
Copy link
Member

@timotheeguerin timotheeguerin commented Sep 16, 2024

Add documentation for the following rules and cleanup(remove the Azure. service name filter and some other legacy filter from before using the linting engine)

  • casing-style
  • missing-operation
  • require-auth: Flag missing @useAuth
  • operation-names: This one flagged a lot of our samples that used createOrUpdate as the name of the ResourceCreateOrReplace operation

@azure-sdk
Copy link
Collaborator

azure-sdk commented Sep 16, 2024

All changed packages have been documented.

  • @azure-tools/typespec-azure-core
  • @azure-tools/typespec-azure-rulesets
Show changes

@azure-tools/typespec-azure-core - fix ✏️

Add docs for linting rules and stop excluding non Azure. namespace

@azure-tools/typespec-azure-rulesets - fix ✏️

Disable @azure-tools/typespec-azure-core/standard-names for resource-manager ruleset. Rule was already excluding ARM operations automatically this just configure the ruleset correctly

@timotheeguerin timotheeguerin marked this pull request as ready for review September 16, 2024 21:04
@azure-sdk
Copy link
Collaborator

You can try these changes here

🛝 Playground 🌐 Website 📚 Next docs

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants