feat: Enforce @slot JSDoc

tfrijsewijk commented 1 year ago

Prerequisites

[X] I have read the Contributing Guidelines.
[X] I agree to follow the Code of Conduct.
[X] I have searched for existing issues that already include this feature request, without success.

Describe the Feature Request

Forces the developer to document every <slot> in the render() function.

Describe the Use Case

A slot is part of the public API of the component. Just as Prop() and Event() are enforced, slots are of equal importance.

Describe Preferred Solution

No response

Describe Alternatives

No response

Related Code

No response

Additional Information

No response

jcfranco commented 8 months ago

@raphaelpor I’m interested in taking this one on. Could you point me in the right direction or suggest some resources to get started? Thanks!

jcfranco commented 8 months ago

@raphaelpor Took a stab at this (see #105). The missing part is handling slots and names coming from external modules (e.g., helpers). Not sure if that's feasible or not.

stencil-community / stencil-eslint