typoci/spellcheck-action

Typo CI - 拼写检查Action镜像

镜像概述

Typo CI拼写检查Action是一款GitHub Action工具，通过自动化方式检测代码提交及拉取请求中的拼写错误，帮助开发者及时修正拼写问题，保障代码文档与注释的规范性和可读性。

核心功能

1. 支持多语言词典（en、en_GB、de、es、fr等）
2. 可自定义排除文件、文件夹或特定单词
3. 支持检查文件名中的拼写错误
4. 集成开发语言专属词典，优化代码术语识别准确性

使用场景

• GitHub项目集成自动化拼写检查，在提交或PR阶段自动触发
• 团队协作中统一代码拼写规范，减少低级错误
• 开源项目维护者通过工具提升代码文档质量

配置说明

在项目根目录或.github文件夹下创建.typo-ci.yml文件进行配置，示例如下：

yml
# .typo-ci.yml配置示例
---
# 选择语言词典（默认en、en_GB）
dictionaries:
  - en
  - en_GB
# 排除的文件/文件夹
excluded_files:
  - "vendor/**/*"
  - "node_modules/**/*"
  - "*.min.css"
  - "package-lock.json"
# 排除的单词
excluded_words:
  - typoci
# 是否检查文件名拼写
spellcheck_filenames: true

部署示例

在GitHub项目中添加.github/workflows/spellcheck.yml文件启用检查：

yml
name: Typo CI
on:
  push:
    branches-ignore:
      - master
jobs:
  spellcheck:
    name: Typo CI (GitHub Action)
    runs-on: ubuntu-latest
    timeout-minutes: 4
    if: "!contains(github.event.head_commi***ssage, '[ci skip]')"
    steps:
    - name: TypoCheck
      uses: typoci/spellcheck-action@master
      env:
        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}