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

[eslint-plugin] should ts-name-options rule allows OperationOptions? #31290

Open
jeremymeng opened this issue Oct 2, 2024 · 1 comment
Open
Assignees
Labels
Azure.Core Client This issue points to a problem in the data-plane of the library. eslint plugin

Comments

@jeremymeng
Copy link
Member

Current API design guidelines require that method options bag type name should be <MethodName>Options

https://azure.github.io/azure-sdk/typescript_design.html#ts-options

However, in many cases, those methods only need a OperationOptions without any further customizations. Should we allow this special case?

@jeremymeng jeremymeng added Client This issue points to a problem in the data-plane of the library. Azure.Core labels Oct 2, 2024
@jeremymeng jeremymeng self-assigned this Oct 2, 2024
@xirzec
Copy link
Member

xirzec commented Oct 2, 2024

Allowing OperationOptions directly feels like a reasonable exception here; we're not minting a new type with a bad name (which is what the rule exists to prevent) and it won't hurt anything if consumers continue to use that type after we implement operation-specific options that extend OperationOptions

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Azure.Core Client This issue points to a problem in the data-plane of the library. eslint plugin
Projects
None yet
Development

No branches or pull requests

2 participants