https://github.com/sripwoud/ts-template
Typescript Project Template
https://github.com/sripwoud/ts-template
biomejs bun convco docker dprint hk mise template typescript
Last synced: 3 months ago
JSON representation
Typescript Project Template
- Host: GitHub
- URL: https://github.com/sripwoud/ts-template
- Owner: sripwoud
- License: agpl-3.0
- Created: 2022-11-22T09:37:00.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-02-23T21:24:59.000Z (4 months ago)
- Last Synced: 2025-03-19T04:04:25.838Z (3 months ago)
- Topics: biomejs, bun, convco, docker, dprint, hk, mise, template, typescript
- Language: Shell
- Homepage:
- Size: 325 KB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
| 
| TEMPLATE |
| ---------------------------------------------------------------------------------------------------------------------------------------- | -------- |
[](https://coveralls.io/github/sripwoud/ts-template?branch=main)
| Feature | With | Configuration File |
| --------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- |
| Continuous Integration | [GitHub Workflow](https://docs.github.com/en/actions/using-workflows) | [.github/workflows](./.github/workflows) |
| Conventional Commits (`main` branch only) | [convco](https://github.com/convco/convco) | [.convco](./.convco) |
| Conventional PR Titles (because I only squash merge and base changelogs/semantic versioning on `main` commit history) | [amann/action-semantic-pull-request](https://github.com/amannn/action-semantic-pull-request) | [semantic-pr.yml](./.github/workflows/semantic-pr.yml) |
| Formatting | [dprint](https://dprint.dev/) | [.dprint.jsonc](./.biome.json) |
| Git Hooks | [hk](https://hk.jdx.dev/) | [hk.pkl](./hk.pkl) |
| Import Aliases | [Typescript paths](https://www.typescriptlang.org/tsconfig#paths) | [tsconfig.json](https://github.com/r1oga/ts-template/blob/5d6983a6d28429b9dd256edf40bad5ee48c33d9c/tsconfig.json#L26) |
| Linting | [Biome](https://biomejs.dev/) | [.biome.jsonc](./.biome.jsonc) |
| Runtime, Tests Runner | [Bun](https://bun.sh) | [bunfig.toml](./bunfig.toml) |
| Tasks Runner, Environment & Runtime Management | [mise](https://mise.dev/) | [mise.toml](./mise.toml) |
| Typings | [Typescript](https://www.typescriptlang.org/) | [tsconfig.json](./tsconfig.json) |
## Develop
I use [`mise`](https://mise.jdx.dev) to manage runtimes, manage environment variables, and run tasks.\
To install it and setup the repository:
```commandline
./setup
```
To run tasks interactively:
```commandline
mise run
```