https://github.com/ulivz/ts-lib-template
A hassle-free TS library template
https://github.com/ulivz/ts-lib-template
Last synced: 6 months ago
JSON representation
A hassle-free TS library template
- Host: GitHub
- URL: https://github.com/ulivz/ts-lib-template
- Owner: ulivz
- License: mit
- Created: 2022-08-18T18:53:38.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-09-11T05:30:46.000Z (about 2 years ago)
- Last Synced: 2025-03-28T18:51:50.625Z (7 months ago)
- Language: JavaScript
- Homepage:
- Size: 288 KB
- Stars: 7
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
ts-lib-template
A hassle-free TS library template.
## Quick Start
1. Click "Use this template" at this repository.
2. Rename all `ts-lib-template` to your package name.
3. Commands:
```bash
npm run bootstrap # install dependencies
npm run clean # clean dependencies
npm run dev # development both cjs and esm output
npm run build # build both cjs and esm
npm run lint # lint code
npm run lint:fix # fix all code lint errors
npm run test # run all tests
npm run cov # run all tests and generate coverage report
npm run release # release this package
```
## Features
- TypeScript by default.
- Output both `cjs` and `esm`.
- Unit test with [jest](https://facebook.github.io/jest/).
- Format code with [eslint](https://eslint.org/docs).
- Fix and format code on each commit.
- Leverage [quick-publish](https://github.com/ulivz/quick-publish) for release flow.
## License
MIT © [ULIVZ](https://github.com/ulivz)