Que fait indexion-readme ?
Construction de README — initialisation de la structure de modèles, génération de README par paquet à partir de commentaires de documentation, planification des tâches d'écriture, assemblage du README racine à partir de docs/ et des README des paquets via la configuration doc.json, et vérification des modifications avec plan drift.
Vue d'ensemble
Cette compétence automatise la création et la maintenance des fichiers README pour les projets logiciels, en particulier ceux avec plusieurs paquets. Elle permet de garantir que toute la documentation est générée de manière cohérente et reste synchronisée avec le code.
Fonctionnalités
- Initialisation de la structure de modèles : Crée les répertoires et fichiers nécessaires pour un nouveau projet README.
- Génération de README par paquet : Analyse les commentaires de documentation (par exemple, docstrings) dans chaque paquet pour générer automatiquement un README correspondant.
- Planification des tâches d'écriture : Utilise le fichier
doc.jsonpour définir et organiser les tâches de rédaction de documentation. - Assemblage du README racine : Combine le contenu de
docs/et les README des paquets en un seul README racine viadoc.json. - Vérification des modifications : Exécute
plan driftpour détecter tout écart entre le README généré et le code source, garantissant ainsi l'exactitude.
Utilisation
Pour utiliser cette compétence, assurez-vous que la configuration doc.json est présente dans le répertoire racine du projet. Exécutez la commande appropriée (selon l'agent) pour initialiser, générer, ou vérifier les README.
Configuration
Le fichier doc.json doit contenir les paramètres suivants :
packages: Liste des chemins des paquets.docsDir: Chemin vers le répertoire de documentation.outputFile: Chemin du fichier README racine de sortie.
Exemple
{
"packages": ["packages/pkg1", "packages/pkg2"],
"docsDir": "docs",
"outputFile": "README.md"
}
Commandes
plan: Planifie les tâches d'écriture.generate: Génère les README par paquet.assemble: Assemble le README racine.drift(ouplan drift) : Vérifie les modifications.
Dépendances
- Environnement Node.js (v14 ou supérieur).
- Un fichier
doc.jsonvalide dans le répertoire racine.
Dépannage
Si la commande plan drift signale des écarts, vérifiez que les commentaires de documentation dans le code sont à jour et que le fichier doc.json est correctement configuré.
Licence
MIT