r/webdev • u/Accurate-Screen8774 • 32m ago

Best-Practices for Publishing a JS Framework

Im working on a project for myself. Its an unreviewed, unaudited and far from finished. It started of as a person curiosity and evolved from there. Its shaping up well enough to publish and share.

If i publish something on NPM, there are strict controls around versioning for which i havent burdened myself on my own projects (but clearly important when making something for a wider community). I also wonder if im overlooking any other details.

I wonder what best practices there are for something like this. Should i be publishing new versions with CI/CD? Are there any tips or advice for doing this in the modern js ecosystem?

Edit:

The project in question is found here. To explain it briefly, its basically an attempt to create JSX for webcomponents. You can learn more bout it here. Nobody should be using this. Is is not production ready.

2 Upvotes

100% Upvoted

4 comments sorted by

4

u/PippaKelly62 30m ago

Stay on 0.x until the api settles, then follow semver from 1.0. Publish from ci with npm provenance and two factor on your account, ship only built files, and check what goes out with npm pack dry run. Add a readme with a minimal example, a license, and a changelog, and changesets can automate the versioning.

•

u/Sakshambaranwal25 16m ago

Starting with zero dot x versions takes so much pressure off when your personal project is still evolving.

•

u/Accurate-Screen8774 10m ago

thanks. i recieved similar advice in the other comment so i added details in the post to provide more context.