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

feat: Give the ability to stop Stencil from expanding types #5939

Open
3 tasks done
Jagget opened this issue Aug 13, 2024 · 3 comments
Open
3 tasks done

feat: Give the ability to stop Stencil from expanding types #5939

Jagget opened this issue Aug 13, 2024 · 3 comments
Labels
Bug: Validated This PR or Issue is verified to be a bug within Stencil

Comments

@Jagget
Copy link
Contributor

Jagget commented Aug 13, 2024

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.

@ionitron-bot ionitron-bot bot added the triage label Aug 13, 2024
@Jagget Jagget changed the title feat: feat: Give the ability to stop Stencil from expanding types Aug 13, 2024
@christian-bromann christian-bromann added the ionitron: needs reproduction This PR or Issue does not have a reproduction case URL label Aug 13, 2024
Copy link

ionitron-bot bot commented Aug 13, 2024

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.

@Jagget
Copy link
Contributor Author

Jagget commented Aug 13, 2024

@christian-bromann christian-bromann added Bug: Validated This PR or Issue is verified to be a bug within Stencil and removed ionitron: needs reproduction This PR or Issue does not have a reproduction case URL labels Aug 13, 2024
@christian-bromann
Copy link
Member

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!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Bug: Validated This PR or Issue is verified to be a bug within Stencil
Projects
None yet
Development

No branches or pull requests

2 participants