typo-checker

Run typos-cli to identify and fix typos in a codebase.

1|Updated May 28, 2024

Search Tags:#automation #codebase #quality-assurance #lint #typos #spell-check #typos-cli

Ready to run

npx skills add https://github.com/zhcndoc/vitest --skill typo-checker-zhcndoc

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: typo-checker
Source: https://github.com/zhcndoc/vitest/tree/main/.claude/skills/typo-checker
Command: npx skills add https://github.com/zhcndoc/vitest --skill typo-checker-zhcndoc

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Run typos-cli to identify typos in the codebase and documentation, enabling timely fixes and a cleaner repository.

Core Features & Use Cases

Scan the repository for common misspellings with typos-cli and categorize findings.
Recommend fixes and automatically update _typos.toml to suppress known false positives.

Quick Start

Run typos-cli on the codebase to identify real typos, fix them, and update the _typos.toml configuration to suppress false positives.

Frequently Asked Questions about typo-checker

High-intent search queries and answers about installing and using this skill.

FAQPage Schema

How do I scan my codebase for typos and fix them?▼

You can scan your codebase for typos by running typos-cli to identify misspellings, categorizing the findings, and applying recommended fixes to maintain a clean repository.

What is the best way to handle false positives during spell checks in code?▼

The best way to handle false positives during spell checks is to update the _typos.toml configuration file to suppress known false positives, ensuring that future scans only report real typos.

Do I need typos-cli installed to check for misspellings in my project?▼

Yes, you need typos-cli installed to check for misspellings in your project, as this Skill requires the typos-cli tool to run scans and generate the findings needed for routine codebase hygiene.

When should I run a spell check on my software project?▼

You should run a spell check on your software project during routine codebase hygiene, ongoing maintenance, and pre-release quality checks to identify and fix typos before deployment.

Can I use this approach to clean up documentation typos as well as code?▼

Yes, you can use this approach to clean up documentation typos as well as code, because the tool runs typos-cli across the repository to identify typos in both the codebase and documentation.