README
TypeScript project Generator CLI
This is generator for TypeScript project boilerplate
Support projects
Target | SWC | Vite | Jest | ESLint | Prettier | Storybook |
---|---|---|---|---|---|---|
Node CLI | ✅ | ❌ | ✅ | ✅ | ✅ | ❌ |
Next.js v12 | ✅ | ❌ | ✅ | ✅ | ✅ | ✅ |
React v17 | ❌ | ❌ | ✅ | ✅ | ✅ | ❌ |
Vite vanilla-ts | ❌ | ✅ | ✅ | ✅ | ✅ | ❌ |
Node server | ✅ | ❌ | ✅ | ✅ | ✅ | ❌ |
Install
npm i -g @lycolia/ts-boilerplate-generator-cli
Required
- Git
- and configured git user
- Node.js 14+
- npm 6+
Usage
Can setup for README.md and package.json and workspace directory by configure CLI options When no option then launch yeoman style generator
- Basics
tsg
ortsg [options]
- CLI Options (All optional)
-a
,--author
project author (default: unknown
)-d
,--description
project description (default: no description
)-l
,--license
project license (default: MIT
)-p
,--project-name
project name (default: @unknown/no-name-project
)-t
,--type
project type (choices: ts-cli
,ts-next
,ts-react
,ts-vite-vanilla
,ts-server
, default:ts-cli
)ts-cli
- create from blank boilerplate for CLI app
ts-next
ts-react
- create from react-router included boilerplate for React v17
ts-vite-vanilla
- create from boilerplate for Vite vannila-ts
ts-server
- create from blank boilerplate for server app
-V
,--version
output the version number-h
,--help
display help for command
- Example
tsg -a your-own-name -d YourProjectDescription -l AGPL-3.0-or-later -p @your-own-name/your-project-name -t ts-react