makeをタスクランナーとして使う！

Makefileを作る

自動でコードをきれいに整理したい

今回はblack, ruff, mdformatを使用します

👇Makefileの中身

.PHONY: black
black:
	poetry run black .
 
.PHONY: ruff
ruff:
	poetry run ruff check . --fix
 
.PHONY: mdformat
mdformat:
	poetry run mdformat *.md
 
.PHONY: cake
cake:
	$(MAKE) black
	$(MAKE) ruff
	$(MAKE) mdformat
 

make cakeを実行すると、3つがまとめて実行されます
※cakeは好きな文字に変更してください

依存関係をインストール

必要なものを入れましょう！

※今回はPoetryを使用しています

Poetryは依存関係をグループ別に整理する方法があるよ
(テストやドキュメントの構築だけに必要な依存関係をグループで整理しとくと便利)

$ poetry add <足したいもの> --group <グループの名前>

👇実行結果　(blackの例)

$ poetry add black --group dev
Using version ^24.4.0 for black

Updating dependencies
Resolving dependencies... (4.0s)

Package operations: 7 installs, 0 updates, 0 removals

  - Installing click (8.1.7)
  - Installing mypy-extensions (1.0.0)
  - Installing packaging (24.0)
  - Installing pathspec (0.12.1)
  - Installing platformdirs (4.2.0)
  - Installing tomli (2.0.1)
  - Installing black (24.4.0)

Writing lock file

書くとgroup名のdevに依存関係が追加される

👇pyproject.tomlの中

[tool.poetry.group.dev.dependencies]
black = "^24.4.0"

グループdevの依存関係を表しているよ

実行

必要なものが入れ終わったら

$ make cake

を実行してお掃除します

参考文献(公式)