stencil icon indicating copy to clipboard operation
stencil copied to clipboard

feat: Give the ability to stop Stencil from expanding types

Open Jagget opened this issue 1 year ago • 3 comments

Prerequisites

Describe the Feature Request

Give the ability to stop Stencil from expanding types.

For example,

@Prop() chartOptions: ChartOptions<'bar'>;

will be expanded into 3400 symbols long string!!

Describe the Use Case

Some types can be complex or be a combination of other types, and when all this stuff gets expanded, the line can be too long and the resulting readme.md file will look awful.

Describe Preferred Solution

I'd like to have an option to get only type names in Readme. Like ChartOptions<'bar'>. I agree that this type must be described manually elsewhere, but I can handle that. It will require more work for documentation but will make it much more beautiful.

Jagget avatar Aug 13 '24 17:08 Jagget

Thanks for the issue! This issue has been labeled as needs reproduction. This label is added to issues that need a code reproduction.

Please reproduce this issue in an Stencil starter component library and provide a way for us to access it (GitHub repo, StackBlitz, etc). Without a reliable code reproduction, it is unlikely we will be able to resolve the issue, leading to it being closed.

If you have already provided a code snippet and are seeing this message, it is likely that the code snippet was not enough for our team to reproduce the issue.

For a guide on how to create a good reproduction, see our Contributing Guide.

ionitron-bot[bot] avatar Aug 13 '24 19:08 ionitron-bot[bot]

@christian-bromann

https://github.com/Jagget/stencil-issues-5939/tree/master/src/components/demo

Jagget avatar Aug 13 '24 20:08 Jagget

Thanks for providing the example @Jagget - we've ingested this into our backlog what can't give a guarantee that we are able to look into this anytime soon. If this is blocking you we recommend to help the project by providing a fix for this bug. Thanks a lot!

christian-bromann avatar Aug 13 '24 22:08 christian-bromann