Search code examples
stenciljs

StencilJS: Disable auto generation of readme files for some components

StencilJS auto generation is great: https://stenciljs.com/docs/docs-readme Is there any way I can disable it for certain components?

Hopefully something simple like adding a line to the top of the tsx file?

Solution

  • If this feature existed I suspect that it would probably be based on a JSDoc comment, likely @ignore.

    I just tested this by adding those comments and they seem to be ignored since the readme builds anyway.

    I suggest opening an feature request issue in the ionic-team/stencil repository. An important detail would be if those components should also be hidden from the Dependencies section of other (non-ignored) components.

    You could also try implementing it yourself, I think filtering the components here should work.

    Update

    There is an undocumented feature to achieve this by adding @internal to the JSDoc.

    I just successfully tested it for components as well as only for specific properties in Stencil 1.12.5 but from looking at the git history it seems this has been available for a while (a couple of years at least).

    Examples:

    Ignore component:

    /** @internal **/
@Component({...})
export class MyComponent {...}

    Single property

    @Component({...})
export class MyComponent {
  @Prop() visibleProp = '';

  /** @internal **/
  @Prop() hiddenProp = '';
}