Denoで作るチーム開発生産性向上のためのCLIツール

■ イベント
TypeScriptを活用した型安全なチーム開発 2024
https://sansan.connpass.com/event/337268/

■ 発表者
技術本部 Strategic Products Engineering Unit Contract One Devグループ
伊藤 遼太

■ Contract One 開発エンジニア 採用情報
https://media.sansan-engineering.com/contractone-engineer

Transcript

1. Sansan株式会社 部署 名前 Denoで作る チーム開発生産性向上のための CLIツール Sansan技術本部 技術本部 Strategic Products Engineering Unit Contract One Devグループ 伊藤 遼太
2. 写真が入ります 伊藤 遼太 - Ryota Ito - Sansan株式会社 技術本部 Contract One Dev グループ - 2021年11月 Sansan 入社 - Backend (Kotlin) / Frontend (TS) / Management - X: itomise0f
3. PR: Contract One とは
4. PR: Contract One とは
5. PR: Contract One の技術スタック
6. チーム開発生産性向上のための CLIツール
7. プロダクションコード以外でも、いろんなところで使いまわされているコー ドがあったりする (以下、周辺コードと呼びます) - 定型的 - 自動化されていない運用作業 - テストデータ作成 - コード生成 - 突発的 - ログ分析 - インシデント調査 - etc … サービス開発では様々なコードが必要になる
8. - ドキュメントにコードがはられていたり - sql, shell など - 便利用スクリプトリポジトリが作られたり - いろんな言語で書かれたり - 共有しておらず、複数人が同じコードを書いていたり - ローカルで使っていたけど、どこに置いたか忘れて使えなかったり - … 周辺コードは管理が煩雑になりがち
9. - Contract One でも、周辺コード用のリポジトリを運用していた - Ruby で書かれていたり、Go で書かれていたり - メンテがあまりされず、ドキュメントもほとんどなかったので、知る人ぞ 知るという状態になっていた - アップデートしたりしても気づかないため、他の開発者がメリットを享受 できない 課題
10. - 共通の実行環境を作って整備すれば、管理の問題を解決できると考えた - 技術構成は、Deno を採用した - 理由は後述 解決策
11. デモ
12. 何が嬉しいの？
13. Contract One CLI で実際にやっていること - データ準備系 - XのデータをYの状態にする - ユニークなサンプルPDFを生成する - 運用系 - 機能で提供していない運用作業を自動化したスクリプト - 手順書を不要にし、全体の認知コストを下げる目的 - リリース作業 - AI生成系 - 自然言語からいい感じの変数名、クラス名を出してくれる - 要件定義のテキストから一通りのコードを生成してくれる
14. 効果 - 開発シーンで利用し、作業効率が上がったという声がある - 開発者が思いついた時にすぐにコードを書いて、他の開発者に価値が 提供できるため、自動化に向き合う文化ができてきている - 複雑な工程が必要な場合でも CLI でインタラクティブな体験を作れる ため、CLI 環境ならこんなことも体験良く作れそう、というアイデアが 実装され始めている
15. なぜ Deno なの？
16. Denoの採用理由 1. 標準機能の豊富さ 2. Global Install 機能 3. 既に採用済みの言語のため
17. 1. 標準機能の豊富さ - Denoは標準の機能が充実しており、標準ライブラリもDenoの コアメンバーによってメンテナンスされている - CLIアプリを作るに当たって必要な機能はほとんど標準ライブラリで実装 できる - 標準ライブラリ以外のライブラリ自体も依存関係がかなり少ないので、 全体の依存関係をかなり小さくできている - 依存関係が増えるとそれらのメンテナンスコストもかかってくるため、 メリットがある
18. - 現状の標準ライブラリ以外の依存関係 - @david/dax : コマンドラインを実行するためのdeno製ライブラリ - postgres : postgres と通信するためのdeno製ライブラリ - zod : 依存関係ゼロのバリデーション用ライブラリ 1. 標準機能の豊富さ Contract One CLI 開発環境の依存パッケージ
19. - Deno 2.0 の Youtube 動画「Programming Should Be Simple」 - Node.js で同じことをやろうとすると、typescript, uuid, csv, lint, config, vitest … と多くの依存関係と設定を管理する必要が出てくる (またそれらの 噛み合わせも...) - CLIアプリのような、小さい環境で 小さく実行したい、というユースケースに はDenoが合っていると判断した 1. 標準機能の豊富さ
20. - CLIアプリは利用側の体験が重要 - 使いにくいアプリは使われなくなる - Global Installation 機能 - 指定したファイル、モジュールを任意のコマンドでグローバルに実行可能に なる - ファイルを編集したりしても再インストールが必要ない - Contract One はモノレポ構成をとっているため、CLIのコードもそこに 含めて運用している - コマンドを作ってpushするだけで、開発者全員に迅速に価値を届けられる 2. Global Installation 機能
21. - Contract One ではフロントエンド環境に TypeScript を利用しているため、 開発者全員の学習コストがほとんどない - 開発生産性向上のためには、全ての開発者が能動的に自動化に向き合える 環境を作ることが重要 3. 既に採用済みの言語のため
22. - Deno 2.0, 2.1 でのアップデート内容も大きい - 標準ライブラリの多くが v1 に - npm 完全互換 - long term support Denoの採用理由: その他
23. 今後に向けて
24. 今後 - より機能を充実させて開発生産性に向き合っていきたい - 自動化の文化を醸成していきたい
25. 最後に - Deno 2.1 おすすめ - Denoのメリットを享受できる部分はたくさんあると思っており、CI 環境で 実行するものも Deno で置き換える予定 - ぜひフォローお願いします！ - X: itomise0f
26. - デモリポジトリ: https://github.com/itomise/deno-cli-app Appendix