quick-gen

A collection of quick and flexible code generation tools for modern web development.

🚀 Features

• 📝 React Documentation Generation: Automatically generate JSDoc for React components
• 🧩 React Type Generation: Generate TypeScript props types from scanned props or quick-gen JSDoc
• 🔍 Intelligent Detection: Smart component and props analysis
• 🛠️ Flexible Toolkit: Extensible architecture for various generation needs
• 💪 Developer Friendly: Easy to use CLI with comprehensive options

📦 Installation

Install CLI Tool (Recommended)

# Using npm
npm install -g @quick-gen/cli

# Using yarn
yarn global add @quick-gen/cli

# Using pnpm
pnpm add -g @quick-gen/cli

Install React Plugin

# Using npm
npm install @quick-gen/react --save-dev

# Using yarn
yarn add -D @quick-gen/react

# Using pnpm
pnpm add -D @quick-gen/react

🎯 Usage

Using the CLI tool

# Generate JSDoc for React components
quick-gen react -d src/components

# Generate TypeScript props types for TS/TSX React components
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 --help

Using the React package directly

const { generateDocs } = require('@quick-gen/react');

generateDocs('src/components');

generateDocs('src/components', {
  extensions: ['ts', 'tsx'],
  output: 'type'
});

🛠️ Development

This project uses pnpm as its package manager. To get started:

# Install pnpm if you haven't already
npm install -g pnpm

# Install dependencies
pnpm install

# Run tests
pnpm test

📦 Available Packages

Package	Description	Version
@quick-gen/cli	Core CLI tool for code generation
@quick-gen/react	React code generator and documentation tool

🔗 Links

• GitHub Repository
• Bug Reports
• npm Organization

📄 License

MIT © Felix Shih