Spellchecker CLI 使用教程

Spellchecker CLI 使用教程

spellchecker-cli A command-line tool for spellchecking files. 项目地址: https://gitcode.com/gh_mirrors/sp/spellchecker-cli

1. 项目介绍

Spellchecker CLI 是一个基于 retext 和 remark 构建的命令行工具，用于检查文件中的拼写错误。它支持多种英语变体（如美式英语、英式英语等），并且可以自定义词典来处理项目特定的术语。该工具特别适合在开源项目中使用，帮助贡献者在提交代码前捕捉文档中的拼写错误。

2. 项目快速启动

安装

你可以通过以下命令全局安装 Spellchecker CLI：

npm install --global spellchecker-cli

或者，如果你希望在项目中作为开发依赖安装：

npm install --save-dev spellchecker-cli

使用

安装完成后，你可以通过以下命令运行 Spellchecker CLI：

spellchecker --files '**/*.md'

该命令会检查当前目录及其子目录下所有 Markdown 文件中的拼写错误。

3. 应用案例和最佳实践

应用案例

Spellchecker CLI 可以作为 Git 钩子或 CI/CD 流程的一部分，帮助开源项目在文档提交前自动检查拼写错误。例如，你可以在 pre-commit 钩子中配置 Spellchecker CLI，确保每次提交前文档都经过拼写检查。

最佳实践

1. 自定义词典：使用 --dictionaries 选项指定项目特定的词典文件，以避免误报项目特有的术语。
2. 忽略特定文件：使用 --ignore 选项忽略不需要检查的文件或目录。
3. 集成到 CI/CD：将 Spellchecker CLI 集成到 CI/CD 流程中，确保每次代码合并前文档都经过拼写检查。

4. 典型生态项目

GitHub Actions

Spellchecker CLI 可以与 GitHub Actions 集成，实现自动化的拼写检查。你可以使用 tbroadley/spellchecker-cli-action 这个 GitHub Action 来简化集成过程。

以下是一个示例工作流定义：

name: Spellcheck

on: [push]

jobs:
  spellcheck:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - uses: tbroadley/spellchecker-cli-action@v1
        with:
          files: '**/*.md'
          language: 'en-US'

这个工作流会在每次推送时自动检查所有 Markdown 文件中的拼写错误。

spellchecker-cli A command-line tool for spellchecking files. 项目地址: https://gitcode.com/gh_mirrors/sp/spellchecker-cli