# i18ncheck

**Repository Path**: ataide2/i18ncheck

## Basic Information

- **Project Name**: i18ncheck
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-09-19
- **Last Updated**: 2025-09-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 国际化升级摸排工具包

本工具包旨在帮助开发团队系统性地进行软件国际化升级前的摸排工作，识别系统中需要进行国际化处理的所有文本内容和相关组件。

## 目录结构

```
i18ncheck/
├── README.md           # 工具包说明文档
├── i18n_upgrade_plan.md # 国际化升级摸排方案文档
└── i18n_scanner.py     # 代码库中文字符串扫描工具
```

## 文件说明

### 1. i18n_upgrade_plan.md

这是一个详细的国际化升级摸排方案文档，包含以下主要内容：
- 方案概述和目标
- 摸排范围（前端、后端、其他部分）
- 摸排方法和工具
- 摸排结果记录模板
- 国际化类型分类
- 复杂度评估标准
- 实施步骤建议
- 注意事项
- 常用正则表达式参考
- 国际化改造检查表

该文档提供了一套完整的国际化升级摸排方法论，可作为团队进行国际化升级工作的指导文件。

### 2. i18n_scanner.py

这是一个Python脚本工具，用于自动扫描代码库中的中文字符串，快速识别需要国际化的内容。主要功能包括：
- 支持多种编程语言和文件类型
- 并行扫描提高效率
- 自动检测文件编码
- 智能忽略中文注释（包括行首注释和行内注释）
- 识别不同类型的字符串（双引号、单引号、模板字符串等）
- 评估国际化复杂度
- 生成CSV格式的扫描结果报告
- 支持排除特定目录和文件

## 使用方法

### 1. 使用i18n_upgrade_plan.md

1. 阅读并理解文档中的摸排方法和流程
2. 根据项目实际情况，调整摸排范围和实施步骤
3. 组织团队成员学习方案，明确各自职责
4. 使用文档中的记录模板记录摸排结果

### 2. 使用i18n_scanner.py

#### 前置条件

- 安装Python 3.6或更高版本
- 安装必要的依赖：
  ```
  pip install chardet tqdm
  ```

#### 基本使用

在命令行中运行以下命令：

```bash
# 基本扫描（当前目录）
python i18n_scanner.py

# 指定目录扫描
python i18n_scanner.py -d /path/to/your/project

# 指定输出文件
python i18n_scanner.py -o /path/to/output.csv

# 调整并行工作线程数
python i18n_scanner.py -w 8

# 排除特定模式的文件路径
python i18n_scanner.py -e "test/" "docs/"
```

#### 参数说明

- `-d, --dir`: 要扫描的根目录，默认为当前目录
- `-o, --output`: 输出的CSV文件路径，默认为`i18n_scan_results.csv`
- `-w, --workers`: 并行工作线程数，默认为4
- `-e, --exclude`: 要排除的正则表达式模式，可以指定多个

## 工作流程建议

1. **准备阶段**
   - 团队成员共同学习`i18n_upgrade_plan.md`文档
   - 根据项目需求调整方案内容
   - 安装并配置`i18n_scanner.py`工具

2. **自动化扫描**
   - 使用`i18n_scanner.py`对代码库进行初步扫描
   - 分析生成的CSV报告，了解大致的国际化工作量
   - 根据扫描结果，制定详细的摸排计划

3. **人工摸排**
   - 按照`i18n_upgrade_plan.md`中的方法，对代码库进行人工详细摸排
   - 使用文档中的模板记录所有需要国际化的内容
   - 评估每个国际化点的复杂度和优先级

4. **结果分析与方案制定**
   - 汇总自动化扫描和人工摸排的结果
   - 分析国际化改造的总体工作量和难度
   - 制定详细的国际化改造方案和实施计划

## 注意事项

- `i18n_scanner.py`是一个辅助工具，不能完全替代人工摸排
- 对于动态生成的文本、UI布局适配等问题，需要人工进行分析
- 扫描结果中可能包含一些不需要国际化的中文内容（如注释、日志等），需要人工筛选
- 对于大型项目，建议分模块进行扫描和摸排，以提高效率
- 在进行国际化改造前，建议先进行小范围的试点，验证方案的可行性

## 后续工作建议

- 根据摸排结果，选择合适的国际化框架和工具
- 制定详细的国际化改造实施计划
- 建立国际化资源管理机制
- 对改造后的系统进行多语言测试
- 培训团队成员，确保后续开发遵循国际化规范

## 常见问题

**Q: 如何判断一个中文字符串是否需要国际化？**
A: 一般来说，所有面向用户的文本都需要国际化，包括界面文本、错误消息、提示信息等。而代码注释、日志调试信息、内部配置等非用户可见内容通常不需要国际化。

**Q: 扫描结果中包含大量的第三方库文件怎么办？**
A: 使用`-e`参数排除第三方库目录，如`python i18n_scanner.py -e "node_modules/" "vendor/"`

**Q: 如何处理包含变量的动态文本？**
A: 这类文本通常需要特殊处理，使用国际化框架提供的变量替换功能，详细方法可参考具体的国际化框架文档。

## 许可证

本工具包采用MIT许可证，您可以自由使用、修改和分发。

---

希望本工具包能够帮助您的团队顺利进行国际化升级工作！如有任何问题或建议，欢迎提出反馈。