typescript-standards

TypeScript Project Standards

Overview

This skill helps you create professional TypeScript libraries using the typescript-library-template pattern and apply these standards to existing projects. It provides a modern, production-ready setup with dual module format support, comprehensive testing, and consistent code quality tooling.

When to Use This Skill

Trigger this skill when:

• Creating a new TypeScript library or npm package
• Standardizing build scripts across TypeScript projects
• Setting up or migrating to dual module format (CommonJS + ES modules)
• Configuring modern tooling (tsup, Vitest, ESLint, Prettier)
• Applying consistent code quality standards
• Publishing packages to npm
• Migrating from older build tools (webpack, rollup, tsc alone)

Quick Start

Scenario 1: Creating a New Project

# Clone the template
git clone https://github.com/jordanburke/typescript-library-template.git my-library
cd my-library

# Remove template's git history
rm -rf .git
git init

# Install dependencies
pnpm install

# Customize (see references/template-setup.md for checklist)
# - Update package.json (name, description, repository)
# - Update README.md
# - Add your code to src/

# Validate everything works
pnpm validate

Scenario 2: Applying Standards to Existing Project

See references/standardization.md for detailed migration guide. Quick version:

1. Update scripts in package.json to standardized pattern
2. Install tooling: tsup, vitest, eslint, prettier
3. Copy configs: tsup.config.ts, vitest.config.ts, eslint.config.mjs
4. Update build outputs: Dual module format with proper exports
5. Run validation: pnpm validate

Core Standards

Script Commands

The template follows a consistent command pattern:

Main validation command:

pnpm validate    # Format → Lint → Test → Build (use before commits)

Individual operations:

# Formatting
pnpm format           # Write formatted code
pnpm format:check     # Validate formatting only

# Linting
pnpm lint             # Fix ESLint issues
pnpm lint:check       # Check ESLint issues only

# Testing
pnpm test             # Run tests once
pnpm test:watch       # Watch mode
pnpm test:coverage    # With coverage report
pnpm test:ui          # Interactive UI

# Building
pnpm build            # Production build (dist/)
pnpm dev              # Development watch (lib/)
pnpm ts-types         # Type check only