Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/templates-collective/starter-lib-ts
TypeScript library starter template, supports ESM and CJS. / TypeScript 库初始化模板，支持 ESM 和 CJS。
https://github.com/templates-collective/starter-lib-ts
cjs commonjs eslint esm esmodule library npm pnpm starter template tsup typescript vitest
Last synced: about 1 month ago
JSON representation
TypeScript library starter template, supports ESM and CJS. / TypeScript 库初始化模板，支持 ESM 和 CJS。
- Host: GitHub
- URL: https://github.com/templates-collective/starter-lib-ts
- Owner: templates-collective
- License: mit
- Created: 2024-08-28T05:41:22.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-09-12T09:00:35.000Z (2 months ago)
- Last Synced: 2024-09-30T16:41:03.250Z (about 1 month ago)
- Topics: cjs, commonjs, eslint, esm, esmodule, library, npm, pnpm, starter, template, tsup, typescript, vitest
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/starter-lib-ts
- Size: 157 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# TypeScript Library Starter Template
[](https://www.npmjs.com/package/starter-lib-ts)
TypeScript library starter template, supports ESM and CJS.
- [Play on Stackblitz](https://stackblitz.com/github/templates-collective/starter-lib-ts)
- [README for 简体中文](./README.zh-CN.md)
## Features
- Build package with [tsup](https://tsup.egoist.dev/) - Bundle your TypeScript library with no config.
- Unit Testing with [Vitest](https://github.com/vitest-dev/vitest).
- Publish to [npm](https://www.npmjs.com) with zero-config.
## Usage
[Create a repo](https://github.com/templates-collective/starter-lib-ts/generate) from this template on GitHub.
```bash
git clone
```
Install npm dependencies.
```bash
cd starter-lib-ts # Or your project directory
pnpm i # If you don't have pnpm installed, run: npm install -g pnpm
```
Just run `dev` script to build your files.
```bash
pnpm dev
```
To build the library, you can run:
```bash
pnpm build
```
If you want to publish it, you can run:
```bash
pnpm release
```
## Clean Template
If you prefer to do it manually with the cleaner git history:
```bash
npx degit templates-collective/starter-lib-ts starter-lib-ts
cd starter-lib-ts
pnpm i # If you don't have pnpm installed, run: npm install -g pnpm
```
When you use this template, try follow the checklist to update your info properly:
- [ ] Change the author name in `LICENSE`.
- [ ] Change the package name in `package.json`.
## License
[MIT License](./LICENSE) © 2024 [Kieran Wang](https://github.com/kieranwv/)