@quick-gen/cli
v1.0.0
Published
Quick and flexible code generation toolkit
Maintainers
Readme
@quick-gen/cli
A quick and flexible code generation toolkit.
🚀 Features
- 📝 Code Generation: Generate various types of code and documentation
- 🔧 Plugin System: Extensible architecture for different generation needs
- 🎯 Easy to Use: Simple and intuitive CLI interface
- 🔄 More features coming soon...
📦 Installation
Global Installation (Recommended)
# Using npm
npm install -g @quick-gen/cli
# Using yarn
yarn global add @quick-gen/cli
# Using pnpm
pnpm add -g @quick-gen/cliLocal Installation
# Using npm
npm install @quick-gen/cli --save-dev
# Using yarn
yarn add -D @quick-gen/cli
# Using pnpm
pnpm add -D @quick-gen/cli🎯 Usage
Generate React Documentation
# Using global installation
quick-gen react -d src/components
# Using local installation
npx quick-gen react -d src/componentsCommon Commands
# Generate docs for components
quick-gen react -d src/components
# Generate TypeScript props types
quick-gen react -d src/components --extensions ts,tsx --output type
# Convert existing quick-gen JSDoc to TypeScript props types
quick-gen react -d src/components --extensions ts,tsx --convert-jsdoc-to-type
# Show help
quick-gen --helpCLI Options
| Command | Description |
|---------|-------------|
| react -d [dir] | Generate JSDoc or TypeScript props types for React components |
React Command Options
| Option | Alias | Description | Default |
|--------|-------|-------------|---------|
| --dir | -d | Directory to scan for React components | src |
| --extensions | -e | Comma-separated file extensions to scan | js,jsx,ts,tsx |
| --output | -o | Output mode: jsdoc, type, or both | jsdoc |
| --convert-jsdoc-to-type | | Convert quick-gen JSDoc blocks into TypeScript props types | false |
| --keep-jsdoc | | Keep existing JSDoc when converting to TypeScript types | false |
| --type-suffix | | Suffix for generated props type names | Props |
| --export-types | | Add export to generated TypeScript types | false |
| --help | -h | Show help | |
🛠️ Requirements
- Node.js >= 14
- React project with
.js,.jsx,.ts, or.tsxfiles
📦 Related Packages
- @quick-gen/cli - Core CLI tool
- @quick-gen/react - React documentation generator
