snap2txt

snap2txt

Snap2txt는 프로젝트 디렉토리의 구조 및 내용을 캡처하여 텍스트 파일에 저장하는 Python 유틸리티입니다. 프로젝트 파일 시스템의 빠른 문서화를 위해 설계되었습니다.

특징

• 완전한 캡처 : 프로젝트의 전체 파일 구조 및 내용을 기록합니다.
• 사용자 정의 가능한 필터 : 대상 스캔을위한 무시 및 화이트리스트 옵션을 제공합니다.
• 명령 줄 인터페이스 : 간단하고 사용하기 쉬운 명령 줄 도구.

설치

PIP로 Snap2TXT를 설치하십시오.

pip install snap2txt

참고 : 설치는 이제 패키지와 함께 .il 및 .wl 파일을 자동으로 제공합니다.

용법

프로젝트 디렉토리로 이동하여 실행하십시오.

snap2txt

기본적으로 Snap2txt는 현재 폴더의 모든 파일과 디렉토리를 스캔하고 project_contents.txt 라는 출력 파일을 생성합니다.

.il 및 .wl 파일을 찾으십시오

시스템에 Snap2TXT의 .il 및 .wl 파일이 설치된 위치를 확인 해야하는 경우 (예 : 사용자 정의) 실행하십시오.

snap2txt --show-locations

이렇게하면 각 파일에 대한 전체 경로가 인쇄되므로 필요에 따라 열거 나 편집 할 수 있습니다.

선택적 플래그

• --il : .il 에 정의 된 무시 목록을 사용하십시오.
• --wl : .wl 에 정의 된 Whitelist를 사용하십시오.

예:

snap2txt --il

snap2txt --wl

구성

Snap2txt는 필터링을 위해 두 개의 파일을 존중합니다.

1. 목록을 무시하십시오 ( .il ) : 특정 파일/디렉토리를 제외하십시오.
2. 화이트리스트 ( .wl ) : 특정 파일/디렉토리 만 포함합니다.

기본적으로 Snap2txt는 패키지 디렉토리에 기본 .il 및 .wl 설치합니다. 프로젝트의 동작을 조정하려면 해당 파일을 편집하거나 자신의 사용자 정의 규칙으로 바꿀 수 있습니다.

팁 :이 파일이 설치된 위치를 신속하게 찾으려면 snap2txt --show-locations 사용하십시오.

예 .il 파일

 node_modules/
*.log

예 .wl 파일

 *.py
*.md

기여

snap2txt에 대한 기여를 환영합니다! 저장소를 자유롭게 포크하고 변경하고 풀 요청을 제출하십시오.

특허

Snap2txt는 MIT 라이센스에 따라 오픈 소프트웨어 소프트웨어입니다.

지원하다

지원, 질문 또는 피드백은 Github 저장소에서 문제를 열어주십시오.