https://github.com/productdevbookcom/ts-bundle-template

Smart TypeScript speed bundle template
https://github.com/productdevbookcom/ts-bundle-template

bundle eslint template tsup typescript

Last synced: 3 months ago
JSON representation

Smart TypeScript speed bundle template

• Host: GitHub
• URL: https://github.com/productdevbookcom/ts-bundle-template
• Owner: productdevbookcom
• License: mit
• Created: 2023-03-05T16:14:11.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-01-30T04:31:12.000Z (9 months ago)
• Last Synced: 2024-07-02T04:23:43.823Z (4 months ago)
• Topics: bundle, eslint, template, tsup, typescript
• Language: TypeScript
• Homepage: https://productdevbook.com
• Size: 318 KB
• Stars: 8
• Watchers: 1
• Forks: 2
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Typescript Bundle Template

![Typescript Bundle Template](https://github.com/productdevbookcom/assets/blob/main/ts-bundle-template.jpg?raw=true)

This is a template for creating a Typescript bundle. It is based on the [Typescript](https://www.typescriptlang.org/) compiler with the [Tsup](https://github.com/egoist/tsup) bundler.

## Features

- [x] [Typescript](https://www.typescriptlang.org/)

- [x] [Tsup](https://github.com/egoist/tsup)

- [x] [ESLint](https://eslint.org/) with [Antfu's ESLint Config](https://github.com/antfu/eslint-config)

- [x] [Bumpp](https://github.com/antfu/bumpp) github changelog generator

- [x] [Vitest](https://vitest.dev/)

- [x] [Pnpm](https://pnpm.io/)

- [x] [GitHub Actions]()

- [x] [NPM Local Registry]()

- [x] [Renovate]()

## Usage

1. To use this template, click the "Use this template" button above.

2. Clone the repository to your local machine.

3. Run `pnpm install` to install the dependencies.

4. Run `pnpm build` to build the bundle.

5. Run `pnpm start` to start the bundle.

6. Run `pnpm lint` to lint the code. (You can also run `pnpm lint:fix` to fix the linting errors.)

7. Run `pnpm test` to run the tests. (You can also run `pnpm test:watch` to run the tests in watch mode.)

8. Run `pnpm release` to bump the version. Terminal will ask you to select the version type. And then it will automatically commit and push the changes. GitHub Actions will automatically publish git tags. NPM local registry will automatically publish the package.

## Configuration

### Renovate

[Setup Github App](https://github.com/apps/renovate) for Renovate.

### TS Config Base

(tsconfig.json)[https://github.com/tsconfig/bases/tree/main/bases] is used as the base config for the Typescript compiler.

## Sponsors



  

    

  



## License

This project is licensed under the [MIT License](LICENSE).