rainbowatcher / ts-starter

lightweight typescript library starter template

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

GitHub Workflow Status GitHub License GitHub package.json version

ts-starter

🚀Features

  • Minimal install sized Dependencies
  • VSCode compatible eslint configuration
  • Cross platform CI configuration
  • Pre-Commit lint
  • Auto Changelog generate
  • Smooth release experience
  • Complete package build config

Install Size

  • DevDependencies
    • commitlint: install size
    • typescript: install size
    • vitest: install size
    • eslint & @rainbowatcher/eslint-config: install size
    • pkgroll: install size
    • bumpp: install size
    • @types/node: install size
    • jiti: install size
    • husky: install size

Usage

  1. Clone this repository
npx degit https://github.com/rainbowatcher/ts-starter.git <pkg-name>
  1. Install dependencies by using pnpm install
  2. Setup git hooks
npx husky add .husky/commit-msg  'npx --no -- commitlint --edit ${1}'
npx husky add .husky/pre-commit 'npx lint-staged'
  1. Global replace ts-starter to your package name in project
  2. Change the author name in LICENSE
  3. Clean up the READMEs and remove routes

License

MIT © Made by ❤️

About

lightweight typescript library starter template

License:MIT License


Languages

Language:JavaScript 77.9%Language:TypeScript 22.1%