solidity-style-guide

name	solidity-style-guide
description	Apply the Aboudjem/solidity-style-guide rules to Solidity code — review, rewrite, or audit for naming, layout, formatting, NatSpec, custom errors, ERC-7201 storage, gas patterns, and Foundry test structure. Trigger when the user asks to "review Solidity style", "apply the style guide", "format .sol file", or mentions Solhint / Prettier / Foundry conventions in a Solidity repo. Use when this capability is needed.
metadata	{"author":"Aboudjem"}

Solidity Style Guide — Claude Code Skill

Use this skill whenever you are reviewing or writing Solidity, Foundry tests, or related configuration. It codifies the rules in Aboudjem/solidity-style-guide targeting Solidity 0.8.34.

When to invoke

Trigger automatically on:

• .sol files in the workspace
• foundry.toml, remappings.txt, .solhint.json present
• User says: review my contract, clean up this Solidity, apply the style guide, is this gas-optimal?, make this audit-ready

Output contract

1. Produce a checklist of violations grouped by category (layout → naming → formatting → NatSpec → best practices → tests → gas → security).
2. Quote the offending snippet with file path and line number.
3. Propose a minimal diff that makes it compliant. Preserve behavior; style changes only unless asked.
4. Cite the rule inline, e.g., [§Best Practices > Using Custom Errors Over Require].