Linter: `Data` suffix must be dropped unless model derives from `ResourceData`
- Dominant language
- TypeScript
- Stars
- 27
- Forks
- 90
- Avg merge
- 1d 22h
- Merged PRs (30d)
- 156
Description
Parent: #4442
## Convention
**Remove `Data` suffix** unless the model derives from `ResourceData` or `TrackedResourceData`.
> Source: [Azure SDK for .NET Mgmt Naming Conventions](https://github.com/Azure/azure-sdk-for-net/blob/main/doc/dev/Mgmt-Naming-Conventions.md)
## Observed today
A scan of `Azure/azure-rest-api-specs` (334 `client.tsp` files, 10,754 csharp-scoped `@@clientName` decorators) shows **39** decorators currently encoding this rule by hand. Examples:
- `DeploymentData` → `HciClusterDeploymentInfo` (azurestackhci/resource-manager/Microsoft.AzureStackHCI/StackHCI/client.tsp)
- `CarbonEmissionTopItemMonthlySummaryData` → `CarbonEmissionTopItemMonthlySummary` (carbon/Carbon.Management/client.tsp)
- `CarbonEmissionTopItemsSummaryData` → `CarbonEmissionTopItemsSummary` (carbon/Carbon.Management/client.tsp)
- `CarbonEmissionData` → `CarbonEmission` (carbon/Carbon.Management/client.tsp)
- `CarbonEmissionItemDetailData` → `CarbonEmissionItemDetail` (carbon/Carbon.Management/client.tsp)
- `CarbonEmissionMonthlySummaryData` → `CarbonEmissionMonthlySummary` (carbon/Carbon.Management/client.tsp)
## Proposed linter
**Detection**
Flag any model whose name ends with `Data` that does not extend `Foundations.Resource`/`ResourceData`/`TrackedResourceData`.
**Auto-fix**
Suggest dropping the `Data` suffix via `@@clientName`.
**Scope**
The rule should be csharp-scoped — it only flags violations of the .NET convention, not the underlying TypeSpec name. It should suggest inserting a `@@clientName(..., "csharp")` override when the underlying TypeSpec name is intentional, or renaming the TypeSpec model when the convention applies cross-language.
## Acceptance criteria
- [ ] New lint rule registered in the appropriate ruleset (`@azure-tools/typespec-client-generator-core` or `@azure-tools/typespec-azure-resource-manager`).
- [ ] Doc page under `website/src/content/docs/docs/libraries/.../rules/`.
- [ ] Unit tests covering positive / negative cases and the auto-fix.
- [ ] A `.chronus/changes/` entry.
Contributor guide
Research direction
Start by inspecting existing lint rules and registration in @azure-tools/typespec-client-generator-core and @azure-tools/typespec-azure-resource-manager, then review the rules documentation under website/src/content/docs/docs/libraries/.../rules/. Add positive, negative, and auto-fix unit tests, document the csharp-scoped rule, and include a .chronus/changes/ entry.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- azure, typescript
- Domain
- documentation, tooling
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 50/100