CodeWeaver : génère automatiquement des documents Markdown à partir de la structure et du contenu du code.

Introduction générale

CodeWeaver est un outil en ligne de commande conçu pour tisser une base de code dans un document Markdown unique et facile à naviguer. Il génère une représentation structurée de la hiérarchie des fichiers d'un projet en parcourant récursivement les répertoires et en intégrant le contenu de chaque fichier dans des blocs de code. L'outil est conçu dans le but de simplifier le partage de la base de code et l'extraction d'informations, et il est particulièrement bien adapté pour mettre les informations de la base de code à la disposition des outils d'analyse de code AI/ML en vue de leur traitement.

Voici un exemple de génération : https://github.com/tesserato/CodeWeaver/blob/main/codebase.md

Liste des fonctions

• Génération d'une documentation complète de la base de codeGénérer un fichier Markdown détaillant la structure des répertoires et des fichiers du projet sous la forme d'une arborescence claire.
• Code Content EmbeddingLe contenu intégral de chaque fichier est intégré dans le document Markdown généré, avec mise en évidence de la syntaxe en fonction de l'extension du fichier.
• Filtrage flexible des trajetsLes modèles d'ignorance : Définir des modèles d'ignorance à l'aide d'expressions régulières pour permettre l'exclusion de fichiers et de répertoires spécifiques (par exemple, .git, produits de construction, types de fichiers spécifiques).
• Enregistrement facultatif des itinérairesOption permettant d'enregistrer dans un fichier des listes distinctes de chemins d'accès aux fichiers inclus et exclus, afin d'assurer un suivi détaillé et un débogage des règles d'ignorance.
• Interface de ligne de commande simpleLe système de gestion de l'information est une interface de ligne de commande intuitive dotée d'options de personnalisation directes.

Utiliser l'aide

Processus d'installation

Installation avec Go

Si vous avez installé l'environnement de langage Go, vous pouvez exécuter la commande suivante pour installer la dernière version de CodeWeaver :

go install github.com/tesserato/CodeWeaver@latest

Ou installer la version spécifiée :

go install github.com/tesserato/CodeWeaver@vX.Y.Z

Télécharger l'exécutable pré-compilé

Téléchargez l'exécutable précompilé approprié à partir de la page de publication.

Si vous le souhaitez, vous pouvez utiliser lechmodpour donner au fichier exécutable l'autorisation d'exécution :

chmod +x codeweaver

Processus d'utilisation

Obtenir de l'aide

Exécutez la commande suivante pour obtenir des informations d'aide :

codeweaver -h

utilisation pratique

Exécutez la commande suivante pour générer le document :

codeweaver [options]

Description des options

exemple d'utilisation

Générer la documentation pour le répertoire courant

./codeweaver

Cette commande crée un fichier dans le répertoire actuel nommécodebase.mdqui enregistre la structure et le contenu du répertoire actuel et de ses sous-répertoires (exclure correspond au motif d'exclusion par défaut).\.git.*(le chemin).

Spécifier différents répertoires d'entrée et fichiers de sortie

./codeweaver -dir=my_project -output=project_docs.md

Cette commande traitera lemy_projectet enregistrer le document dans le répertoireproject_docs.md.

Ignorer certains types de fichiers et de répertoires

./codeweaver -ignore="\.log,temp,build" -output=detailed_docs.md

L'exemple génèredetailed_docs.mdà l'exclusion de tout nom contenant.log,temppeut-êtrebuildde fichiers ou de répertoires. Les motifs des expressions régulières sont séparés par des virgules.

Conserver une liste des chemins inclus et exclus

./codeweaver -ignore="node_modules" -included-paths-file=included.txt -excluded-paths-file=excluded.txt -output=code_overview.md

Cette commande créera le fichiercode_overview.mdtout en sauvegardant la liste des chemins inclus dans le fichierincluded.txtsera due ànode_modulesLa liste des chemins exclus par le motif d'ignorance est enregistrée dans le fichierexcluded.txt.