Template TypeScript Node Package

Template TypeScript Node.js package with all the CI bells & whistles I commonly use. ✨

Explainer

This template is available for anybody who wants to set up a basic Node application using TypeScript. It sets up the following tooling for you:

ESLint: Static analysis for JavaScript code, configured with typescript-eslint for TypeScript code and other general-use plugins.
Markdownlint: Static analysis for Markdown code.
pnpm: Desk-efficient package manager alternative.
Prettier: Opinionated formatting for code, run on file save and as a Git commit hook via husky and lint-staged.
release-it: Generates changelogs, bumps the package version, and publishes to GitHub and npm based on conventional commits.
ts-prune: Unused exports detection for TypeScript code.
TypeScript: A typed superset of JavaScript, configured with strict compiler options.
Vitest: Fast unit tests, configured with coverage tracking.

First make sure you have the following installed:

To use this template:

Click the Use this template button to create a new repository with the same Git history
Open that repository, such as by cloning it locally or developing in a codespace
Create two tokens in repository secrets:
- ACCESS_TOKEN: A GitHub PAT with repo permissions
- NPM_TOKEN: An npm access token with Automation permissions
pnpm install
pnpm run setup

The setup script removes the ## Explainer and ## Setup from this README.md.

npm i template-typescript-node-package

import { greet } from "template-typescript-node-package";

greet("Hello, world!");

💙 This package is based on @JoshuaKGoldberg's template-typescript-node-package.