【github action】blackを使ってみた【CICD】

github action勉強中

CIでlintのflake8を前回使ってみたので、今回はblackとやらを使ってみる。

lintは、ソースのバグや整形を指摘してくれるツール

プルリクを出すと、自動でgithub上でソースコードのチェックをしてくれる

↑こんな感じで自動で修正箇所を指摘してくれる

ただ、lintはあくまで指摘をしてくれるだけ

修正箇所わかっているなら、直しといてよ？？

の声に応えるのが、formatterであるblackです！！

⚫︎blackとは

「black」は、python用のformatterツール

pep8という、偉い人たちが決めたpythonのコーディング規約に沿ってソースコードを修正してくれます。

ちなみに今回は、github actionのフォーマッターとして使っていますが、vscodeに入れればファイル保存した時に自動でソースコードを綺麗に整形してくれたりする優れものです。

時々if文とか壊したりするけどね

blackのインストールは

python -m pip install black

でインストールしてくれます。

⚫︎blackをgithub actionで使ってみます

blackをgithub actionで使うにはymlファイルに以下記載

- name: black でコード整形
run: |
pip install black
black .

run: black .

run: black ./pydir