LightningReview.ReviewFile 0.8.4

Lightning Reviewのレビューファイルのレビューや指摘のデータを高速に読み込み可能なライブラリです。

• コンパクトで他への依存関係がない軽量な設計になっています。
• 複数のLightning Reviewバージョンでの分析が可能です。Lightning ReviewはV1.8でレビューファイルのフォーマットが変わりましたが、このライブラリではV1.8でもそれ以前のバージョンでもどちらのファイルも対応しています。
• 1000ファイルのレビューファイルの読み込みに数秒程度で処理可能と非常に高速になっています。
• 複数のレビューファイルを集計して品質メトリクスを計測するようなユースケースを想定しています。従って、現時点ではレビューファイルの要素にすべての対応しているわけではありません。主にレビューと指摘に関する情報が参照できます。 現在はDocumentのOutline取得についてはLightning ReviewのV1.8以降のフォーマットのみ対応しています。また指摘画像やレビュー設定の読み込みは対応していません。

例

単一のレビューファイルを指定する場合

using LightningReview.ReviewFile;
using LightningReview.ReviewFile.Models;

//...

// レビューファイルを読み込むクラスです
var reader = new ReviewFileReader();

// 単一のレビューファイルを指定する場合
var review = reader.Read(ReviewFilePath);
Console.WriteLine(review.Issues.Count());

フォルダにある複数のレビューファイルを指定する場合

    // フォルダにある複数のレビューファイルを指定する場合
    var reviews = reader.ReadFolder(folder);
    foreach ( var review in reviews)
    {
        Console.WriteLine(review.Name);

        // レビューごとの指摘件数
        Console.WriteLine(review.Issues.Count());

        // 指摘毎の詳細
        foreach ( var issue in review.Issues)
        {
            Console.WriteLine(issue.Description);
        }
    }