1. 1
2. 2
3. 3
4. 4
5. 5
6. 6
7. 7
8. 8
9. 9
10. 10
11. 11
12. 12
13. 13
14. 14
15. 15
16. 16
17. 17
18. 18
19. 19
20. 20
21. 21
22. 22
23. 23
24. 24
25. 25
26. 26
27. 27
28. 28
29. 29
30. 30
31. 31
32. 32
33. 33
34. 34
35. 35
36. 36
37. 37
38. 38
39. 39
40. 40
41. 41
42. 42
43. 43
44. 44
45. 45
46. 46

<!--
SPDX-FileCopyrightText: 2024 Shota FUJI <pockawoooh@gmail.com>
SPDX-License-Identifier: AGPL-3.0-only
-->

# 開発ガイド

[bun]: https://bun.sh/
[dprint]: https://dprint.dev/

## 前提環境

このプロジェクトを開発するにあたり以下のものが必要になる。

- [Bun][bun] v1.1.x
- [dprint][dprint] v0.47.x
- [reuse tool](https://github.com/fsfe/reuse-tool) v4 以上

`.tool-versions` に対応した [asdf](https://asdf-vm.com/) や [mise](https://mise.jdx.dev/) といったバージョン管理ツールの利用を強く推奨。

## JavaScript パッケージのインストール

[Bun][bun] の Workspace 機能を利用しているため、リポジトリルートで `bun i` を実行すれば各パッケージで必要な全ての依存パッケージがインストールされる。

```
$ bun i
```

この作業は `package.json` や `bun.lockb` に変更があった際に毎回実行する必要がある。

## ソースコードの自動整形

[dprint][dprint] を使ってソースコードの自動整形を統一して行えるようになっている。

```
$ dprint fmt
```

## 著作権とライセンス表記のチェック

このプロジェクトは [REUSE v3.3](https://reuse.software/spec-3.3/) に準拠した著作権とライセンス表記を行っている。
以下のコマンドで全てのファイルに適切に著作権とライセンスの表記がされているか確認できる。

```
$ reuse lint
```