[Feature]: create `eslint` rule to enforce style hook API consistency

[spmonahan]

Library

React Components / v9 (@fluentui/react-components)

Describe the feature that you would like added

Add a new lint rule to enforce the style hook API contract of:

useComponentStyle(state: ComponentState) => ComponentState

That is, that all style hooks take in ComponentState and also return ComponentState.

Have you discussed this feature with our team

@Hotell

Additional context

This is a follow up to #30349

Validations

• Check that there isn't already an issue that request the same feature to avoid creating a duplicate.

Priority

Normal

[Hotell]

On further inspection IMO the best approach here would be to enable existing generic rule and enforce these patterns to all public APIs https://typescript-eslint.io/rules/explicit-module-boundary-types.

Having this in place would also make it very easy for us to enable further TS type generations perf improvements microsoft/TypeScript#47947 (comment)

Thoughts ?

[spmonahan]

On further inspection IMO the best approach here would be to enable existing generic rule and enforce these patterns to all public APIs https://typescript-eslint.io/rules/explicit-module-boundary-types.

Looks like this lint rule would still allow useComponentStyles(state: ComponentState) => void so long as it is explicitly typed?

Agree that using an off-the-shelf lint rule is preferrable and that we should enforce this rule for our public APIs generally. Perf wins are nice too 🙂