https://github.com/toolshive/create-npm-package
A CLI tool for creating starter templates for npm packages using TypeScript or JavaScript, tailored to simplify package development.
https://github.com/toolshive/create-npm-package
Last synced: about 1 year ago
JSON representation
A CLI tool for creating starter templates for npm packages using TypeScript or JavaScript, tailored to simplify package development.
- Host: GitHub
- URL: https://github.com/toolshive/create-npm-package
- Owner: ToolsHive
- License: mit
- Created: 2024-12-09T09:43:25.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-02-03T19:23:10.000Z (over 1 year ago)
- Last Synced: 2025-02-14T18:49:41.890Z (over 1 year ago)
- Language: JavaScript
- Size: 181 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
Create NPM Package 🚀
[](http://commitizen.github.io/cz-cli/)
[](https://github.com/ToolsHive/Create-NPM-Package/actions/workflows/codeql.yml)
[](https://github.com/ToolsHive/Create-NPM-Package/actions/workflows/dependabot/dependabot-updates)
[](https://github.com/ToolsHive/Create-NPM-Package/blob/main/LICENSE)
A CLI tool for creating starter templates for npm packages using TypeScript or JavaScript, tailored to simplify package development.
## 📚 Table of Contents
- [📚 Table of Contents](#-table-of-contents)
- [✨ Features](#-features)
- [💻 System Requirements](#-system-requirements)
- [📥 Installation](#-installation)
- [🛠️ Usage](#️-usage)
- [❓ FAQ](#-faq)
- [🐞 Troubleshooting](#-troubleshooting)
- [🤝 Contributing](#-contributing)
- [📜 License](#-license)
## ✨ Features
- 🔥 Quickly scaffold a new npm package project.
- 🎯 Select between TypeScript or JavaScript for your starter template.
- 🛠️ Generates a pre-configured `package.json` with the selected template.
- 🧹 Sets up essential files for a clean and maintainable project structure.
- ✅ Includes basic configurations for linting and formatting.
- 🎉 Easy-to-use CLI for seamless setup and initialization.
- 📦 No need to install globally, just use with `npx`.
## 💻 System Requirements
- **Node.js**: >= 18.20.1
- **npm**: >= 9.2.0
> ⚠️ Ensure these are installed on your system before using this tool.
## 📥 Installation
You can install this package globally using npm to use the CLI tool directly in your terminal:
```bash
npm install -g @ToolsHive/Create-NPM-Package
```
## 🛠️ Usage
To create a new npm package starter template, run the following command:
```bash
npx @ToolsHive/Create-NPM-Package
```
## ❓ FAQ
**Q: Do I need to install this package globally?**
A: No, you can use it directly with `npx`, so there’s no need for a global installation.
**Q: Does this tool support both JavaScript and TypeScript?**
A: Yes, during setup, you can choose between TypeScript or JavaScript for your project.
## 🐞 Troubleshooting
- **🚫 Error: "Command not found"**
Ensure you have Node.js and npm installed. Run `node -v` and `npm -v` to check.
- **🔒 Permissions Error on Installation**
Use `sudo` for global installations:
```bash
sudo npm install -g @ToolsHive/Create-NPM-Package
```
- **💻 Installation Issues on Windows**
Use PowerShell or Command Prompt with administrative rights.
## 🤝 Contributing
Contributions are welcome! Please open an issue or submit a pull request for any improvements or features.
## 📜 License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.