-
Notifications
You must be signed in to change notification settings - Fork 4.8k
Add bundling with rollup to docs #683
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
Add bundling with rollup to docs #683
Conversation
@NataliaTepluhina This is a first draft, I believe is quite rough and it needs some iteration to be presentable 😅 I was thinking that a boilerplate repository is probably a good addition ( as suggested by @JessicaSachs ) where such a repo should 'live' ? Shall I create it under my personal repositories or there is a better place for such things? In the end I went quite minimal with the approach and discarded the composition api point completely since I think it is a bit out of the scope. |
@znck Currently on my side I still have some quirks with the render functions, I was thinking to add this to a possible tips and trick section, but then I realised that RPV is still in beta ( I am still using the alpha ) so it probably does not make much sense to add things that are planned to be fixed ( or already fixed and not released ) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is a good start 🤩
Maybe we can add notes about typescript and vetur support too.
@znck Thanks! I've applied all the suggestions 😄 about Typescript, it falls out of my experience (I know I have to catch up with Typescript 😅 ) And I've never configured Vetur for vue3. Do you think this is super important to have at the first version of this part of the docs or we can add those in a further iteration? @NataliaTepluhina Is there anything else that need to change in. your opinion? WDYT? 🙇 🙇 |
Typescript stuff can be done in a separate PR. 👍 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't really know anything about Rollup but I've had a read through and made a few notes on anything that caught my eye. All minor stuff.
I see some similarities with #664, where @sdras is migrating some Rollup-related content in the Cookbook. I don't know enough about the topic myself to give an opinion but I wonder whether the two need to be considered together?
@@skirtles-code Thank you so much for the review! And apologies for the slow turn-around, I manage to scavenge time for OSS only during the weekend 🙇 I think I've addressed all the points! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A couple more thoughts from me.
I don't have the required permissions to mark my previous comments as resolved but if someone else wants to do that then feel free.
Co-authored-by: skirtle <[email protected]>
@DonNicoJs @skirtles-code thank you both so much for authoring the addition and for the thorough review! I believe right now there are no major blockers for merging this one and we can handle additions like TS in the follow-ups |
@NataliaTepluhina Thank you very much! 🙇 🙇 |
* docs: add rollup to single-file-component.md * docs: integrate reviewer feedback * docs: styling and fixes * docs: reword introduction paragraph Co-authored-by: skirtle <[email protected]> * docs: update to only use `we/our` Co-authored-by: skirtle <[email protected]>
This PR adds a new block to the
single-file-component.md
file with a guide on how to bundlesfc
with rollup.The guide is oriented to library authors.
This is the first draft, also I am not completely sure it's the right place to add this, or if is better somewhere else / standalone entry
fixes #660