https://github.com/rainbowatcher/ts-cli-starter

lightweight typescript command line app starter template
https://github.com/rainbowatcher/ts-cli-starter

template typescript

Last synced: 5 days ago
JSON representation

lightweight typescript command line app starter template

• Host: GitHub
• URL: https://github.com/rainbowatcher/ts-cli-starter
• Owner: rainbowatcher
• License: mit
• Created: 2023-04-02T07:20:16.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-10-30T02:06:38.000Z (4 months ago)
• Last Synced: 2024-10-30T04:57:36.684Z (4 months ago)
• Topics: template, typescript
• Language: TypeScript
• Homepage:
• Size: 688 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/rainbowatcher/ts-cli-starter/ci.yml)](https://github.com/rainbowatcher/ts-cli-starter/actions)

![GitHub License](https://img.shields.io/github/license/rainbowatcher/ts-cli-starter)

![GitHub package.json version](https://img.shields.io/github/package-json/v/rainbowatcher/ts-cli-starter)

# ts-cli-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

- [Dependencies](https://packagephobia.com/result?p=@clack/prompts,cac)

  - `@clack/prompts`:[![install size](https://packagephobia.com/badge?p=@clack/prompts)](https://packagephobia.com/result?p=@clack/prompts)

  - `cac`: [![install size](https://packagephobia.com/badge?p=cac)](https://packagephobia.com/result?p=cac)

- [DevDependencies](https://packagephobia.com/result?p=@rainbowatcher/eslint-config,@rainbowatcher/eslint-config-js,@rainbowatcher/eslint-config-json,@rainbowatcher/eslint-config-ts,@rainbowatcher/eslint-config-ignore,@rainbowatcher/eslint-config-prettier,@rainbowatcher/eslint-config-md,conventional-changelog-cli,bumpp,commitlint,eslint,husky,jiti,pkgroll,typescript,vitest)

  - `typescript`: [![install size](https://packagephobia.com/badge?p=typescript)](https://packagephobia.com/result?p=typescript)

  - `vitest`: [![install size](https://packagephobia.com/badge?p=vitest)](https://packagephobia.com/result?p=vitest)

  - `commitlint`: [![install size](https://packagephobia.com/badge?p=commitlint)](https://packagephobia.com/result?p=commitlint)

  - `eslint`: [![install size](https://packagephobia.com/badge?p=eslint)](https://packagephobia.com/result?p=eslint)

  - `@rainbowatcher/eslint-config`

  - `pkgroll`: [![install size](https://packagephobia.com/badge?p=pkgroll)](https://packagephobia.com/result?p=pkgroll)

  - `bumpp`: [![install size](https://packagephobia.com/badge?p=bumpp)](https://packagephobia.com/result?p=bumpp)

  - `@types/node`: [![install size](https://packagephobia.com/badge?p=@types/node)](https://packagephobia.com/result?p=@types/node)

  - `jiti`: [![install size](https://packagephobia.com/badge?p=jiti)](https://packagephobia.com/result?p=jiti)

  - `husky`: [![install size](https://packagephobia.com/badge?p=husky)](https://packagephobia.com/result?p=husky)

## Usage

1. Clone this repository

```bash

npx degit https://github.com/rainbowatcher/ts-cli-starter.git 

```

2. Install dependencies by using `pnpm install`

3. Global Replace `ts-cli-starter` to your package name in project

4. Change the author and repository address in `package.json`

5. Change the author name in `LICENSE`

6. Clean up the `README.md` and `CHANGELOG.md`

## License

[MIT](./LICENSE) © Made by ❤️