メンテされなくなったCLIをTypeScriptで開発しなおした話

kansai.ts #10 でお話しさせていただいた際のスライドです。
- https://kansaits.connpass.com/event/348764/

Transcript

1. メンテされなくなった CLIをTypeScript で開発しなおした話 © Nabe-cyan(t-pot.me)
2. • オフィシャル・プライベート共に、今まで基本的に1人での開発がメインだった ので、我流な部分が含まれていると思います • トーク中でも様々なアドバイス・質問はウェルカムです！ はじめに
3. 概要 • AlgoliaというWebサイト内検索のSaaSがある • Algolia上にデータをアップロードする際に atomic-algolia という、JSベースのCLIライ ブラリがあったのですが、メンテナンスされなくなっていた • 今回はTS + citty, unbuildでこのライブラリを作り直した ◦ algolia-uploader • 技術選定、困った話、今も困っている話 etc. を話したい
4. Algoliaとは…？ • Algoliaについて知っている or 使ったことのある方 ✋ • SaaS型全文検索サービス • サーバーやインフラの構築・運用が不要で、クラウド上で提供されるため、導 入や運用が非常に簡単 • リアルタイム検索と高パフォーマンス • 例：私の個人ブログのサイト内検索機能
5. メンテされなくなった atomic-algolia • 私も過去使っていた ライブラリ • 必要最低限の機能に絞って 開発されており、非常に素晴 らしい • 5年前の更新を最後に残念な がらストップ （貶める意図は一切ないです）
6. atomic-algoliaのユースケース https://upload.wikimedia.org/wikipedia/commons/6/69/Algolia-logo.svg JSONファイルの例： { "objectID": "prod_001", "name": "Wireless Headphones", "brand": "SoundMaster", "price": 129.99, "inStock": true, "rating": 4.5, "description": "Premium sound quality with noise cancellation.", "imageUrl": "https://example.com/images/headphones.jpg" }, • ローカルにあるJSONファイルを Algoliaに登録する • 登録・削除・更新処理は公式の search clientを利用 npm run atomic-algolia
7. 技術選定 • まず新しめのCLI開発事例を探す ◦ これを読んでUnJSが熱いっぽいという事が分かった • フレームワークの学習にそんなに時間を掛けたくない ☞ドキュメントを読めば9割は作り方が分かるフレームワークにしたい ほな citty, unbuild, jiti の組み合わせで作ってみるか！
8. 詳細 • 言語: TypeScript • パッケージマネージャー: yarn v4 • CLI Builder: citty • Bundler: unbuild • デバッグ支援（生のTSをそのまま実行できる）: jiti • 環境変数の処理: dotenvx • テスト: vitest
9. 困ったこと • `yarn v4`での`Zero-Installs`関連の設定に手間取った • `yarn v4`とVSCode, `devcontainer`の組み合わせで開発してみたところエ ディターごとに追加の設定が必要という落とし穴にはまった（この対応が必 須かどうかまだ微妙に分かっていない） ◦ 別のパッケージマネージャーを使った方が良かった気がしている • 最初に`lodash`を使っていたが、CommonJSでしか動かないことを知らな かった ◦ 結局は es-toolkit を使った
10. 困っていること • 一人で開発しているので、実際にはまだ困っていない • 今のところデバッグする際に実際のAlgoliaのアカウントを使ってデ バッグ用のアプリケーションを用意する必要があり正直手間。。。(´; ω;｀)
11. まとめ・蛇足 • ちょっと学習すれば直観的で楽しく開発できる（特に cittyが優秀） • yarn v4 をがっつり触ったけど、パッケージマネージャとして気軽にはおす すめできないかも ◦ 有識者のアドバイス・コメント求む！ • 自分でOSSライブラリを開発・保有していると将来的なキャリアでも良いこ とあるかもね！ 知らんけど