reviewdog/reviewdog：README に基づく導入ガイド

reviewdog/reviewdog の README はプロジェクトを「🐶 Automated code review tool integrated with any code analysis tools regardless of programming language」と説明しています。ここではリポジトリで確認できる事実だけを整理します。star 数やバッジは注目度の手掛かりであり、品質の証明ではありません。「README」には次の説明があります。reviewdog - A code review dog who keeps your codebase healthy.。これは範囲の説明であり、本番検証の結果ではありません。

README の「Table of Contents」にある内容から、用途が合うかを先に判断できます。Reporter: GitHub PR Checks (-reporter=github-pr-check)。目的が違うなら、人気だけで採用する理由にはなりません。プロジェクト名やコマンドは原文のまま残し、一次資料へ戻って用語を確認できるようにしています。 README には次の確認可能な項目もあります。[Reporter: Local (-reporter=local) [default]](#reporter-local--reporterlocal-default)。初回テストの材料にはなりますが、実際の環境での確認を省略する理由にはなりません。

動作の説明は「README」など複数の箇所に分かれています。確認できる情報は次の通りです。reviewdog also supports running in the local environment to filter the output of lint tools by diff.。書かれていない構成、性能、セキュリティを推測で補いません。導入時はディレクトリ、設定ファイル、release 履歴を確認してください。

初回導入は README の入口から始めます。確認できるコマンドは次の通りです。 # Install the latest version. (Install it into ./bin/ by default). $ curl -sfL https://raw.githubusercontent.com/reviewdog/reviewdog/fd59714416d6d9a1c0692d872e38e7f8448df4fc/install.sh | sh -s # Specify installation directory ($(go env GOPATH)/bin/) and version. $ curl -sfL https://raw.githubusercontent.com/reviewdog/reviewdog/fd59714416d6d9a1c0692d872e38e7f8448df4fc/install.sh | sh -s -- -b $(go env GOPATH)/bin [vX.Y.Z] # In alpine linux (as it does not come with curl by default) $ wget -O - 実行可能なコマンドがない場合は手順を作らず、「Installation」で依存関係、待受ポート、初回設定を確認します。

日常運用は公式文書の範囲に限ります。「Nightly releases」にはYou can also use nightly reviewdog release to try the latest reviewdog improvements every day!とあります。設定、環境変数、権限、データ保存先は明記されたものだけを扱います。未記載の既定値は隔離環境で確認し、戻せる設定を保存してください。 同じ資料にはReporter: GitHub Checks (-reporter=github-check)ともあります。