lookml-reviewer

LookML レビュースキル

このスキルは、Looker CLI（looker-cli）を使用して、同梱されているベストプラクティスのリファレンスとスタイルガイドラインに照らし合わせながら、LookML ファイルを厳密にコード監査します。

ワークフローの手順

呼び出されたら、次の手順を正確に実行します。

1. 事前チェックのガードレールと検証： 詳細を尋ねたり、コードを取得したりする前に、looker-cli がインストールされ、認証されていることを確認します。

   • CLI のインストールを確認： 次を実行します：looker-cli --help コマンドが失敗する、または見つからない場合：直ちに中止し、ユーザーに次のように案内します。

     "looker-cli がインストールされていないか、PATH に設定されていません。Looker CLI のドキュメントにあるインストール手順を参照してください：https://github.com/looker-open-source/looker-cli"

   • 認証と Looker の設定を確認： 次を実行します：looker-cli user me 認証されていない、または接続に失敗した場合：直ちに中止し、ユーザーに次のように案内します。

     "Looker インスタンスに認証されていません。次のいずれかの方法で looker-cli を設定し、認証してください。

     方法 1：対話型 OAuth（推奨）

     1. Looker で、Looker CLI コネクタが有効になっていることを確認します。 Admin > Platform > BI Connectors > Developer Tools の下に移動し、Looker CLI を ON に切り替えます。
     2. プロファイルを設定してログインします。

        looker-cli profile add default --host <your-looker-host> --port 443
        looker-cli profile use default
        looker-cli session login --oauth
        

     方法 2：API キー（クライアント ID とクライアントシークレット） OAuth が有効になっていない場合、またはヘッドレス／サービスアカウントの場合：

     looker-cli profile add default --host <your-looker-host> --port 443 --client-id <CLIENT_ID> --client-secret <CLIENT_SECRET>
     looker-cli profile use default
     

     設定が完了したら、レビューをもう一度依頼してください。"

2. 対象範囲を把握し、ブランチを検証：

   • Looker インスタンスの URL（例：https://<instance>.looker.com または https://<instance-id>.<region>.looker.app）、Looker プロジェクト名（例：fashionly）、対象ブランチ、そしてプロジェクト全体をレビューするのか、特定の LookML ファイル 1 つ（例：views/order_items.view.lkml）をレビューするのかを確認します。
   • 重要 — Looker インスタンスの URL：Looker インスタンスの URL が記載されていない場合は、先に進む前に必ずユーザーに提示を求めます。
   • 重要：ユーザーが依頼の中で明示していない限り、先に進む前に必ずプロジェクト名とブランチ名をユーザーに尋ねます。
   • 重要なガードレール — ブランチの検証（ブランチを作成しないでください）：
     • セッションのワークスペースが開発モードであることを確認します。

       looker-cli session update dev
       

     • 既存のブランチをすべて確認します。

       looker-cli project branch <project_id> --all
       

     • 存在しないブランチを作成してはいけません。 ブランチを作成するコマンドや API 呼び出しは決して使用しないでください。
     • master／main の同等性：ユーザーが master を指定し、存在するのが main のみの場合（またはその逆の場合）は、存在する方（main または master）に自動的に置き換え、その旨をユーザーに伝えます。
     • ブランチが見つからない場合：指定されたブランチ（または対応する master／main）がブランチ一覧に存在しない場合は、直ちに中止し、利用可能なブランチをユーザーに提示して、確認を求めます。

3. looker-cli を使用した LookML ファイルの取得：

   • 対象ブランチをチェックアウトする：

     looker-cli project checkout <project_id> <branch_name>
     

     • 競合時のガードレール：現在の開発ワークスペースで、コミットされていないローカル変更またはチェックアウトの競合が原因でチェックアウトに失敗した場合は、直ちに中止します。競合しているファイルをユーザーに報告し、再試行する前に Looker で変更をコミットするか破棄するよう依頼してください。
   • プロジェクトファイルを一覧表示する：プロジェクトのファイル一覧を取得します。

     looker-cli project file ls <project_id>
     

   • ファイルの内容を取得する：
     • 単一ファイルモード：ユーザーが LookML ファイルを 1 つだけ明示的に指定した場合は、プロジェクトのファイル一覧にそのファイルが存在することを確認し、そのファイルだけを取得します。

       looker-cli project file cat <project_id> <file_path>
       

       (ファイルが見つからない場合は中止し、該当するプロジェクトファイルを一覧表示して、ユーザーに確認を求めてください)。
     • プロジェクト全体モード：単一のファイルが指定されていない場合は、各 LookML ファイル（*.model.lkml、*.explore.lkml、*.view.lkml、manifest.lkml、および設定ファイル）の内容を読み取ります。

       looker-cli project file cat <project_id> <file_path>
       

4. コードベース／対象ファイルを分析する：

   • 取得した LookML ファイルを、Looker のベストプラクティスに照らして包括的に分析します（references/ にあるガイド、conversational-analytics-best-practices.md、lams-style-guide.md、lookml-dos-and-donts.md、sustainable-maintainable-lookml.md を参照してください）。
   • 単一ファイルをレビューする場合は、そのファイルを徹底的に監査します（フィールド定義、主キー、外部キー、命名規則、説明、count メジャーのフィルター、会話型分析への対応状況を確認します）。
   • プロジェクト全体をレビューする場合は、包括的なレビューを行うためにプロジェクト全体を分析します（モデルと Explore の関係、ビューの結合、主キー、データグループ、命名規則、会話型分析への対応状況を確認します）。

5. レポートをまとめる：分析に基づき、非常に詳細で包括的なレビュー報告書を作成します。報告書には次のセクションを含めてください。

   • 概要：対象ファイルまたはコードベース全体の健全性を大局的にまとめ、レビューしたプロジェクト名、ブランチ、対象ファイル（単一ファイルモードの場合）、および主な指摘事項を記載します。
   • 強み：特に優れたコードパターンを挙げた箇条書きリスト。
   • 改善点：ファイルごとに整理した、違反事項の非常に詳細な説明。各項目では、次の内容を記載します。
     • 違反内容を明確に説明します。報告書でルール全体を明示的に列挙したり、繰り返したりしないでください。
     • 具体的な修正方法を提案します（修正前と修正後のコード例を示します）。
     • 重要：違反箇所の正確なファイルパスと行番号を記載します（例：views/order_items.view.lkml:L16-L19）。Looker インスタンスの URL を使用して、Looker IDE でファイルを直接開くリンクを作成します：<instance_url>/projects/<project_id>/files/<file_path>。

6. レポートを出力する：レポートを作成し、主な回答としてチャットまたはコンソールに直接出力します。ファイルや成果物には保存しないでください。