starter-typescript

A simple code template for TypeScript developing.

use:

1. tsdown for file compiling.
2. tsx for file execution and content change monitoring.
3. ESLint for code formatting and linting. And also use my personal eslint-config for linting rules.
4. Auto GitHub workflows for new version.
5. Vitest for unit testing.

Usage

You need to change some things before you start coding:

1. README.md file.
2. Change the name, version, description, author, license, homepage, keywords, repository info in package.json file.
3. Change the license info in LICENSE file.
4. If you don't want to use GitHub workflow, delete the .github folder.
5. Start coding in src and test folder.
6. If you want to publish your package to npm, you need to add a prepack script in package.json file. For example:

{
  "scripts": {
    "prepack": "<your prepack script, e.g. pnpm run build>"
  }
}