typescript-starter-template

A template project for javascript library (for browsers or Node.js) and/or executable for Node.js.

npm scripts

pnpm lint

• Static analysis of code with ESLint
• Code format checking with Prettier
• Type checking of TypeScript with tsc
• Credential checking with secretlint

pnpm fix

(if modifiable) Code fixes by ESLint and Prettier

pnpm build

• Build library entry points for both ESM and CJS by tsup
• Build an executable that runs in ESM mode by tsup

pnpm test

Testing by Vitest

pnpm watch

Watching mode of build

Note about Vitest

Sometimes the test hangs due to problems outside of Vitest. In that case, it can be fixed by vitest.config.ts with pool: "forks".

scripts for project starter

There are scripts in the `scripts' directory to customize a new project.

Once the project is started, these scripts should be deleted.

changesets

This template is almost ready for using changesets. To enable changesets for releasing to npm registry:

• add NPM_TOKEN to Actions secrets of the repository
• modify .github/workflows/release.yml to enable the release workflow
• modify .github/workflows/build-test.yml
• modify .changeset/config.json if you are using a default branch name other than main.
• modify .prettierignore to ignore CHANGELOG.md and pre.json with prettier
• allow GitHub Actions to create Pull Request. See this image.
• (Optional) install changeset-bot

Note about ts-node or something

This template does not mention ts-node, esbuild-register, tsx or other similar software.

The current versions of them do not act in the same way as the official TypeScript compiler.

ts-node and esbuild-register have a different import resolution mechanism from the tsc and will not run if you use .js extension in the import statement.

tsx is somewhat better than these, but I saw that it does not work well when importing CommonJs from ESM.