콘텐츠로 이동

시작하기

이 튜토리얼에서는 codeknit을 소스로부터 빌드하고, 첫 번째 파싱을 실행하며, 작성된 .skt 출력을 읽게 됩니다. codeknit 저장소의 작은 패키지를 파싱하므로 자신의 프로젝트가 필요하지 않습니다.

  • Go 1.26 이상. go version을 실행하여 확인하세요.
  • C 컴파일러. codeknit은 tree-sitter를 사용하며, 이는 CGo가 필요합니다.
  • Git 및 Make.

저장소를 클론하고 빌드합니다:

터미널 창
git clone https://github.com/awslabs/codeknit.git
cd codeknit
make build

빌드가 오류 없이 완료되고, ./bin/codeknit에 바이너리가 생성되는 것을 확인해야 합니다.

codeknit 디렉토리에서 bin을 PATH에 추가합니다. 사용 중인 셸에 맞는 명령을 사용하세요.

bash 또는 zsh의 경우:

터미널 창
export PATH="$PATH:$(pwd)/bin"

fish의 경우:

터미널 창
fish_add_path (pwd)/bin

이 명령은 현재 bash 또는 zsh 세션에만 적용됩니다. 이후 세션에서도 유지하려면 동일한 명령을 ~/.bashrc 또는 ~/.zshrc에 추가하되, $(pwd)/bin 대신 bin의 절대 경로를 사용하세요.

터미널 창
codeknit --version

codeknit 버전이 출력되는 것을 확인해야 합니다.

codeknit 디렉토리에 머무르며 internal/console 패키지를 파싱합니다:

터미널 창
codeknit parse ./internal/console --edges

codeknit은 디렉토리를 스캔하고, 지원되는 각 소스 파일을 파싱한 후 .skt 파일을 작성합니다. .skt 파일은 코드의 심볼과 심볼 간의 관계를 나열하는 간결한 텍스트 파일입니다. --edges 플래그는 관계를 추가합니다. 기본적으로는 공간을 절약하기 위해 생략됩니다.

명령이 완료되면 간단한 요약이 표시되고, 현재 디렉토리에 새로운 ./skeleton 디렉토리가 생성됩니다.

출력 목록을 확인합니다:

터미널 창
ls ./skeleton

map_001.skt와 같은 파일이 표시됩니다.

파일을 엽니다:

터미널 창
cat ./skeleton/map_001.skt

먼저 [symbols] 섹션이 표시됩니다. 심볼은 함수, 타입 또는 필드와 같은 코드의 명명된 항목입니다. 심볼은 ## <소스 파일> 헤딩 아래 그룹화됩니다. 다음과 같은 출력이 포함됩니다:

[symbols]
## <path to>/console.go
S1 module/package L5-L5 console
S2 type/struct L17-L25 Console {exported}
...
S10 callable/function L28-L41 New() -> *S2 {exported}
...
S12 callable/method L49-L49 Error(msg: string) {exported, receiver=*Console}

각 줄은 동일한 부분을 포함합니다:

부분 예시 의미
Short ID S10 출력에서 다른 곳에서 사용되는 심볼의 짧은 레이블
카테고리 및 종류 callable/function 심볼의 종류
행 범위 L28-L41 소스 파일에서 심볼이 포함된 행
시그니처 New() -> *S2 이름, 매개변수 및 반환 타입
속성 {exported} 중괄호 안의 추가 세부 정보

New() -> *S2에서 S2는 Console 타입의 Short ID입니다. codeknit은 심볼을 알면 타입 이름을 Short ID로 대체합니다. 체크아웃 버전에 따라 행 번호가 약간 다를 수 있습니다.

[edges] 섹션까지 스크롤합니다. 엣지는 두 심볼 간의 관계입니다. 각 엣지 줄은 소스 심볼, 관계의 종류, 대상 심볼을 명시합니다:

[edges]
S2 --contains--> S4
S4 --calls--> S5

이 예시는 엣지 줄의 형태를 보여줍니다. “S2가 S4를 포함한다”와 “S4가 S5를 호출한다”를 의미합니다. [symbols]에서 각 Short ID를 찾아 어떤 심볼을 가리키는지 확인할 수 있습니다.

codeknit을 빌드하고, PATH에 추가했으며, codeknit parse를 실행하고 .skt 출력의 [symbols] 및 [edges] 섹션을 읽었습니다.