JS Readability Checker

A lightweight VS Code extension that provides friendly readability warnings for JavaScript functions.

It helps developers spot code that may be hard to understand or maintain, especially in fast-moving projects or AI-generated code.

This extension focuses on readability, not code style or formatting.

Features

JS Readability Checker currently detects:

• Long functions that may be doing too much
• Deeply nested logic that is hard to follow
• Functions with many parameters that reduce clarity

All warnings are shown as gentle suggestions, not errors.

Long Function Warning

Warns when a function becomes quite long and may benefit from being split into smaller pieces.

Example warning:

Readability Status: This function is quite long (78 lines). Splitting it into smaller parts could make it easier to understand.

Too Many Parameters Warning

Warns when a function takes many parameters, which can make it harder to understand and use.

Example warning:

Readability Status: This function takes many parameters (6). Grouping them into an options object could improve clarity.

Deep Nesting Warning

Warns when a function is deeply nested, increasing cognitive load for readers.

Example warning:

Readability Status: This function is deeply nested (7 levels). Flattening the logic may make it easier to follow.

Scope & Design Philosophy

• ✔ JavaScript only (.js)
• ✔ No formatting or style enforcement
• ✔ No configuration required
• ✔ Works alongside ESLint and Prettier
• ✔ Focuses on how easy code is to understand

This extension is designed to assist, not police.

How It Works

• Automatically analyzes JavaScript files on open and save
• Uses AST (Abstract Syntax Tree) analysis
• Shows warnings directly in the editor and Problems panel

No external services. No network calls.

Installation

Install directly from the Visual Studio Code Marketplace.

Search for JS Readability Checker.

Future Improvements

Planned enhancements may include:

• Status bar readability summary
• Additional readability heuristics
• Optional configuration settings

Feedback

Suggestions and feedback are welcome via the Marketplace reviews.