Add an updated 'Packaging Vue Components for npm' cookbook entry
Nobody has claimed this yet.
- Dominant language
- Vue
- Stars
- 3.2k
- Forks
- 5k
- Avg merge
- 14d 17h
- Merged PRs (30d)
- 1
Description
In v2 Docs, there was a very nice Cookbook recipe about how to publish a Vue component to NPM. It is based on Rollup and is really outdated; at the time of its writing, Vue CLI 3 was in beta.
There was an attempt at this in #664, yet it's almost been 2.5 years since then, and there wasn't an issue asking for this, so I imagine this was eventually forgotten.
Things that I would change/mention:
- usage of a Vite-based config instead of Rollup/Vue CLI
- remove auto-install instructions since there's no global
Vueobject any more - perhaps stop offering Babel/Buble transpilation? I think Vite/esbuild can handle it at this point
vue-sfc-rollup (mentioned in the v2 Cookbook) did provide a good template for a shareable SFC, but it doesn't use Vite and has been deprecated since then.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the v2 Cookbook recipe for publishing Vue components and review the prior attempt in #664. Compare its Rollup/Vue CLI guidance with the Vite-based approach requested here, including the removal of global Vue auto-install instructions and outdated transpilation advice. Done means a current cookbook entry that explains the supported packaging workflow.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, rollup, vite
- Domain
- build-system, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100