ALLER AU CONTENU

Code des standards

Solidity style guide : des règles Solidity que les humains et les agents suivent

Votre code Solidity n’a pas de règles communes : chaque revue rediscute le nommage et la mise en page. Ce guide donne un seul jeu de règles avec des exemples, et les configurations qui les appliquent pour les humains et les agents de code.

Installation

Récupérer le code

curl -O https://raw.githubusercontent.com/Aboudjem/solidity-style-guide/main/.solhint.json
curl -O https://raw.githubusercontent.com/Aboudjem/solidity-style-guide/main/.prettierrc
curl -O https://raw.githubusercontent.com/Aboudjem/solidity-style-guide/main/.editorconfig

Autres façons d’installer

Installer les linters

npm i -D solhint prettier prettier-plugin-solidity

Lint et formatage

npx solhint 'src/**/*.sol'
npx prettier --write 'src/**/*.sol'

Skill Claude Code, depuis un clone

git clone https://github.com/Aboudjem/solidity-style-guide
mkdir -p .claude/skills && cp -r skill .claude/skills/solidity-style-guide

Ce qu’il fait

  • Donne à chaque règle un exemple Yes et un exemple No.
  • Couvre le nommage, la structure, la mise en forme, les commentaires de code, les tests avec Foundry, le gas et la sécurité.
  • Fournit une configuration Solhint, une configuration Prettier, un fichier EditorConfig et un workflow GitHub Actions.
  • Fournit des fichiers de contexte pour les agents de code : AGENTS.md, CLAUDE.md, llms.txt et .cursorrules.
  • Intègre un skill Claude Code qui relit un dépôt d’après le guide.

Comment ça marche

  1. 1. Récupérez les trois fichiers de configuration dans votre projet.
  2. 2. Installez Solhint, Prettier et le plugin Solidity de Prettier en dépendances de développement.
  3. 3. Lancez le lint et le formatage de vos contrats.
  4. 4. En option : copiez le skill dans .claude/skills/, puis appelez-le par son nom dans Claude Code.

Exemple

Les trois commandes du skill dans Claude Code, telles que le README les donne.

/solidity-style-guide:review           # audit without editing
/solidity-style-guide:review --fix     # apply minimal formatting / naming diffs
/solidity-style-guide:apply-config     # copy solhint/prettier/editorconfig

Limites

  • C’est un guide et un jeu de configurations. Ce n’est pas un audit de sécurité, et le guide recommande lui-même des audits externes.
  • Le skill se copie à la main depuis un clone. Le README ne donne pas d’installation en une ligne.
  • Le guide est calé sur une version précise de Solidity. Vérifiez qu’elle correspond à votre compilateur.
Adapté à
Une équipe Solidity, ou un agent de code, qui a besoin d’un seul jeu de règles écrit.
Pas adapté à
Trouver les failles de sécurité d’un contrat : faites appel à un audit.

Questions

Qu’est-ce que le guide de style Solidity ?

C’est un guide de style pratique pour les smart contracts Solidity. Chaque règle a un exemple Yes et un exemple No, et les configurations appliquent les règles.

Comment utiliser le guide de style dans Claude Code ?

Copiez le dossier skill du dépôt dans .claude/skills/solidity-style-guide. Lancez ensuite /solidity-style-guide:review dans Claude Code.

Le guide de style marche-t-il avec Cursor ou Codex ?

Oui. D’après le README, Cursor, Codex et Aider lisent AGENTS.md et .cursorrules dès que les fichiers sont à la racine du dépôt.

Le guide de style Solidity est-il gratuit ?

Oui, il est open source, sous licence MIT.