big-code-analysis

本書には英語版もあります。

big-code-analysis は、多くの異なるプログラミング言語で書かれたソースコードを分析し、情報を抽出するための Rust ライブラリです。パーサージェネレーターであり、インクリメンタルなパースを行うライブラリでもある Tree Sitter をベースにしています。

このソフトウェアのソースコードは GitHub で公開されており、不具合の報告や機能要望は対応する GitHub Issue Tracker に投稿できます。

📖 Rust API リファレンス： クレートの型とメソッドの完全なリファレンスは docs.rs にあります。本書はタスク指向であり、docs.rs はソースから直接生成される、常に最新の正式なリファレンスです。

対応プラットフォーム

big-code-analysis は、Linux、macOS、Windows という主要なプラットフォームで動作します。

コンパイル済みでパッケージ化された Linux および Windows のバイナリは、GitHub Release Page から入手できます。

API ドキュメント

big-code-analysis をクレートとして利用したい場合は、Rustdoc で生成された完全な API docs（フィーチャゲートされた vcs モジュールを含む、すべての公開型・トレイト・関数）が docs.rs にあります。

クレートの組み込みに関するタスク指向のガイド（クイックスタート、メモリ上での分析、FuncSpace 結果のたどり方、エラー処理）については、ライブラリとしての利用 セクションを参照してください。

PyO3 バインディング（pip install big-code-analysis、バッチ処理、フラットレコードの反復処理、SARIF 出力、非同期パターン）については、Python バインディング セクションを参照してください。

ライセンス

  • Mozilla が定義した文法は、MIT ライセンスの下でリリースされています。

  • big-code-analysis、big-code-analysis-cli、big-code-analysis-web は Mozilla Public License v2.0 の下でリリースされています。