@boostpack/typescript-library-starter

A starter template for TypeScript libraries with all modern tooling included.

Start coding in seconds with zero configuration! 🚀

Inspired by alexjoverm/typescript-library-starter

✨ Features

• 📦 Rollup for optimized bundles (ESM + CommonJS)
• 🚀 TypeScript 5.7 with strict mode
• 🔥 Node.js 22 LTS support
• 🧪 Jest for fast unit testing
• 📖 TypeDoc for API documentation with versioning
• 🔍 ESLint + Prettier + SonarJS for code quality
• 🤖 GitHub Actions for CI/CD
• 🏷️ Semantic Release for automated versioning
• 📊 Codecov for coverage reports
• 🎯 Commitlint with conventional commits

🚀 Quick Start

Use this template

1. Click the "Use this template" button on GitHub
2. Clone your new repository
3. Install dependencies:

npm ci

4. Start developing:

📖 Documentation

• Getting Started Guide - Quick start guide
• Contributing Guide - How to contribute to this project

📚 Project Setup

Step 1: GitHub Repository Setup

1. Create a new repository from this template
2. Enable Renovate (choose one option):
   • Option A (Recommended): Install Renovate GitHub App for your repository
   • Option B: Use self-hosted Renovate workflow (requires RENOVATE_TOKEN secret)
3. Enable GitHub Pages (Settings → Pages → Source: GitHub Actions)
4. Add repository secrets (Settings → Secrets and variables → Actions):
   • NPM_TOKEN - Your npm automation token (create one here)
   • CODECOV_TOKEN - Your Codecov token (get it here)
   • RENOVATE_TOKEN - GitHub PAT for self-hosted Renovate (only if using Option B)

Step 2: Update Package Info

Edit package.json:

{
  "name": "@your-scope/your-library",
  "description": "Your library description",
  "repository": "your-username/your-repo",
  "author": "Your Name"
}

Step 3: Start Developing

# Install dependencies
npm install

# Run tests in watch mode
npm run test:watch

# Build the library
npm run build

# Run linter
npm run lint

# Generate docs
npm run docs

📝 NPM Scripts

Script	Description
npm run build	Build library (ESM + CommonJS)
npm run prebuild	Clean dist directory before build
npm test	Run tests
npm run test:watch	Run tests in watch mode
npm run lint	Lint and fix code
npm run format	Format code with Prettier
npm run prepare	Install Husky hooks
npm run publish	Publish with Semantic Release
npm run docs	Generate API docs (not implemented)
npm run docs:serve	Serve documentation (not implemented)
npm run docs:clean	Clean generated docs (not implemented)

Note: API documentation generation is not yet implemented.

🔧 Configuration

TypeScript

Strict mode is enabled by default. Edit tsconfig.json to customize compiler options.

Jest

Tests are located in test/ directory. Edit jest.config.js for custom configuration.

ESLint

This project uses a strict ESLint configuration with:

• TypeScript rules
• SonarJS for code quality
• Prettier for formatting

Edit eslint.config.js to customize rules.

Commitlint

Follow conventional commits:

• feat: New feature
• fix: Bug fix
• docs: Documentation
• test: Tests
• refactor: Code refactoring

Support for task codes: feat: [TASK-123] add feature

🚢 Publishing

Automated Releases

This template uses Semantic Release for automated versioning and publishing.

Release trigger: Pushes to protected branches only.

Supported release branches:

1. main/master → Production release
2. next → Pre-release (@next tag)
3. next-major → Major pre-release (@next-major tag)
4. alpha/beta → Testing releases (@alpha/@beta tags)
5. Maintenance branches (1.x, 2.15.x) → Patch releases for specific versions

Setup: Mark your release branches as protected in GitHub repository settings (Settings → Branches → Add rule).

Releases are automated when you push to protected branches:

• Version bumps based on commit messages
• Changelog generation
• npm publishing
• GitHub releases

Manual Publishing

# Build the library
npm run build

# Publish to npm
npm publish

🤝 Contributing

Development Workflow

1. Fork the repository
2. Create a feature branch
3. Make your changes
4. Run tests: npm test
5. Commit using conventional commits
6. Push and create a Pull Request

Commit Messages

We use conventional commits with support for task codes:

# Features
git commit -m "feat: add new feature"
git commit -m "feat(scope): [TASK-123] add feature with scope"

# Fixes
git commit -m "fix: resolve issue"
git commit -m "fix: [BUG-456] fix critical bug"

# Breaking changes
git commit -m "feat!: breaking change"

📋 GitHub Actions

The CI/CD pipeline runs on every push and PR:

• ✅ Linting (ESLint + Prettier)
• ✅ Type checking (TypeScript)
• ✅ Testing (Jest)
• ✅ Coverage (Codecov)
• ✅ Build validation
• ✅ Bundle size check

🏗️ Project Structure

.
├── src/                  # Source files
│   └── index.ts         # Library entry point
├── test/                # Test files
│   └── *.test.ts       # Test suites
├── dist/                # Built files (generated)
│   ├── esm/            # ES modules
│   ├── cjs/            # CommonJS
│   └── index.d.ts      # TypeScript declarations
├── docs/                # Documentation
│   ├── guides/         # User guides (Markdown)
│   └── contributing.md # Contributing guidelines
├── .github/
│   └── workflows/      # GitHub Actions
├── package.json
├── tsconfig.json        # TypeScript config
├── jest.config.js       # Jest config
├── rollup.config.js     # Rollup config
├── eslint.config.js     # ESLint config
└── renovate.json        # Renovate config

📄 License

MIT © Timur Popov

---

Made with ❤️ using TypeScript