code-scan

Analyze codebase text for grammar, spelling, clarity, and consistency issues.

3|1|Updated Apr 18, 2021

Search Tags:#code quality #code review #documentation #text analysis #linter #spell check

Ready to run

npx skills add https://github.com/nashgao/mqtt-client --skill code-scan-nashgao

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: code-scan
Source: https://github.com/nashgao/mqtt-client/tree/main/.claude/skills/code/scan
Command: npx skills add https://github.com/nashgao/mqtt-client --skill code-scan-nashgao

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

This Skill addresses the critical need for thorough text quality analysis across an entire codebase, ensuring clarity, correctness, and consistency in all textual elements.

Core Features & Use Cases

Deep Text Analysis: Scans comments, documentation, variable names, string literals, and error messages for issues.
Issue Categorization: Classifies detected problems by severity (critical, high, medium, low) for prioritized action.
Use Case: Before a major release, use this Skill to identify and fix any unclear variable names, grammatical errors in documentation, or potentially misleading error messages, thereby improving code maintainability and user experience.

Quick Start

Run a comprehensive text analysis on the current project directory.

Frequently Asked Questions about code-scan

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

FAQPage Schema

How do I scan my codebase for spelling and grammar errors in comments and documentation?▼

You can scan for spelling and grammar errors by running a deep multi-agent text analysis across your entire codebase, which categorizes identified clarity and consistency issues by severity to generate an actionable report.

What is codebase text analysis and how does it improve code quality?▼

Codebase text analysis is a deep multi-agent scan of comments, identifiers, and string literals for grammar, spelling, clarity, and consistency. It improves code quality by generating a detailed, actionable report to fix misleading text.

Can I check variable names and string literals for clarity and consistency issues?▼

Yes, you can check variable names and string literals for clarity and consistency. The text analysis scans these elements across the entire codebase to identify grammar and spelling issues, categorizing them by severity for action.

How are identified code text issues prioritized for code review?▼

Identified code text issues are prioritized by categorizing them into critical, high, medium, and low severity levels. This classification helps you focus on the most impactful clarity and consistency problems first.

Does the text analysis tool work without external dependencies?▼

Yes, the text analysis tool works without external dependencies. It uses internal scripts to perform a comprehensive multi-agent scan of your project directory, ensuring a self-contained environment for analyzing code text quality.