はじめに
このチュートリアルでは、codeknitをソースからビルドし、最初のパースを実行して、生成される.skt出力を読み取ります。codeknitリポジトリ内の小さなパッケージをパースするため、独自のプロジェクトは必要ありません。
- Go 1.26以降。
go versionを実行して確認してください。 - Cコンパイラ。 codeknitはtree-sitterを使用しており、CGoが必要です。
- GitとMake。
1. codeknitのビルド
Section titled “1. codeknitのビルド”リポジトリをクローンしてビルドします:
git clone https://github.com/awslabs/codeknit.gitcd codeknitmake buildビルドがエラーなく完了し、./bin/codeknitにバイナリが生成されるはずです。
2. codeknitをPATHに追加
Section titled “2. codeknitをPATHに追加”codeknitディレクトリから、binをPATHに追加します。使用しているシェルに応じた行を使用してください。
bashまたはzshの場合:
export PATH="$PATH:$(pwd)/bin"fishの場合:
fish_add_path (pwd)/binこれは現在のbashまたはzshセッションに適用されます。後続のセッションでも維持するには、~/.bashrcまたは~/.zshrcに同じ行を追加し、$(pwd)/binの代わりにbinへの絶対パスを使用してください。
3. インストールの確認
Section titled “3. インストールの確認”codeknit --versioncodeknitのバージョンが表示されるはずです。
4. 最初のパースを実行
Section titled “4. 最初のパースを実行”codeknitディレクトリに留まり、internal/consoleパッケージをパースします:
codeknit parse ./internal/console --edgescodeknitはディレクトリをスキャンし、サポートされている各ソースファイルをパースして、.sktファイルを生成します。.sktファイルは、コード内のシンボルとそれらの間の関係をリストしたコンパクトなテキストファイルです。--edgesフラグは関係を追加します。デフォルトではスペースを節約するために省略されています。
コマンドが完了すると短いサマリーが表示され、カレントディレクトリに新しい./skeletonディレクトリが作成されるはずです。
出力をリストします:
ls ./skeletonmap_001.sktのようなファイルが表示されるはずです。
5. 出力を読む
Section titled “5. 出力を読む”ファイルを開きます:
cat ./skeleton/map_001.skt最初に[symbols]セクションが表示されるはずです。シンボルは、関数、型、フィールドなど、コード内の名前付きアイテムです。シンボルは## <ソースファイル>見出しの下にグループ化されています。以下のような行が出力に含まれているはずです:
[symbols]## <path to>/console.goS1 module/package L5-L5 consoleS2 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--> S4S4 --calls--> S5この例はエッジ行の形式を示しています。これは「S2はS4を含む」および「S4はS5を呼び出す」という意味です。[symbols]で各Short IDを調べて、それが何を指しているかを確認できます。
達成したこと
Section titled “達成したこと”codeknitをビルドし、PATHに追加し、codeknit parseを実行して、.skt出力の[symbols]および[edges]セクションを読み取りました。
次のステップ
Section titled “次のステップ”- 自分のプロジェクトをパースし、異なる出力モードを選択して安全に再実行する方法:parseコマンドガイドを参照してください。
- コード構造を可視化および分析する方法:グラフコマンドガイドを参照してください。
- 重複および近似重複コードを見つける方法:fingerprintコマンドガイドを参照してください。
.skt形式のすべての部分を確認する方法:出力形式リファレンスを参照してください。- すべてのコマンドラインフラグを確認する方法:CLIフラグリファレンスを参照してください。