snap2txt

Snap2txt

Snap2txt - это утилита Python, которая отражает структуру и содержание каталога проекта и сохраняет их в текстовом файле. Он предназначен для быстрой документации файловой системы вашего проекта.

Функции

• Полный захват : записывает всю структуру файла и содержимое проекта.
• Настраиваемые фильтры : предложения игнорируют и белые варианты для целевого сканирования.
• Интерфейс командной строки : простой и простой в использовании инструмент командной строки.

Установка

Установите Snap2txt с PIP:

pip install snap2txt

ПРИМЕЧАНИЕ . Теперь установка автоматически предоставляет файлы .il и .wl вместе с пакетом.

Использование

Перейдите в свой каталог проектов и запустите:

snap2txt

По умолчанию Snap2txt сканирует все файлы и каталоги в текущей папке и создаст выходной файл с именем project_contents.txt .

Найдите файлы .il и .wl

Если вам нужно увидеть, где файлы Snap2txt .il и .wl были установлены в вашей системе (например, для их настройки), запустите:

snap2txt --show-locations

Это будет распечатать полный путь к каждому файлу, поэтому вы можете открыть или отредактировать их по мере необходимости.

Дополнительные флаги

• --il : Используйте список игнорировать, определяется в .il .
• --wl : Используйте белый список, определенный в .wl .

Пример:

snap2txt --il

snap2txt --wl

Конфигурация

Snap2txt уважает два файла для фильтрации:

1. Игнорировать список ( .il ) : исключить определенные файлы/каталоги.
2. WhiteList ( .wl ) : включите только определенные файлы/каталоги.

По умолчанию Snap2txt устанавливает базовый .il и .wl в каталоге пакетов. Чтобы адаптировать поведение для вашего проекта, вы можете отредактировать эти файлы или заменить их своими собственными правилами.

Совет : чтобы быстро найти, где были установлены эти файлы, используйте snap2txt --show-locations .

Пример .il

 node_modules/
*.log

Пример .wl файл

 *.py
*.md

Внося

Взносы в Snap2txt приветствуются! Не стесняйтесь раскошелиться, внесите свои изменения и отправляйте запрос на привлечение.

Лицензия

SNAP2TXT-это программное обеспечение с открытым исходным кодом, лицензированное по лицензии MIT.

Поддерживать

Для поддержки, вопросов или обратной связи, пожалуйста, откройте проблему в репозитории GitHub.