Parcel: Plugin documentation

Created on 12 Mar 2020  ·  4Comments  ·  Source: parcel-bundler/parcel

🐛 bug report

At the time of writing, the README of Parcel 2 contains a list of official plugins and a description of the plugin API.

However, I find the current contents insufficient. The plugins could use some description — both in the README as well as on npm.

More importantly, the documentation for _authoring_ plugins is insufficent in that none of the data structures are document. What is a asset? What is in a graph?

The plugin architecture seems at least as powerful as Rollup’s plugin architecture, so I’d absolutely love to see a similarly detailed documentation (and Rollup’s documentation has a lot of room for improvement, too!)

Feature ✨ Parcel 2

Most helpful comment

We're gonna get started on a docs site really soon, with a detailed description of every public part of parcel and how it works.

All 4 comments

We're gonna get started on a docs site really soon, with a detailed description of every public part of parcel and how it works.

We are aware of the general lack of documentation and hope to get something out in the near future.

@surma We now link to the docs site for v2 in the README: https://v2.parceljs.org/ thanks to awesome work from @mischnic and @DeMoorJasper.

As noted in the README, it's not exhaustive, and we definitely welcome feedback on where it can be improved 😄

Would it be worthwhile to close this out and open issues about specific areas of improvement going forward?

Going to close this out in favor of more granular feedback now that this is generally addressed at https://v2.parceljs.org/.

Thanks for all of your awesome feedback @surma and looking forward to more. Feel free to re-open of course.

Was this page helpful?
0 / 5 - 0 ratings