imunew/typos-cli

typos-cli

镜像概述和主要用途

该镜像为https://github.com/crate-ci/typos%E5%B7%A5%E5%85%B7%E7%9A%84Docker%E5%8C%96%E7%89%88%E6%9C%AC%EF%BC%8C%E6%8F%90%E4%BE%9B%E5%AE%B9%E5%99%A8%E5%8C%96%E7%9A%84%E6%8B%BC%E5%86%99%E6%A3%80%E6%9F%A5%E5%8A%9F%E8%83%BD%EF%BC%8C%E5%8F%AF%E7%94%A8%E4%BA%8E%E6%A3%80%E6%B5%8B%E4%BB%A3%E7%A0%81%E3%80%81%E6%96%87%E6%A1%A3%E7%AD%89%E6%96%87%E6%9C%AC%E4%B8%AD%E7%9A%84%E6%8B%BC%E5%86%99%E9%94%99%E8%AF%AF%E3%80%82

核心功能和特性

• 基于crate-ci/typos工具构建，提供高效的拼写检查能力
• 容器化部署，无需本地安装依赖，简化使用流程
• 支持多种输出格式，如JSON等

使用场景和适用范围

适用于需要在容器环境中对代码库、文档项目进行拼写检查的场景，尤其适合CI/CD流程集成或多环境一致性检查。

使用方法和配置说明

使用Docker运行

bash
$ docker run --rm -t -v "/path/to/app:/app" imunew/typos-cli /app --format json

• --rm：容器退出后自动删除
• -t：分配伪终端
• -v "/path/to/app:/app"：将本地应用目录挂载到容器内的/app目录
• /app：指定要检查的目录路径
• --format json：指定输出格式为JSON

使用Docker Compose运行

创建docker-compose.yml配置文件：

yaml
# docker-compose.yml
typos-cli:
  image: imunew/typos-cli
  volumes:
    - /path/to/app:/app:cached

运行命令：

bash
$ docker compose run --rm typos-cli /app --format json

• volumes：将本地应用目录挂载到容器内的/app目录，cached选项优化文件系统性能
• docker compose run --rm：运行服务并在完成后删除容器