コンテンツにスキップ

はじめに

このチュートリアルでは、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]セクションまでスクロールします。エッジは2つのシンボル間の関係です。各エッジ行は、ソースシンボル、関係の種類、およびターゲットシンボルまたはシンボルを示します:

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

この例はエッジ行の形式を示しています。これは「S2はS4を含む」および「S4はS5を呼び出す」という意味です。[symbols]で各Short IDを調べて、それが何を指しているかを確認できます。

codeknitをビルドし、PATHに追加し、codeknit parseを実行して、.skt出力の[symbols]および[edges]セクションを読み取りました。