功能描述

Detect and automatically fix spelling errors in Markdown, plain text, and documentation files with support for custom dictionaries and batch processing.

使用说明 (SKILL.md)

Document Spell Check Skill

Name: Document Spell Check
Author: linux2010

Purpose

Automatically detect and fix spelling errors in documentation files across any project. This skill provides comprehensive spell checking for Markdown, plain text, and other documentation formats.

Features

1. Multi-Format Support

Markdown files (.md, .mdx)
Plain text files (.txt)
Documentation directories (recursive scanning)
Specific file patterns (glob support)

2. Comprehensive Error Detection

Common misspellings (recieve → receive, teh → the)
Word form errors (formating → formatting, occured → occurred)
Contextual spelling mistakes
Custom dictionary support for technical terms

3. Automated Fixing

Interactive correction suggestions
Batch auto-fix for common patterns
Safe dry-run mode to preview changes
Git integration for clean commits

4. Integration Capabilities

Works with existing project structures
Respects .gitignore and excluded paths
Configurable severity levels
CI/CD compatible output format

Usage

Basic Commands

# Check single file
doc-spellcheck check docs/guide.md

# Check entire directory  
doc-spellcheck check docs/

# Auto-fix common errors
doc-spellcheck fix docs/guide.md

# Dry-run to preview fixes
doc-spellcheck fix --dry-run docs/

Advanced Options

# Custom dictionary
doc-spellcheck check --dict custom-words.txt docs/

# Exclude patterns
doc-spellcheck check --exclude "**/node_modules/**" docs/

# Specific error types
doc-spellcheck check --errors "misspelling,word-form" docs/

# Output format for CI
doc-spellcheck check --format json docs/

Implementation Details

Core Dependencies

Aspell: Primary spell checking engine
Custom word lists: Project-specific terminology
File system walker: Efficient directory traversal
Git integration: Safe commit management

Error Categories

Basic Misspellings: Common typos and transpositions
Word Form Errors: Incorrect verb/noun forms
Technical Terms: Domain-specific vocabulary validation
Contextual Errors: Words that are spelled correctly but used incorrectly

Safety Measures

Backup creation: Automatic file backups before fixing
Atomic operations: Changes applied as single git commits
Rollback support: Easy revert of applied fixes
Permission checks: Respects file system permissions

Workflow Integration

Local Development

Run spell check before committing changes
Use interactive mode for manual review
Add custom dictionaries for project terminology

CI/CD Pipeline

Integrate as pre-commit hook
Fail builds on critical spelling errors
Generate reports for documentation quality metrics

Team Collaboration

Shared custom dictionaries across team members
Consistent terminology enforcement
Automated documentation quality gates

Configuration

Default Settings

File extensions: .md, .mdx, .txt, .rst
Excluded paths: node_modules/, .git/, dist/
Severity level: warning (non-blocking)
Auto-fix: disabled by default

Customization Options

Language selection (en-US, en-GB, etc.)
Custom ignore lists
Severity thresholds
Output verbosity levels

Best Practices

For Maintainers

Run comprehensive checks before major releases
Maintain project-specific dictionaries
Document accepted terminology variations
Set up automated CI checks

For Contributors

Check spelling before submitting PRs
Use consistent terminology
Respect project style guides
Include new terms in dictionaries when appropriate

Examples

Fixing Common Errors

# Before: "The recieve function handles incoming data"
# After:  "The receive function handles incoming data"

# Before: "This occured during the formating process"  
# After:  "This occurred during the formatting process"

Batch Processing

# Process entire documentation directory
doc-spellcheck fix --batch docs/

# Review changes interactively
doc-spellcheck fix --interactive docs/guide.md

Limitations

Known Constraints

Cannot detect contextually incorrect but correctly spelled words without AI
May flag technical terms as errors without custom dictionaries
Performance impact on very large documentation sets
Requires proper language pack installation

Workarounds

Use custom dictionaries for technical terminology
Combine with grammar checking tools for comprehensive validation
Run incrementally on large projects
Pre-install required language packs in CI environments

Maintenance

Updates

Regular dictionary updates for new terminology
Engine version upgrades for improved accuracy
Pattern library expansion based on common errors
Performance optimizations for large-scale usage

Monitoring

Track false positive rates
Monitor performance metrics
Collect user feedback on suggestions
Maintain compatibility with documentation standards

安全使用建议

This skill is a simple spellchecker script but the documentation overstates features. Before installing or running it: 1) Inspect the script yourself (it will traverse directories and modify files in fix mode). 2) Run only in 'check' or '--dry-run' initially and test on a small copy of your repo. 3) Be aware the script will try to install aspell automatically via brew or sudo apt-get (it may prompt for a password); do not run with elevated privileges unless you trust and reviewed the code. 4) Note the script's sed commands and usage of 'sed -i ''', and word-boundary usage, may be incompatible with your platform (macOS vs GNU sed) and the naive regex replacements may behave unexpectedly—verify behavior on sample files. 5) The SKILL.md promises git commits, rollback, .gitignore respect, and richer integrations that are not implemented; if you need those features, do not rely on this script without modifying it. If you want to proceed, run the tool in dry-run, commit your repository first, or run against a copy until you are satisfied with its behavior.

功能分析

Type: OpenClaw Skill Name: doc-spellcheck Version: 1.0.0 The skill is designed for document spell checking, and its `SKILL.md` does not contain any prompt injection attempts. However, the `scripts/doc-spellcheck.sh` script attempts to install the `aspell` dependency using `sudo apt-get install aspell` on Linux systems. While intended for convenience, this requires elevated privileges and introduces a supply-chain risk, as a compromised `aspell` package or package repository could lead to arbitrary code execution with root privileges. This capability, despite its benign intent, elevates the classification to suspicious due to the inherent security risk of unverified `sudo` package installations.

能力评估

ℹ Purpose & Capability

The stated purpose (spell checking/fixing Markdown and text files) aligns with the script's functionality (aspell-based checks, simple auto-fixes). However SKILL.md promises additional features — Git atomic commits, rollbacks, respecting .gitignore, comprehensive contextual fixes, CI-friendly output, and extensive integration options — that are not implemented in the provided scripts. The README-level claims are therefore disproportionate to the actual code.

⚠ Instruction Scope

The bash script recursively scans and can modify files (fix mode). It also attempts to auto-install aspell using brew or sudo apt-get, which requires package management and potentially sudo credentials. The SKILL.md claims to 'respect .gitignore' and provide 'atomic git commits' and rollback support, but the script does not read .gitignore, does not perform any git operations, and only uses a temporary file/cp/mv for basic backup—so the documented runtime behavior and actual instructions diverge. The script will modify files in-place unless --dry-run is used, so running it without review risks unintended changes.

ℹ Install Mechanism

There is no formal install spec, but the script attempts an in-band install of aspell at runtime via brew or sudo apt-get. This is an implicit install mechanism that invokes system package managers (and sudo) — higher-risk than pure instruction-only behavior because it may prompt for credentials and change system state.

✓ Credentials

The skill does not request environment variables, credentials, or config paths. No secrets are required. The script uses standard filesystem and calls to system utilities only.

✓ Persistence & Privilege

always is false and the skill does not request persistent system-wide configuration or attempt to modify other skills. It does not register itself or require permanent presence.

版本历史

v1.0.0

Initial release of doc-spellcheck. - Automatically detects and fixes spelling errors in Markdown, text, and documentation files. - Supports batch processing, custom dictionaries, and integrates with Git. - Offers interactive and dry-run modes for safe correction preview. - Easily integrates into CI/CD pipelines and respects project structure and .gitignore. - Configurable error types, severity levels, and output formats for flexible workflows.

元数据

Slug doc-spellcheck

版本 1.0.0

许可证 —

累计安装 2

当前安装数 2

历史版本数 1

常见问题

Document Spell Check 是什么？

Detect and automatically fix spelling errors in Markdown, plain text, and documentation files with support for custom dictionaries and batch processing. 它是一个面向 Claude Code / OpenClaw 的 AI Agent Skill 插件，目前累计下载 435 次。

如何安装 Document Spell Check？

在 OpenClaw 或 Claude Code 对话框中运行命令「/install doc-spellcheck」即可一键安装，无需额外配置。

Document Spell Check 是免费的吗？

是的，Document Spell Check 完全免费（开源免费），可自由下载、安装和使用。

Document Spell Check 支持哪些平台？

Document Spell Check 跨平台运行，可在任意部署了 OpenClaw / Claude Code 的环境中使用（cross-platform）。

谁开发了 Document Spell Check？

由 Andy Tien（@linux2010）开发并维护，当前版本 v1.0.0。

Document Spell Check