build-a-npm
v0.5.15
Published
A tool to create and publish Node packages with automatic version bumping and GitHub integration.
Maintainers
Readme
🛠️ Build a Node.js Package
build-a-npm is a robust and user-friendly CLI tool designed to simplify the creation, management, and publishing of Node.js packages. With an interactive setup, automatic version bumping, and seamless integration with npmjs.com and GitHub Packages, it’s the perfect companion for developers looking to streamline their package development workflow. 🌟
✨ Features
- 🧠 Interactive Setup: Guided prompts for package details, including name, version, author, license, and more.
- 🔢 Automatic Version Bumping: Supports
patch,minor, andmajorversion increments with automatedpackage.jsonupdates. - 🌐 Dual Publishing: Publish to npmjs.com, GitHub Packages, or both with a single command.
- 🤖 GitHub Actions Integration: Generates workflows for automated publishing and documentation deployment.
- 📂 Git Integration: Initializes a git repository and includes scripts for committing and pushing changes.
- 📘 TypeScript Support: Optional TypeScript setup for modern JavaScript development.
- 📁 Comprehensive File Generation: Creates essential files like
package.json,index.js,README.md,.gitignore,.npmignore, and more. - 🔄 Package Upgrades: Updates existing packages to leverage the latest
build-a-npmfeatures without affecting custom code. - 🌍 Cross-Platform: Works seamlessly on Windows, macOS, and Linux.
- 📜 GitHub Pages Support: Generates documentation and publishes it to GitHub Pages.
- 🔧 CI/CD Support: Templates for GitHub Actions, CircleCI, and GitLab CI.
📦 Installation
Please visit the full tutorial for better understanding:
🤝 Contributing
Feel free to open issues or submit PRs:
📩 Contact me
Feel free to contact me related to anything:
📄 License
This project is licensed under the MIT License
Copyright (c) 2025, Harman Singh Hira
