Talibabtou/types-constants-audit-skill

Que fait types-constants-audit-skill ?

Compétence Codex pour auditer l'organisation des types et constantes TypeScript dans les dépôts web.

Description

Cette compétence permet à l'agent Codex d'analyser la structure des fichiers TypeScript dans un projet web, en se concentrant sur la déclaration des types et des constantes. Elle génère un rapport d'audit pour aider les développeurs à maintenir une base de code propre et organisée.

Utilisation

1. Exécutez la compétence sur votre dépôt : codex audit-types-constants
2. Consultez le rapport généré pour voir les recommandations.

Règles d'audit

• Types : doivent être déclarés dans des fichiers .types.ts dans un dossier types/.
• Constantes : doivent être définies dans des fichiers .constants.ts dans un dossier constants/.
• Chaque dossier doit avoir un fichier index.ts pour réexporter les membres.
• Évitez de mélanger types et constantes dans un même fichier.

Exemple de sortie

{
  "conforme": true,
  "fichiers_audites": 10,
  "problemes": [
    {
      "fichier": "src/utils/types.ts",
      "type": "types_et_constantes_melanges",
      "description": "Le fichier contient à la fois des types et des constantes."
    }
  ]
}

Personnalisation

Vous pouvez modifier les règles d'audit en créant un fichier .auditrc.json à la racine du projet.

{
  "dossiers": ["types", "constants"],
  "extensions": [".types.ts", ".constants.ts"]
}

Contribution

Les contributions sont les bienvenues ! Consultez le dépôt GitHub pour plus d'informations.