Let's create a package!

An overview (that escalates quickly) on creating and maintain a node package

Transcript

1. Let’s create a package!
2. This is a work of fiction. Any similarity to actual persons, living or dead, or actual events, is purely coincidental. Disclaimer
3. How it starts
4. Ok! I think we should create a package!
5. Create repository
6. Write the code
7. Add package details
8. Create changelog
9. Commit and publish
10. Create tag
11. Add package to project
12. The end
13. Oh, you wish darling
14. Let’s create a package! - and maintain it -
15. True! Hey, we need Typescript!
16. Add type safety
17. Update package details
18. Update changelog
19. Commit and publish
20. Create new tag
21. Update package in project
22. My job here is done
23. All right! What about CommonJS?
24. Main differences
25. Add CommonJS support
26. Update package details
27. Rinse and repeat • Update changelog • Commit and publish • Create tag • Update package in projects • So on and so forth…
28. Simple, right?
29. Okay! I need now to change the page title
30. Update code
31. Multiple entries
32. Rinse and repeat • Update changelog • Commit and publish • Create tag • Update package in projects • So on and so forth…
33. Exports options
34. But wait, there’s more!
35. Handling special files • .vue – Compile Vue files into JS • .css – Transpile if using .scss, .less, etc and publish raw CSS files • .jsx • SolidJS – Transpile and publish raw JSX files • React – Compile into JS • Other assets – publish them raw * Check your favorite framework guides
36. Build tools • Rollup • Webpack • Parcel • esbuild • Turbopack • SWC • Vite • tsup • Unbuild • Tsdx • Microbundle
37. It’s a lot!
38. How can we simplify things?
39. Getting help from robots
40. Publishing packages Monorepo options: • changeset • multi-semantic-release Automate: defining next version number, generating the release notes, creating tags and publishing the package. Single package: • semantic-release • gitversion • release-it
41. Publishing packages
42. Monorepos Pros • Tear down barriers • Code sharing • Dependency management • Release management • Refactoring Cons • Initial setup • Build pipelines • Access Control
43. Publishing packages
44. Updating packages
45. Templates
46. Yes! More!
47. publint.dev
48. Do we need it? What about CommonJS?
49. Differences
50. ECMAScript + CommonJS
51. Simplify build steps
52. Let’s keep it simple Hey, we need Typescript!
53. Add types with JSDoc
54. Export .ts raw
56. Are we sure? I think we should create a package!
57. The end - now for real -
58. Recommended reading
59. Questions? ?
60. Inspirations for this talk Packaging libraries talk by Bjorn Lu Ship ESM & CJS in one Package by Antfu Maintaining packages at funda
61. Thanks! https://github.com/dine https://mastodon.social/@dine @dine.bsky.social