snap2txt

Snap2txt

Snap2Txt est un utilitaire Python qui capture la structure et le contenu d'un répertoire de projet et les enregistre dans un fichier texte. Il est conçu pour une documentation rapide du système de fichiers de votre projet.

Caractéristiques

• Capture complète : enregistre toute la structure des fichiers et le contenu du projet.
• Filtres personnalisables : propose des options d'ignore et de liste blanche pour la numérisation ciblée.
• Interface de ligne de commande : outil de ligne de commande simple et facile à utiliser.

Installation

Installez Snap2Txt avec PIP:

pip install snap2txt

Remarque : L'installation fournit désormais automatiquement des fichiers .il et .wl avec le package.

Usage

Accédez à votre répertoire de projet et exécutez:

snap2txt

Par défaut, Snap2Txt analysera tous les fichiers et répertoires dans le dossier actuel et produira un fichier de sortie appelé project_contents.txt .

Localisez les fichiers .il et .wl

Si vous avez besoin de voir où les fichiers .il et .wl de Snap2Txt ont été installés sur votre système (par exemple, pour les personnaliser), exécutez:

snap2txt --show-locations

Cela imprimera le chemin complet de chaque fichier, afin que vous puissiez les ouvrir ou les modifier au besoin.

Drapeaux facultatifs

• --il : Utilisez la liste Ignore définie dans .il .
• --wl : Utilisez la liste blanche définie dans .wl .

Exemple:

snap2txt --il

snap2txt --wl

Configuration

Snap2txt respecte deux fichiers pour le filtrage:

1. Ignore List ( .il ) : exclure certains fichiers / répertoires.
2. Liste blanche ( .wl ) : n'inclure que certains fichiers / répertoires.

Par défaut, Snap2Txt installe un .il et .wl de base dans le répertoire des packages. Pour adapter le comportement de votre projet, vous pouvez modifier ces fichiers ou les remplacer par vos propres règles personnalisées.

Astuce : Pour localiser rapidement où ces fichiers ont été installés, utilisez snap2txt --show-locations .

Exemple de fichier .il

 node_modules/
*.log

Exemple .wl Fichier

 *.py
*.md

Contributif

Les contributions à Snap2Txt sont les bienvenues! N'hésitez pas à alimenter le référentiel, à apporter vos modifications et à soumettre une demande de traction.

Licence

Snap2Txt est un logiciel open procured sous licence MIT.

Soutien

Pour un soutien, des questions ou des commentaires, veuillez ouvrir un problème dans le référentiel GitHub.