# zy-json-to-excel

**Repository Path**: sunrist1/zy-json-to-excel

## Basic Information

- **Project Name**: zy-json-to-excel
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-08-04
- **Last Updated**: 2025-08-04

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Zouy JSON to Excel 转换工具

这是一个将多语言 JSON 文件转换为 Excel 格式的 npm 包，支持从配置文件读取参数。

## 功能特性

- 支持多语言 JSON 文件转换
- 自动扁平化嵌套的 JSON 对象
- 支持配置文件参数
- 命令行参数优先级高于配置文件
- 自动创建 Excel 文件
- 支持全局安装使用

## 安装

### 全局安装（推荐）

```bash
npm install -g zouy-json
```

### 本地安装

```bash
npm install zouy-json
```

## 使用方法

### 1. 使用配置文件（推荐）

创建 `zouy-json.config.json` 配置文件：

```json
{
    "directory": "src/locales",
    "output": "zuoy/zuoy-project.xlsx",
    "sheet": "zuoy-project"
}
```

然后执行构建命令：

```bash
zouy-json build
```

### 2. 使用命令行参数

```bash
zouy-json build -d <目录路径> -o <输出文件> -s <工作表名称>
```

参数说明：
- `-d, --directory`: 包含 JSON 文件的目录路径
- `-o, --output`: 输出 Excel 文件路径
- `-s, --sheet`: 工作表名称（可选，默认为 'Translations'）

### 3. 混合使用

可以同时使用配置文件和命令行参数，命令行参数的优先级更高：

```bash
zouy-json build -s custom-sheet
```

### 4. 查看帮助

```bash
# 查看主帮助
zouy-json --help

# 查看构建命令帮助
zouy-json build --help
```

## 配置文件格式

配置文件 `zouy-json.config.json` 包含以下字段：

- `directory`: 包含 JSON 文件的目录路径
- `output`: 输出 Excel 文件路径
- `sheet`: 工作表名称（可选）

## 输入文件格式

工具会读取指定目录中的所有 `.json` 文件，文件名格式应为：

```
<语言代码>.json
```

例如：
- `zh.json` (中文)
- `en.json` (英文)
- `ja.json` (日文)

## 输出格式

生成的 Excel 文件包含以下列：
- `key`: 翻译键
- `<语言代码1>`: 对应语言的翻译内容
- `<语言代码2>`: 对应语言的翻译内容
- ...

## 示例

### 输入文件结构

```
src/locales/
├── zh.json
└── en.json
```

### zh.json 内容

```json
{
  "common": {
    "welcome": "欢迎",
    "hello": "你好"
  }
}
```

### en.json 内容

```json
{
  "common": {
    "welcome": "Welcome",
    "hello": "Hello"
  }
}
```

### 输出 Excel 内容

| key | zh | en |
|-----|----|----|
| common.welcome | 欢迎 | Welcome |
| common.hello | 你好 | Hello |

## 开发模式

如果你在开发环境中，也可以直接运行：

```bash
# 克隆项目
git clone <repository-url>
cd zouy-json

# 安装依赖
npm install

# 运行
node index.js build
```

## 注意事项

1. 确保输入目录存在且包含有效的 JSON 文件
2. 确保输出目录存在，否则程序会尝试创建
3. 如果配置文件不存在，程序会显示警告但继续执行
4. 命令行参数的优先级高于配置文件中的设置
5. 全局安装后可以直接使用 `zouy-json` 命令

## 发布到 npm

```bash
# 登录 npm
npm login

# 发布包
npm publish
```