A template for crafting Typescript libraries

Introduction

typescript-library-starter serves as a foundational scaffold for developers, offering an intuitive and organized starting point for creating scalable and maintainable TypeScript projects.

Includes

• pnpm: Fast, disk space efficient package manager.
• typescript: Superset of JavaScript that compiles to clean JavaScript output.
• nextra: Simple, powerful and flexible site generation framework.
• tsup: The simplest and fastest way to bundle your TypeScript libraries.
• eslint: Find and fix problems in your JavaScript code.
• prettier: Opinionated code formatter.
• lint-staged: Run linters on git staged files.
• husky: Git hooks made easy.
• github-actions: Workflow automations.

Configuration

The default configuration is the one that I usually find more suitable for my projects. Adapt it to fit your requirements.

• Configure package.json
• Configure README
• Configure typescript options
• Configure tsup options
• Configure eslint options
• Configure prettier options
• Configure changeset options
• Configure lint-staged options
• Configure husky "pre-commit" (or add yours)

Repository Secrets

• COVERALLS_REPO_TOKEN
• NPM_TOKEN
• Settings > Actions > General > Workflow permissions > Allow GitHub Actions to create and approve pull requests

Authors

• Hugo Corta (@hugocxl)

License

MIT License © 2023-Present Hugo Corta