dral3x/stringslint

StringsLint Docker镜像文档

镜像概述

本镜像基于norionomura/swift构建，集成了StringsLint工具。StringsLint是一款针对iOS/macOS开发的字符串文件检查工具，旨在帮助开发者识别和修复国际化资源文件（如.strings、.stringsdict）中的常见问题，提升应用国际化质量。

核心功能与特性

• 多类型检查：支持检测重复字符串键、未使用字符串、格式占位符不匹配、无效转义字符等问题
• Swift环境依赖：基于官方Swift镜像构建，确保工具运行环境一致性
• 轻量级设计：仅包含StringsLint核心功能及必要依赖，镜像体积优化
• 灵活配置：支持通过配置文件自定义检查规则和忽略项

使用场景

• iOS/macOS项目开发中对国际化字符串文件的日常检查
• 持续集成(CI)流程中集成，作为代码提交前的自动化检查环节
• 团队协作中统一字符串资源检查标准，减少人工审核成本
• 项目重构或国际化资源迁移时的批量问题识别

使用方法

基本使用

通过docker run命令挂载项目目录并执行检查：

bash
docker run --rm -v /path/to/your/project:/workspace stringslint-image stringslint /workspace/Resources

• /path/to/your/project：本地项目目录绝对路径
• /workspace/Resources：容器内项目资源目录路径（包含.strings文件）

指定配置文件

如需使用自定义配置（如.stringslint.yml），可将配置文件挂载到容器内：

bash
docker run --rm \
  -v /path/to/your/project:/workspace \
  -v /path/to/.stringslint.yml:/root/.stringslint.yml \
  stringslint-image \
  stringslint /workspace/Resources --config /root/.stringslint.yml

生成检查报告

支持输出多种格式报告（如JSON、CSV）：

bash
docker run --rm -v /path/to/your/project:/workspace stringslint-image \
  stringslint /workspace/Resources --reporter json > stringslint-report.json

常用参数说明

配置文件示例（.stringslint.yml）

yaml
excluded:
  - "**/Pods/**"
  - "**/Carthage/**"
rules:
  duplicate_key: warning
  unused_key: error
  invalid_escape_sequence: error
  placeholder_mismatch: error