snap2txt

Snap2txt

Snap2Txt ist ein Python -Dienstprogramm, das die Struktur und den Inhalt eines Projektverzeichnisses erfasst und sie in eine Textdatei speichert. Es wurde für eine schnelle Dokumentation des Dateisystems Ihres Projekts entwickelt.

Merkmale

• Vollständige Capture : Zeichnet die gesamte Dateistruktur und den Inhalt des Projekts auf.
• Anpassbare Filter : Angebote ignorieren und Whitelist -Optionen für gezielte Scannen.
• Befehlszeilenschnittstelle : Einfache und benutzerfreundliche Befehlszeilen-Tool.

Installation

Installieren Sie Snap2TXT mit PIP:

pip install snap2txt

Hinweis : Die Installation bietet jetzt automatisch .il und .wl -Dateien zusammen mit dem Paket.

Verwendung

Navigieren Sie zu Ihrem Projektverzeichnis und führen Sie aus:

snap2txt

Standardmäßig scannt Snap2Txt alle Dateien und Verzeichnisse im aktuellen Ordner und erstellt eine Ausgabedatei namens project_contents.txt .

Suchen Sie die .il- und .wl -Dateien

Wenn Sie sehen müssen, wo die Dateien von Snap2TXTs .il und .wl -Dateien in Ihrem System installiert wurden (z. B. um sie anzupassen), führen Sie aus:

snap2txt --show-locations

Dadurch wird der vollständige Pfad zu jeder Datei gedruckt, sodass Sie sie nach Bedarf öffnen oder bearbeiten können.

Optionale Flaggen

• --il : Verwenden Sie Ignorierliste in .il definiert.
• --wl : Verwenden Sie die in .wl definierte Whitelist.

Beispiel:

snap2txt --il

snap2txt --wl

Konfiguration

SNAP2TXT respektiert zwei Dateien für die Filterung:

1. Ignorieren Sie die Liste ( .il ) : Ausschließen bestimmter Dateien/Verzeichnisse.
2. Whitelist ( .wl ) : Fügen Sie nur bestimmte Dateien/Verzeichnisse ein.

Standardmäßig installiert Snap2Txt im Paketverzeichnis eine einfache .il und .wl . Um das Verhalten für Ihr Projekt anzupassen, können Sie diese Dateien bearbeiten oder durch Ihre eigenen benutzerdefinierten Regeln ersetzen.

Tipp : Um schnell zu finden, wo diese Dateien installiert wurden, verwenden Sie snap2txt --show-locations .

Beispiel .il Datei

 node_modules/
*.log

Beispiel .wl -Datei

 *.py
*.md

Beitragen

Beiträge zu Snap2txt sind willkommen! Fühlen Sie sich frei, das Repository aufzugeben, Ihre Änderungen vorzunehmen und eine Pull -Anfrage einzureichen.

Lizenz

Snap2Txt ist Open-Sourcing-Software, die unter der MIT-Lizenz lizenziert wurde.

Unterstützung

Für Unterstützung, Fragen oder Feedback eröffnen Sie bitte ein Problem im Github -Repository.