snap2txt

Snap2txt

Snap2txt adalah utilitas Python yang menangkap struktur dan isi direktori proyek dan menyimpannya ke dalam file teks. Ini dirancang untuk dokumentasi cepat sistem file proyek Anda.

Fitur

• Penangkapan Lengkap : Catat seluruh struktur file dan isi proyek.
• Filter yang dapat disesuaikan : Menawarkan opsi abaikan dan daftar putih untuk pemindaian yang ditargetkan.
• Antarmuka baris perintah : Alat baris perintah yang sederhana dan mudah digunakan.

Instalasi

Instal Snap2txt dengan Pip:

pip install snap2txt

Catatan : Instalasi sekarang secara otomatis menyediakan file .il dan .wl bersama dengan paket.

Penggunaan

Arahkan ke direktori proyek Anda dan jalankan:

snap2txt

Secara default, Snap2txt akan memindai semua file dan direktori di folder saat ini dan menghasilkan file output yang disebut project_contents.txt .

Temukan file .il dan .wl

Jika Anda perlu melihat di mana file snap2txt .il dan .wl diinstal pada sistem Anda (misalnya, untuk menyesuaikannya), jalankan:

snap2txt --show-locations

Ini akan mencetak jalur lengkap untuk setiap file, sehingga Anda dapat membuka atau mengeditnya sesuai kebutuhan.

Bendera opsional

• --il : Gunakan daftar abaikan yang didefinisikan dalam .il .
• --wl : Gunakan daftar putih yang didefinisikan dalam .wl .

Contoh:

snap2txt --il

snap2txt --wl

Konfigurasi

Snap2txt menghormati dua file untuk disaring:

1. Abaikan daftar ( .il ) : Kecualikan file/direktori tertentu.
2. WhiteList ( .wl ) : Sertakan hanya file/direktori tertentu.

Secara default, Snap2txt menginstal .il dan .wl di direktori paket. Untuk menyesuaikan perilaku untuk proyek Anda, Anda dapat mengedit file -file itu atau menggantinya dengan aturan khusus Anda sendiri.

Kiat : Untuk dengan cepat menemukan di mana file-file ini diinstal, gunakan snap2txt --show-locations .

Contoh file .il

 node_modules/
*.log

Contoh file .wl

 *.py
*.md

Berkontribusi

Kontribusi ke Snap2txt dipersilakan! Jangan ragu untuk membayar repositori, membuat perubahan Anda, dan mengirimkan permintaan tarik.

Lisensi

Snap2txt adalah perangkat lunak bersumber terbuka yang dilisensikan di bawah lisensi MIT.

Mendukung

Untuk dukungan, pertanyaan, atau umpan balik, silakan buka masalah di repositori GitHub.