https://github.com/gamemaker1/typescript-template
An opiniated Typescript + ESM project template
https://github.com/gamemaker1/typescript-template
Last synced: about 1 year ago
JSON representation
An opiniated Typescript + ESM project template
- Host: GitHub
- URL: https://github.com/gamemaker1/typescript-template
- Owner: gamemaker1
- License: other
- Created: 2021-12-02T07:51:31.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2022-05-02T12:18:17.000Z (about 4 years ago)
- Last Synced: 2025-03-28T19:47:34.650Z (about 1 year ago)
- Language: JavaScript
- Size: 161 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- Changelog: changelog.md
- Contributing: contributing.md
- License: license.md
Awesome Lists containing this project
README
#
Opiniated Typescript + ESM Template
## What Is This?
An opiniated template for Typescript + ESM projects.
It includes:
- [`typescript`](https://www.typescriptlang.org/) +
[`esm`](https://hacks.mozilla.org/2018/03/es-modules-a-cartoon-deep-dive/) for
writing code (compiles to esm for `node` 14+).
- [`esbuild`](https://esbuild.github.io/) +
[`dts-bundle-generator`](https://github.com/timocov/dts-bundle-generator#readme)
for blazing fast builds.
- [`jest`](https://jestjs.io/) for testing.
- [`xo`](https://github.com/xojs/xo#readme) + [`prettier`](https://prettier.io/)
for linting and formatting.
- [`husky`](https://typicode.github.io/husky/#/) +
[`lint-staged`](https://github.com/okonet/lint-staged#readme) for linting
staged files before committing them.
- [`pnpm`](https://pnpm.io/) for fast and efficient package management.
- [`wireit`](https://github.com/google/wireit) for smarter and more efficient
npm scripts.
- a [`contributing.md`](./contributing.md), [`changelog.md`](./changelog.md),
[`license.md`](./license.md) and [`readme.md`](./readme.md) file.
## How Do I Use It?
To use this template, `degit` it:
```
$ mkdir
$ pnpx degit gamemaker1/typescript-template
$ pnpm install
```
Answer a couple of questions as part of the setup process, and get coding!
## License
You can use this template for any project! The `license.md` file in this
repository IS NOT the license for this template - it is part of the template,
and you can change it as you wish.