Solidity Style Guide Compliance Checker

WHAT IT DOES

This tool connects to your EVM wallet and checks smart contract source code for compliance with the Solidity style guide. It analyzes naming conventions (functions, variables, constants, events), visibility specifiers, function ordering, and comment practices. The tool identifies style violations and provides suggestions for improvement, helping developers maintain consistent and readable code across their projects.

HOW TO USE

Connect your Web3 wallet using the Connect button. Paste your contract source code in the Contract Source Code field. Click "Check Style" to analyze the code against Solidity style guide rules. Click "Load Sample" to populate fields with an example contract containing various style issues. Results appear in the Results card with a summary of lines checked, issues found, and compliance status, followed by a detailed list of each issue with the rule violated, line number, and suggested fix.

TECHNICAL MECHANISM: STYLE GUIDE RULE ENFORCEMENT VIA PATTERN MATCHING

The tool uses regular expression pattern matching to analyze contract source code against a set of style guide rules. It checks for: internal/private functions starting with underscores (recommended by the style guide), constants in UPPER_CASE, explicit visibility modifiers on all functions, event naming conventions, and proper ordering of modifiers before returns. The tool scans the source code line by line, identifying potential violations and categorizing them by severity (error, warning, info). Each finding includes the line number, rule description, and a concrete suggestion for remediation. The compliance status is calculated based on the presence of errors vs. warnings vs. informational issues.

WHAT IT CANNOT SEE

This tool cannot enforce style preferences that are subjective or project-specific—it focuses on widely accepted conventions but cannot account for team-specific rules. It cannot detect style violations in compiled bytecode or minified code—the tool only analyzes source code. It cannot automatically fix style issues—the tool identifies problems but does not modify code. It relies on source code parsing and may produce false positives for unusual but valid patterns—some code may violate rules intentionally. It cannot check documentation completeness or semantic correctness—the tool only checks style, not content. It cannot enforce style rules that require human judgment—some style decisions are best made by developers.

PLEASE NOTE

This is a read-only tool—it never signs transactions. All data is processed in-memory and never persists. The tool supports EVM chains only—Ethereum, Polygon, BSC, Arbitrum, Optimism, Avalanche, Base, and Fantom. The style guide rules are based on Solidity's official style guide and common best practices—adapt to your project's preferences. The tool is a starting point for style review and should be complemented by code reviews and team discussions.