8000 GitHub - bianxuerui/new-compgen: 一个简洁高效的 CLI 工具,帮助你快速生成 React 组件。支持 JavaScript (JSX) 和 TypeScript (TSX),并自动创建配套的 CSS Module 文件。
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

一个简洁高效的 CLI 工具,帮助你快速生成 React 组件。支持 JavaScript (JSX) 和 TypeScript (TSX),并自动创建配套的 CSS Module 文件。

Notifications You must be signed in to change notification settings

bianxuerui/new-compgen

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 
 
 

Repository files navigation

new-compgen

一个简洁高效的 CLI 工具,帮助你快速生成 React 组件。支持 JavaScript (JSX) 和 TypeScript (TSX),并自动创建配套的 CSS Module 文件。

特性

  • 🚀 快速生成 React 组件
  • 💪 支持 JavaScript (JSX) 和 TypeScript (TSX)
  • 🎨 自动创建 CSS Module 文件
  • ⚙️ 可配置的组件模板
  • 📁 自定义组件存放目录
  • 🎯 交互式命令行界面

安装

# 全局安装
npm install -g new-compgen

# 或者使用 yarn
yarn global add new-compgen

使用方法

new-compgen

运行命令后,按照提示进行操作:

  1. 输入组件名称(必须以大写字母开头)
  2. 选择开发语言(JavaScript 或 TypeScript)
  3. 指定组件存放目录(默认为 src/components)

示例

$ new-compgen
? 请输入组件名称: Button
? 请选择开发语言: TypeScript (TSX)
? 请输入组件存放目录: src/components

✨  Creating the Button component ✨

Directory:  src/components/Button
Language:   TypeScript
=========================================

✓ 目录已创建。
✓ 组件文件已创建。
✓ 样式文件已创建。

Component created!

生成的文件结构

对于 TypeScript 组件: src/components/YourComponent/ ├── index.tsx └── index.module.css

对于 JavaScript 组件: src/components/YourComponent/ ├── index.jsx └── index.module.css

配置

你可以通过创建配置文件来自定义默认行为:

全局配置

创建文件 ~/.new-compgen-config.json

{
  "lang": "ts",
  "dir": "src/components"
}

项目级配置

在项目根目录创建 new-compgen-config.json

{
  "lang": "js",
  "dir": "src/components"
}

配置优先级:

  1. 项目级配置
  2. 全局配置
  3. 默认配置

自定义模板

模板文件位于 src/templates 目录:

  • js.js - JavaScript 组件模板
  • ts.js - TypeScript 组件模板
  • style.css - CSS Module 模板

你可以根据需要修改这些模板文件。

开发

# 克隆仓库
git clone https://github.com/yourusername/new-compgen.git

# 安装依赖
cd new-compgen
npm install

# 本地链接
npm link

# 测试
new-compgen

依赖

  • commander - 命令行界面
  • inquirer - 交互式命令行
  • chalk - 终端样式
  • prettier - 代码格式化

许可证

ISC

贡献

欢迎提交 Issue 和 Pull Request!

  1. Fork 本仓库
  2. 创建你的特性分支 (git checkout -b feature/AmazingFeature)
  3. 提交你的修改 (git commit -m 'Add some AmazingFeature')
  4. 推送到分支 (git push origin feature/AmazingFeature)
  5. 打开一个 Pull Request

作者

bianxuerui

致谢

感谢所有为这个项目做出贡献的开发者!

About

一个简洁高效的 CLI 工具,帮助你快速生成 React 组件。支持 JavaScript (JSX) 和 TypeScript (TSX),并自动创建配套的 CSS Module 文件。

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published
0