Skill d'examen d'API

Ce skill examine le code par rapport aux directives canoniques de conception d'API.

Instructions

1. Charger les directives : Lisez les directives de conception d'API depuis references/canonical_api_design.md pour vous assurer qu'elles sont entièrement disponibles dans le contexte.
2. Identifier la cible : Identifiez le code à examiner.
   • Si l'utilisateur a spécifié des fichiers (par ex. « examinez main.dart »), utilisez ceux-ci.
   • Si l'utilisateur a un fichier ouvert dans son contexte, supposez que c'est la cible.
   • Sinon, demandez à l'utilisateur de spécifier les fichiers cibles.
3. Analyser : Pour chaque fichier cible, effectuez une analyse approfondie par rapport aux « Fondements des principes de conception d'API canoniques » (chargés à l'étape 1), en cherchant spécifiquement :
   • Contract-First : L'interface est-elle claire et découplée de l'implémentation ?
   • KISS/YAGNI : Y a-t-il des paramètres inutiles ou des fonctionnalités sur-généralisées ?
   • Ergonomie : Les noms révèlent-ils l'intention ? Suivent-ils le principe de moindre surprise ?
   • CQS : Les commandes et requêtes sont-elles séparées ?
   • Sécurité : Les types sont-ils utilisés strictement (Énums vs Chaînes) ? La validation est-elle visible ?
   • Configuration explicite : Les dépendances sont-elles explicitement injectées plutôt que résolues implicitement via l'état global, des registres ou des variables d'environnement ?
4. Rapport : Générez un rapport structuré :
   • Score : Donnez une note alphabétique (A-F) basée sur l'alignement.
   • Problèmes critiques : Violations qui doivent être corrigées (par ex. problèmes graves de strictitude ou de sécurité).
   • Suggestions : Améliorations ergonomiques (renommage, réorganisation).
   • Exemples de code : Fournissez des blocs de code avant vs après pour les améliorations suggérées.
   • Enregistrez le rapport sous forme d'artifact markdown dans le répertoire des artifacts de conversation (par ex. <appDataDir>/brain/<conversation-id>/api_review_results.md).