■ はじめに

https://dk521123.hatenablog.com/entry/2024/04/13/232832

の続き。

前回は、reviewdog の Hello world 的なことを行ったが
今回は、もう少し掘り下げてみる。（徐々にではあるが）

【１】インストール
【２】Input format
　１）errorformat
　２）-f={LinterName}
　３）Reviewdog Diagnostic Format (RDFormat)
　４）その他の方法
【３】Third partyの利用
　１）使用上の注意
　例１：reviewdog with SQLFluff「yu-iskw/action-sqlfluff」
【４】サンプル
　１）Third party「yu-iskw/action-sqlfluff」の使用例

【１】インストール

* reviewdog を自分のローカル環境にインストールする

Ubuntu

# Step1: Install the latest version. (Install it into ./bin/ by default).
curl -sfL https://raw.githubusercontent.com/reviewdog/reviewdog/master/install.sh | sh -s

# => 英語のコメントの通り「./bin/reviewdog」がインストールされたのでパスを通す
# Step2: Path を通す
vi ~/.bash_profile
~~~~~~
export PATH=home/user/bin:$PAT
~~~~~~

# 設定を即反映
source ~/.bash_profile

# Step3: 確認
reviewdog -version
# 0.17.3 など、Version情報が表示されたらOK

【２】Input format

https://github.com/reviewdog/reviewdog?tab=readme-ov-file#input-format

１）errorformat

* エラーメッセージのフォーマットを指定する

https://github.com/reviewdog/reviewdog?tab=readme-ov-file#errorformat

-efm="%f:%l:%c: %m"
 => {file}:{line number}:{column number}: {message}

https://vim-jp.org/vimdoc-en/quickfix.html#error-file-format

 => 以下「pylint のエラーメッセージ例」と比較すると分かりやすいかも

pylint のエラーメッセージ例

demo1.py:5:0: C0304: Final newline missing (missing-final-newline)
demo1.py:1:0: C0114: Missing module docstring (missing-module-docstring)
demo1.py:1:0: C0116: Missing function or method docstring (missing-function-docstring)
demo1.py:2:4: R1705: Unnecessary "else" after "return", remove the "else" and de-indent the code inside it (no-else-return)

２）-f={LinterName}

* サポート済のLinterを指定する

https://github.com/reviewdog/reviewdog?tab=readme-ov-file#available-pre-defined-errorformat

$ golint ./... | reviewdog -f=golint -diff="git diff FETCH_HEAD"

補足：reviewdog -list

* どの種類がサポートされているかは、以下のコマンドで調べられる

reviewdog -list

サポート一覧

Name	Type	Explanations	URLs
rdjson	Others	Reviewdog Diagnostic JSON Format (JSON of DiagnosticResult message)	https://github.com/reviewdog/reviewdog
rdjsonl	Others	Reviewdog Diagnostic JSONL Format (JSONL of Diagnostic message)	https://github.com/reviewdog/reviewdog
diff	Others	Unified Diff Format	https://en.wikipedia.org/wiki/Diff#Unified_format
checkstyle	XML	checkstyle XML format	http://checkstyle.sourceforge.net/
sarif	JSON	SARIF JSON format	https://sarifweb.azurewebsites.net/
ansible-lint	ansible	(ansible-lint -p playbook.yml) Checks playbooks for practices and behaviour that could potentially be improved	https://github.com/ansible/ansible-lint
bandit	Python	A tool designed to find common security issues in Python code	https://github.com/PyCQA/bandit.git
black	Python	A uncompromising Python code formatter	https://github.com/psf/black
brakeman	Ruby	(brakeman --quiet --format tabs) A static analysis security vulnerability scanner for Ruby on Rails applications	https://github.com/presidentbeef/brakeman
buf	Others	A new way of working with Protocol Buffers	https://github.com/bufbuild/buf
cargo-check	GO	(cargo check -q --message-format=short) Check a local package and all of its dependencies for errors	https://github.com/rust-lang/cargo
clippy	Rust	(cargo clippy -q --message-format=short) A bunch of lints to catch common mistakes and improve your Rust code	https://github.com/rust-lang/rust-clippy
dotenv-linter	Rust	Lightning-fast linter for .env files. Written in Rust	https://github.com/dotenv-linter/dotenv-linter
dotnet	.NET	(dotnet build -clp:NoSummary -p:GenerateFullPaths=true --no-incremental --nologo -v q) .NET Core CLI	https://docs.microsoft.com/en-us/dotnet/core/tools/
erb-lint	HTML	(erblint --format compact) Lint your ERB or HTML files	https://github.com/Shopify/erb-lint
eslint	JavaScript	(eslint [-f stylish]) A fully pluggable tool for identifying and reporting on patterns in JavaScript	https://github.com/eslint/eslint
eslint-compact	JavaScript	(eslint -f compact) A fully pluggable tool for identifying and reporting on patterns in JavaScript	https://github.com/eslint/eslint
fasterer	Others	Speed improvements suggester	https://github.com/DamirSvrtan/fasterer
flake8	Python	Tool for python style guide enforcement	https://flake8.pycqa.org/
go-consistent	GO	Source code analyzer that helps you to make your Go programs more consistent	https://github.com/quasilyte/go-consistent
golangci-lint	GO	(golangci-lint run --out-format=line-number) GolangCI-Lint is a linters aggregator.	https://github.com/golangci/golangci-lint
golintvlinter	GO	for Go source code	https://github.com/golang/lint
gosec	GO	(gosec -fmt=golint) Golang Security Checker	https://github.com/securego/gosec
govet	GO	Vet examines Go source code and reports suspicious problems	https://golang.org/cmd/vet/
haml-lint	HAML	Tool for writing clean and consistent HAML	https://github.com/sds/haml-lint
hlint	Haskell	Linter for Haskell source code	https://github.com/ndmitchell/hlint
isort	Python	A Python utility / library to sort Python imports	https://github.com/PyCQA/isort
luacheck	Lua	(luacheck --formatter=plain) Lua linter and static analyzer	https://github.com/luarocks/luacheck
misspell	Others	Correct commonly misspelled English words in source files	https://github.com/client9/misspell
msbuild	Others	(msbuild /property:GenerateFullPaths=true /nologo /v:q) Microsoft Build Engine	https://docs.microsoft.com/en-us/visualstudio/msbuild/msbuild
mypy	Python	An optional static type checker for Python	http://mypy-lang.org/
pep8	Python	Python style guide checker	https://pypi.python.org/pypi/pep8
phpstan	PHP	(phpstan --error-format=raw) PHP Static Analysis Tool - discover bugs in your code without running it!	https://github.com/phpstan/phpstan
protolint	Others	A pluggable linting utility for Protocol Buffer files	https://github.com/yoheimuta/protolint
psalm	PHP	(psalm --output-format=text) Psalm is a static analysis tool for finding errors in PHP	https://github.com/vimeo/psalm
puppet-lint	Puppet	Check that your Puppet manifests conform to the style guide	https://github.com/rodjek/puppet-lint
pydocstyle	Python	A static analysis tool for checking compliance with Python docstring conventions	https://github.com/PyCQA/pydocstyle
reek	Ruby	(reek --single-line) Code smell detector for Ruby	https://github.com/troessner/reek
remark-lint	Others	Tool for writing clean and consistent markdown code	https://github.com/remarkjs/remark-lint
rubocop	Ruby	A Ruby static code analyzer, based on the community Ruby style guide	https://github.com/rubocop-hq/rubocop
sbt	Scala	the interactive build tool	http://www.scala-sbt.org/
sbt-scalastyle	Scala	Scalastyle - SBT plugin	http://www.scalastyle.org/sbt.html
scalac	Scala	Scala compiler	http://www.scala-lang.org/
scalastyle	Scala	Scalastyle - Command line	http://www.scalastyle.org/command-line.html
slim-lint	Slim	Tool to help keep your Slim files clean and readable	https://github.com/sds/slim-lint
sorbet	Ruby	A fast, powerful type checker designed for Ruby	https://github.com/sorbet/sorbet
standardjs	JavaScript	(standard) JavaScript style guide, linter, and formatter	https://github.com/standard/standard
standardrb	Ruby	(standard) Ruby style guide, linter, and formatter	https://github.com/testdouble/standard
staticcheck	GO	Golang Static Analysis	https://staticcheck.io
stylelint	CSS	A mighty modern CSS linter	https://github.com/stylelint/stylelint
tsc	TypeScript	TypeScript compiler	https://www.typescriptlang.org/
tslint	TypeScript	An extensible linter for the TypeScript language	https://github.com/palantir/tslint
typos	Others	Source code spell checker	https://github.com/crate-ci/typos
yamllint	Others	(yamllint -f parsable) A linter for YAML files	https://github.com/adrienverge/yamllint

３）Reviewdog Diagnostic Format (RDFormat)

* reviewdog 独自のフォーマットである 「rdjson」又は「rdjsonl」に変換する
 => 後述『例１：reviewdog with SQLFluff「yu-iskw/action-sqlfluff」』の内部では
　　この方法を使って実装している模様
 => これを使いこなせれば、レビューの自動化が思い通りになりそう
 => 詳細は、以下の関連記事を参照のこと

reviewdog ～ RDFormat ～
https://dk521123.hatenablog.com/entry/2024/04/19/121312

４）その他の方法

* 上記以外にも以下の方法があるみたい
~~~~~
 + Diff
 + SARIF format（Static Analysis Results Interchange Format＝静的解析結果交換フォーマット）
~~~~~

Diff
https://github.com/reviewdog/reviewdog?tab=readme-ov-file#diff
SARIF format
https://github.com/reviewdog/reviewdog?tab=readme-ov-file#sarif-format

【３】Third partyの利用

* 上記以外でThird partyが用意されていれば、
　それを利用するのが楽かも

１）使用上の注意

* Linter のバージョンに対応できないかもしれない点

例：yu-iskw/action-sqlfluff の場合

* 例えば、以下で紹介している「yu-iskw/action-sqlfluff」では、
　入力「sqlfluff_version（デフォルト：「2.3.0」）」があるが、
　SQLFluff v3 だと出力フォーマット v2 と変わっており
　現状（2024/04/19) は、この変更に対応できていない模様
 => もちろん、デフォルトで問題ないのであればいいと思うが、
　　そういったこともあるって紹介、、、

https://github.com/yu-iskw/action-sqlfluff/blob/62f4245977b9afc9289acc7b69dbcbb872aa1f4c/action.yml#L43

例１：reviewdog with SQLFluff「yu-iskw/action-sqlfluff」

* reviewdog + SQLFluff とのラッパー

https://github.com/yu-iskw/action-sqlfluff

Inputs
https://github.com/yu-iskw/action-sqlfluff/blob/62f4245977b9afc9289acc7b69dbcbb872aa1f4c/action.yml#L4
作成者のブログ？
https://yu-ishikawa.medium.com/automate-dbt-review-on-github-7bc1c70ebca3

【４】サンプル

１）Third party「yu-iskw/action-sqlfluff」の使用例

name: DemoForReviewdogs

on:
  - pull_request
jobs:
  demo-job:
    name: lint
    runs-on: ubuntu-latest
    steps:
      - name: Run checkout
        uses: actions/checkout@v4
      # ★ここに注目★
      - id: lint-sql
        name: Lint SQL
        uses: yu-iskw/action-sqlfluff@v3
        with:
          github_token: ${{ secrets.REVIEWDOG_GITHUB_API_TOKEN }}
          reporter: github-pr-review
          sqlfluff_command: "lint"
          paths: 'sqls/'
          dialect: snowflake
          fail_on_error: true
      - name: 'Show outputs (Optional)'
        shell: bash
        run: |
          echo '${{ steps.lint-sql.outputs.sqlfluff-results }}' | jq -r '.'
          echo '${{ steps.lint-sql.outputs.sqlfluff-results-rdjson }}' | jq -r '.'

NG.sql (テスト用SQL)

  SELECT a  +  b FROM tbl;

プログラムの超個人的なメモ

Memo for Programming.

【Github】reviewdog ～基本編～

■ はじめに

目次

【１】インストール

【２】Input format

１）errorformat

２）-f={LinterName}

３）Reviewdog Diagnostic Format (RDFormat)

４）その他の方法

【３】Third partyの利用

１）使用上の注意

例１：reviewdog with SQLFluff「yu-iskw/action-sqlfluff」

【４】サンプル

１）Third party「yu-iskw/action-sqlfluff」の使用例

関連記事