Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/moontai0724/package-template
Boilerplate to kickstart creating an typescript written npm package.
https://github.com/moontai0724/package-template
boilerplate codecov eslint out-of-the-box prettier rollup semantic-commits semantic-release starter-template typescript vitest
Last synced: 22 days ago
JSON representation
Boilerplate to kickstart creating an typescript written npm package.
- Host: GitHub
- URL: https://github.com/moontai0724/package-template
- Owner: moontai0724
- Created: 2024-04-08T03:05:23.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-04-10T03:19:20.000Z (7 months ago)
- Last Synced: 2024-04-10T05:03:51.655Z (7 months ago)
- Topics: boilerplate, codecov, eslint, out-of-the-box, prettier, rollup, semantic-commits, semantic-release, starter-template, typescript, vitest
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/@moontai0724/package-template
- Size: 80.1 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# @moontai0724/package-template
[](https://www.npmjs.com/package/@moontai0724/package-template)
[](https://www.npmjs.com/package/@moontai0724/package-template)
[](https://codecov.io/gh/moontai0724/package-template)
## Features
- [x] TypeScript
- [x] [Vitest](https://github.com/vitest-dev/vitest): Tests and [Coverage](https://github.com/vitest-dev/vitest/tree/main/packages/coverage-v8)
- [x] [ESLint](https://eslint.org) + [Prettier](https://prettier.io): Coding Style & Formatter
- [Husky](https://github.com/typicode/husky) + [Lint-staged](https://github.com/okonet/lint-staged): Pre-commit hooks
- ~~[Airbnb Coding Style](https://github.com/airbnb/javascript)~~
- Auto [organize imports](https://github.com/un-js/eslint-plugin-import-x).
- Auto sort [imports](https://github.com/lydell/eslint-plugin-simple-import-sort).
- [x] [Commitlint](https://github.com/conventional-changelog/commitlint): Commit message linting to follow [Conventional Commits](https://www.conventionalcommits.org)
- [x] Auto versioning, Changelog and Release to GitHub release and NPM by using [commit-and-tag-version](https://github.com/absolute-version/commit-and-tag-version)
- Version is bumped by parsing conventional commit messages
- Changelog is generated based on the commit messages
- [x] Show code coverage by uploading to [CodeCov](https://codecov.io) when running deployment workflow
- [x] [Typedoc](https://github.com/TypeStrong/typedoc): API documentation
## Getting Started
### 1. Use this template to create a new repository.
Click the [`Use this template`](https://github.com/new?template_name=package-template&template_owner=moontai0724) button on the top right corner of the repository page.
### 2. Clone the repository, and install the dependencies.
Just clone your repo and install the dependencies with any package manager you like. This template does not strong bind to any package manager, but the used package manager in GitHub Actions workflow is `pnpm`. You may need to modify the workflow file if you use other package managers.
### 3. Modify the package content to fit your project.
There are few places you need to modify to fit your project, like `package.json`, `README.md`. You can use the following command to replace most of the content:
```bash
YOUR_GITHUB_USER="your-user-name"
YOUR_REPO_NAME="your-awesome-package-name"
sed -i "s/moontai0724/${YOUR_GITHUB_USER}/g" package.json README.md .github/workflows/*
sed -i "s/package-template/${YOUR_REPO_NAME}/g" package.json README.md .github/workflows/*
```
### 4. Start coding!
## Publish
This template uses [CodeCov](https://docs.codecov.com/docs/quick-start) to check the code coverage. You can remove the CodeCov badge and the related scripts in `package.json` if you don't need it.
If you want to use CodeCov, you need to set the `CODECOV_TOKEN` in the [repository secrets](https://github.com/moontai0724/package-template/settings/secrets/actions).
Once you done, you can push your codes to the `main` branch.
The actions in this template will auto perform following steps when you push the code to the `main` branch:
- Test: Run tests and generate coverage report
- Build: Generate bundled and minified esm, cjs version (for browser), and unminified esm version (for node).
- Release: Bump Version & Generate Changelog
- [Publish the package to npm](https://www.npmjs.com/package/@moontai0724/package-template/)
- [Publish docs to GitHub Pages](https://moontai0724.github.io/package-template/): You may need to setup the GitHub Pages in the repository settings.
You can modify the workflow file to fit your needs.
## Install
### NPM
```bash
npm install @moontai0724/package-template
```
### Yarn
```bash
yarn add @moontai0724/package-template
```
### PNPM
```bash
pnpm add @moontai0724/package-template
```
## Usage
```typescript
import { add, divide, max } from "@moontai0724/package-template";
add(1, 2); // 3
divide(1, 2); // 0.5
max(1, 2); // 2
```
## API Document
See the [API documentation](https://moontai0724.github.io/package-template/).