https://github.com/idimetrix/typescript-template
NPM package template with TypeScript, Tests (unit + integration) and NPM/YARN/PNPM
https://github.com/idimetrix/typescript-template
jest template test typescript
Last synced: 10 days ago
JSON representation
NPM package template with TypeScript, Tests (unit + integration) and NPM/YARN/PNPM
- Host: GitHub
- URL: https://github.com/idimetrix/typescript-template
- Owner: idimetrix
- License: other
- Created: 2024-09-16T19:56:36.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-09-22T19:29:57.000Z (8 months ago)
- Last Synced: 2025-04-19T12:05:07.356Z (about 1 month ago)
- Topics: jest, template, test, typescript
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/typescript-test-template
- Size: 71.3 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# typescript-template
This is a template package to publish NPM package with TypeScript, Tests (unit + integration) and NPM/YARN/PNPM
## tsup
Bundle your TypeScript library with no config, powered by esbuild.
https://tsup.egoist.dev/
## How to use this
1. install dependencies
```
# pnpm
$ pnpm install
# yarn
$ yarn install
# npm
$ npm install
```
2. Add your code to `src`
3. Add export statement to `src/index.ts`
4. Test build command to build `src`.
Once the command works properly, you will see `dist` folder.
```zsh
# pnpm
$ pnpm run build
# yarn
$ yarn run build
# npm
$ npm run build
```
5. Publish your package
```zsh
$ npm publish
```
## test package
https://www.npmjs.com/package/typescript-test-template