Package Starter 🚀

Kickstart your next Node.js package with this pre-configured TypeScript template. Get up and running in minutes!

✨ Features

• TypeScript: Enjoy type safety and improved code quality.
• Jest: Write comprehensive tests with ease.
• Biome: Maintain a consistent code style with automated linting and formatting.
• rimraf: Easily clean your build directory.
• release-it: Automatically generate release notes, tag ... and publish your release.
• Built and signed via GitHub Actions: Create a GitHub release and your package will be published automatically.

🚀 Quick Start

You can quickly create a new repository from this template by clicking the Use this template button at the top of the repository page on GitHub.

Alternatively, you can use npx degit to scaffold a new project from this template:

1. Scaffold the project:

   npx degit lehuygiang28/package-starter my-package
   cd my-package

2. Install dependencies:

   npm install

You can also clone the repository manually:

1. Clone the repository:

   git clone https://github.com/lehuygiang28/package-starter.git my-package
   cd my-package

2. Install dependencies:

   npm install

🧰 Scripts

• build: Builds the project
• prepare: Prepares the project for publishing
• test: Runs the tests
• test:cov: Runs the tests with coverage
• lint: Lints the code
• lint:fix: Lints the code and fixes any errors
• format: Formats the code
• format:fix: Formats the code and fixes any errors
• release: Releases the project
• release:pre: Pre-releases the project

🛠️ Development Recommendations

• Install the Biome extension for a seamless development experience.

🙌 Contributing

Contributions are welcome! Please open an issue or submit a pull request if you have any suggestions or improvements.

License

MIT © Lê Huy Giang