Skip to content

README.md

Latest commit

 

History

History
93 lines (58 loc) · 2.9 KB

README.md

File metadata and controls

93 lines (58 loc) · 2.9 KB
Raw

Homepage

npm Continuous integration PRs Welcome Sponsor GitHub stars

Welcome to @ts-dev-tools/core 💎

Common Typescript dev tools

What's included

📦 Package scripts

  • test: Run tests with Vitest
  • format: Format code with Biome
  • lint: Run linter with Biome
  • check: Run Biome checks and apply safe fixes
  • prepare: Self install / update

⚡ Git hooks

pre-commit

  • Run Biome checks against staged git files

commit-msg

pre-push

  • Run linter
  • Execute Typescript compiler with tsc
  • Run tests

👕 Code quality

  • Install and configure Biome for linting and formatting
  • Enable Biome recommended rules and VCS integration
  • Organize imports with Biome assist actions

🧪 Tests

📖 Types

Usage

1. Install

npm install --save-dev @ts-dev-tools/core

Or

yarn add --dev @ts-dev-tools/core

Or

pnpm add -D @ts-dev-tools/core

2. Enable ts-dev-tools

npm exec ts-dev-tools install

Or

yarn ts-dev-tools install

Or

pnpm ts-dev-tools install

⚠️ If your package is using yarn, is not private and you're publishing it on a registry like npmjs.com, you need to disable postinstall script using pinst. Otherwise, postinstall will run when someone installs your package and result in an error.