browser-plugin-creator/README.md

A modern scaffolding tool for creating browser extensions with ease

# Browser Plugin Creator

一个现代化的浏览器插件脚手架工具，支持快速创建各种类型的浏览器扩展。

## 特性

- 🚀 **快速创建** - 一键生成浏览器扩展项目
- 📦 **多种模板** - 支持弹窗、内容脚本、开发者工具等多种模板
- 🔧 **灵活配置** - 支持React、Vue、TypeScript等现代前端技术栈
- 🎯 **最佳实践** - 内置Manifest V3、现代化构建配置
- 📝 **交互式CLI** - 友好的命令行交互体验

## 安装

### 全局安装
```bash
npm install -g browser-plugin-creator
```

### 本地使用
```bash
npx browser-plugin-creator create my-extension
```

## 使用方法

### 创建项目
```bash
# 交互式创建
browser-plugin-creator create my-extension

# 指定模板
browser-plugin-creator create my-extension --template content-script

# 强制覆盖已存在目录
browser-plugin-creator create my-extension --force

# 使用TypeScript
browser-plugin-creator create my-extension --typescript

# 跳过Git初始化
browser-plugin-creator create my-extension --no-git
```

### 查看可用模板
```bash
browser-plugin-creator list
```

### 配置管理
```bash
# 列出所有配置
browser-plugin-creator config --list

# 设置作者
browser-plugin-creator config --set author "Your Name"

# 设置邮箱
browser-plugin-creator config --set email "your@email.com"
```

## 可用模板

| 模板名称 | 描述 | 技术栈 | 难度 |
|---------|------|--------|------|
| `basic-popup` | 基础弹窗扩展 | Vanilla JS, CSS | 简单 |
| `content-script` | 内容脚本扩展 | Vanilla JS, TypeScript | 中等 |
| `full-featured` | 完整功能扩展 | React, TypeScript, Webpack | 高级 |
| `devtools` | 开发者工具扩展 | React, TypeScript | 高级 |
| `side-panel` | 侧边栏扩展 | Vue 3, TypeScript | 中等 |

## 项目结构

创建的项目包含以下文件结构：

```
my-extension/
├── src/
│   ├── popup/
│   │   ├── popup.html
│   │   ├── popup.js
│   │   └── popup.css
│   ├── content/
│   │   └── content.js
│   ├── background/
│   │   └── background.js
│   └── manifest.json
├── package.json
├── webpack.config.js
├── tsconfig.json (如果使用TypeScript)
└── README.md
```

## 开发

### 本地开发
```bash
# 克隆项目
git clone https://github.com/your-org/browser-plugin-creator.git
cd browser-plugin-creator

# 安装依赖
npm install

# 开发模式
npm run dev

# 构建项目
npm run build
```

### 添加新模板
1. 在 `templates/` 目录下创建新模板文件夹
2. 添加模板文件（manifest.json, package.json等）
3. 更新 `src/cli/commands/list.ts` 中的模板列表

## 技术栈

- **CLI**: Commander.js, Inquirer.js
- **构建**: TypeScript, Webpack
- **模板**: Handlebars
- **工具**: Chalk, Ora, fs-extra

## 贡献

欢迎提交Issue和Pull Request！

## 许可证

MIT License