CodeWeaver: 코드 구조와 콘텐츠로부터 마크다운 문서를 자동으로 생성합니다.

일반 소개

CodeWeaver는 코드 베이스를 탐색하기 쉬운 하나의 마크다운 문서로 엮도록 설계된 명령줄 도구입니다. 디렉터리를 재귀적으로 스캔하고 각 파일의 내용을 코드 블록에 포함시켜 프로젝트의 파일 계층 구조를 구조적으로 표현합니다. 이 도구는 코드베이스 공유 및 정보 추출을 간소화하기 위한 목적으로 설계되었으며, 특히 AI/ML 코드 분석 도구에서 코드베이스 정보를 처리할 수 있도록 하는 데 적합합니다.

다음은 샘플 생성 예시입니다: https://github.com/tesserato/CodeWeaver/blob/main/codebase.md

기능 목록

• 포괄적인 코드 베이스 문서 생성: 프로젝트의 디렉토리와 파일 구조를 명확한 트리 형식으로 상세히 설명하는 마크다운 파일을 생성합니다.
• 코드 콘텐츠 임베딩: 생성된 마크다운 문서에 각 파일의 전체 내용을 파일 확장자를 기준으로 구문 강조 표시와 함께 포함합니다.
• 유연한 경로 필터링특정 파일 및 디렉터리(예: .git, 빌드 제품, 특정 파일 유형)를 제외할 수 있는 정규식을 사용하여 무시 패턴을 정의합니다.
• 선택적 경로 로깅무시 규칙의 자세한 추적 및 디버깅을 위해 포함 및 제외된 파일 경로의 별도 목록을 파일에 저장하는 옵션입니다.
• 간단한 명령줄 인터페이스: 직관적인 명령줄 인터페이스와 간단한 사용자 지정 옵션을 제공합니다.

도움말 사용

설치 프로세스

Go를 사용하여 설치

Go 언어 환경을 설치한 경우 다음 명령을 실행하여 최신 버전의 CodeWeaver를 설치할 수 있습니다:

go install github.com/tesserato/CodeWeaver@latest

또는 지정된 버전을 설치합니다:

go install github.com/tesserato/CodeWeaver@vX.Y.Z

미리 컴파일된 실행 파일 다운로드

릴리스 페이지에서 미리 컴파일된 적절한 실행 파일을 다운로드하세요.

원하는 경우chmod명령을 사용하여 실행 파일 실행 권한을 부여합니다:

chmod +x codeweaver

사용 프로세스

도움 받기

도움말 정보를 보려면 다음 명령을 실행하세요:

codeweaver -h

실용적인 사용

다음 명령을 실행하여 문서를 생성합니다:

codeweaver [options]

옵션 설명

사용 예

현재 디렉터리에 대한 문서 생성

./codeweaver

이 명령은 현재 디렉터리에 다음과 같은 이름의 파일을 만듭니다.codebase.md파일에 현재 디렉터리와 그 하위 디렉터리의 구조와 내용을 기록합니다(제외는 기본 무시 패턴과 일치).\.git.*(경로)를 입력합니다.

다양한 입력 디렉토리 및 출력 파일 지정

./codeweaver -dir=my_project -output=project_docs.md

이 명령은my_project디렉터리에 문서를 저장하고project_docs.md.

특정 파일 유형 및 디렉터리 무시

./codeweaver -ignore="\.log,temp,build" -output=detailed_docs.md

이 예제에서는 다음을 생성합니다.detailed_docs.md이 포함된 이름을 제외하고.log및temp어쩌면build파일 또는 디렉터리로 구분합니다. 정규식 패턴은 쉼표로 구분됩니다.

포함 및 제외 경로 목록 유지

./codeweaver -ignore="node_modules" -included-paths-file=included.txt -excluded-paths-file=excluded.txt -output=code_overview.md

이 명령은code_overview.md에 포함된 경로 목록을 저장하면서included.txt는 다음과 같은 이유로 인해 발생합니다.node_modules무시 패턴에 의해 제외된 경로 목록은excluded.txt.