156 lines
3.1 KiB
Markdown
156 lines
3.1 KiB
Markdown
# 快速开始指南
|
||
|
||
## 🚀 5分钟上手
|
||
|
||
### 1. 基本使用
|
||
|
||
生成一张银联卡（默认）：
|
||
```bash
|
||
node src/cli.js card
|
||
```
|
||
|
||
输出：
|
||
```
|
||
6228367546245545|08|29|783
|
||
```
|
||
|
||
### 2. 常用命令
|
||
|
||
```bash
|
||
# 生成Visa卡
|
||
node src/cli.js card -t visa
|
||
|
||
# 批量生成10张银联卡
|
||
node src/cli.js card -n 10
|
||
|
||
# JSON格式输出
|
||
node src/cli.js card -f json
|
||
|
||
# 美化格式
|
||
node src/cli.js card -f pretty
|
||
|
||
# 查看支持的卡类型
|
||
node src/cli.js card list-types
|
||
|
||
# 查看帮助
|
||
node src/cli.js --help
|
||
```
|
||
|
||
### 3. 便捷脚本
|
||
|
||
也可以使用 npm scripts：
|
||
|
||
```bash
|
||
# 生成一张卡
|
||
npm run card
|
||
|
||
# 使用自定义参数（需要加 -- ）
|
||
npm run card -- -t visa -n 5
|
||
```
|
||
|
||
### 4. 批量生成并保存
|
||
|
||
```bash
|
||
# 生成100张银联卡并保存
|
||
node src/cli.js card -n 100 > cards.txt
|
||
|
||
# 生成CSV格式
|
||
node src/cli.js card -n 50 -f csv > cards.csv
|
||
|
||
# 生成JSON格式（每行一个JSON对象）
|
||
node src/cli.js card -n 20 -f json > cards.json
|
||
```
|
||
|
||
### 5. 编程使用
|
||
|
||
创建脚本 `test.js`：
|
||
|
||
```javascript
|
||
const CardGenerator = require('./src/tools/card-generator/generator');
|
||
const generator = new CardGenerator();
|
||
|
||
// 生成单张卡
|
||
const card = generator.generate('unionpay');
|
||
console.log(card);
|
||
|
||
// 批量生成
|
||
const cards = generator.generateBatch(10, 'visa');
|
||
console.log(cards);
|
||
```
|
||
|
||
运行：
|
||
```bash
|
||
node test.js
|
||
```
|
||
|
||
## 📊 输出格式对比
|
||
|
||
| 格式 | 命令 | 输出示例 |
|
||
|------|------|---------|
|
||
| **Pipe** | `node src/cli.js card` | `6228367546245545\|08\|29\|783` |
|
||
| **JSON** | `node src/cli.js card -f json` | `{"number":"6228367546245545","month":"08","year":"29","cvv":"783","type":"中国银联 (UnionPay)"}` |
|
||
| **CSV** | `node src/cli.js card -f csv` | `6228367546245545,08,29,783` |
|
||
| **Pretty** | `node src/cli.js card -f pretty` | 多行美化格式 |
|
||
|
||
## 🎯 常见使用场景
|
||
|
||
### 测试场景1: 支付系统测试
|
||
|
||
```bash
|
||
# 生成各种卡类型用于测试
|
||
node src/cli.js card -t visa -n 5
|
||
node src/cli.js card -t mastercard -n 5
|
||
node src/cli.js card -t amex -n 5
|
||
```
|
||
|
||
### 测试场景2: 前端表单测试
|
||
|
||
```bash
|
||
# 生成JSON格式用于mock数据
|
||
node src/cli.js card -n 20 -f json > mock-cards.json
|
||
```
|
||
|
||
### 测试场景3: 数据库填充
|
||
|
||
```bash
|
||
# 生成CSV格式导入数据库
|
||
node src/cli.js card -t unionpay -n 1000 -f csv > import.csv
|
||
```
|
||
|
||
## 🔧 运行示例代码
|
||
|
||
查看完整示例：
|
||
```bash
|
||
node examples/basic-usage.js
|
||
```
|
||
|
||
## ⚡ 性能提示
|
||
|
||
- 单次生成推荐不超过 10000 张卡
|
||
- 大批量生成建议分批进行
|
||
- 使用 pipe 格式性能最优
|
||
|
||
## ❓ 遇到问题？
|
||
|
||
1. 查看完整文档：`README.md`
|
||
2. 查看工具文档：`docs/tools/card-generator.md`
|
||
3. 运行示例：`node examples/basic-usage.js`
|
||
|
||
## 📝 输出格式说明
|
||
|
||
**Pipe格式** (默认)：`卡号|月|年|CVV`
|
||
- 适合：文本处理、批量导入
|
||
- 分隔符：`|`
|
||
|
||
**JSON格式**：完整JSON对象
|
||
- 适合：API测试、前端mock
|
||
- 包含：卡号、有效期、CVV、卡类型
|
||
|
||
**CSV格式**：逗号分隔
|
||
- 适合：Excel、数据库导入
|
||
- 分隔符：`,`
|
||
|
||
**Pretty格式**：美化显示
|
||
- 适合：人工阅读、展示
|
||
- 多行格式化输出
|