update-markdown-file-index

Par github · awesome-copilot

Met à jour une section de fichier Markdown avec un index/table des fichiers d'un dossier spécifié.

npx skills add https://github.com/github/awesome-copilot --skill update-markdown-file-index

Mettre à jour l'index des fichiers Markdown

Mettre à jour le fichier markdown ${file} avec un index/table des fichiers du dossier ${input:folder}.

Processus

  1. Scan : Lire le fichier markdown cible ${file} pour comprendre la structure existante
  2. Découverte : Lister tous les fichiers du dossier spécifié ${input:folder} correspondant au motif ${input:pattern}
  3. Analyse : Identifier si une section table/index existante doit être mise à jour, ou créer une nouvelle structure
  4. Structure : Générer le format de table/liste approprié en fonction des types de fichiers et du contenu existant
  5. Mise à jour : Remplacer la section existante ou ajouter une nouvelle section avec l'index des fichiers
  6. Validation : S'assurer que la syntaxe markdown est valide et la mise en forme cohérente

Analyse des fichiers

Pour chaque fichier découvert, extraire :

  • Nom : Nom du fichier avec ou sans extension selon le contexte
  • Type : Extension de fichier et catégorie (p. ex. .md, .js, .py)
  • Description : Première ligne de commentaire, en-tête, ou objectif déduit
  • Taille : Taille du fichier à titre informatif (optionnel)
  • Modifié : Date de dernière modification (optionnel)

Options de structure de table

Choisir le format en fonction des types de fichiers et du contenu existant :

Option 1 : Liste simple

## Fichiers dans ${folder}

- [filename.ext](path/to/filename.ext) - Description
- [filename2.ext](path/to/filename2.ext) - Description

Option 2 : Tableau détaillé

Fichier Type Description
filename.ext Extension Description
filename2.ext Extension Description

Option 3 : Sections catégorisées

Regrouper les fichiers par type/catégorie avec des sections ou sous-tables séparées.

Stratégie de mise à jour

  • 🔄 Mettre à jour existant : Si une section table/index existe, remplacer le contenu tout en préservant la structure
  • Ajouter nouveau : Si aucune section existante, créer une nouvelle section en utilisant le format le mieux adapté
  • 📋 Préserver : Maintenir la mise en forme markdown existante, les niveaux de titre et le flux du document
  • 🔗 Liens : Utiliser des chemins relatifs pour les liens de fichiers dans le repository

Identification de la section

Rechercher les sections existantes avec ces motifs :

  • En-têtes contenant : « index », « files », « contents », « directory », « list »
  • Tables avec des colonnes liées aux fichiers
  • Listes avec des liens de fichiers
  • Commentaires HTML marquant les sections d'index de fichiers

Exigences

  • Préserver la structure et la mise en forme markdown existantes
  • Utiliser des chemins relatifs pour les liens de fichiers
  • Inclure les descriptions de fichiers quand disponibles
  • Trier les fichiers alphabétiquement par défaut
  • Gérer les caractères spéciaux dans les noms de fichiers
  • Valider la syntaxe markdown générée

Skills similaires