Shopify CLIでログイン中のストア名をStarshipプロンプトに表示する

「RuffRuff 予約販売」は在庫切れや新商品販売前、入荷待ちなどタイミングで発生する機会損失の削減をサポートします。
ノーコードかつ３ステップで簡単にセットアップでき、日本語に対応しています。
無制限で予約商品を登録および無制限で予約注文を受け付けることが可能です。

引用元: RuffRuff 予約販売

株式会社TsunでCTOをしている小笠原です！
最近Shopifyのアプリやテーマ開発をメインに行っています。
このブログではShopify開発に役立つ情報を共有しています。
Shopifyエンジニアの方の参考になれば嬉しいです！

なぜ作ろうと思ったのか

Shopify Partnersで複数のお客様のストアを扱っていると複数の開発ストアを扱う必要があります。
Shopify CLIでログインしているストアの情報を shopify store のコマンドを実行して毎回確認するのが面倒だったので、Starshipのプロンプトに表示しようと思いました。

作成したもの

StarshipのプロンプトにShopify CLIでログインしているストア名を表示する設定

前提条件

対象読者

• Shopify CLIを使ったことがある人

• Starshipを導入している人

  今回の記事ではStarshipについては詳しく触れませんが、導入に興味のある方は簡単に導入できますので、この機会にぜひ導入をオススメします！

環境

• Shopify CLI (version: 2.17.0)
• Starship (version: 1.6.3)

実装

~/.config/starship.toml に下記設定を追加します。

[custom.shopify]
command = """ shopify store | sed -r "s/^.* into (.*)\\.myshopify\\.com.*$/\\1/" """
when = "shopify store"

設定が反映されると、下記のようにログイン中のストア名が表示されました！

ストアを切り替えても即座にログイン中のストア名が切り替わります。

やっていることは、shopify store を実行すると

You're currently logged into tsun-dev.myshopify.com

の形式で表示されるので、ストア名部分のみ抽出しているだけです。

常に表示されるのが邪魔だなーと思う方は detect_files オプションで shopify-cli.yml を指定するなどするとよさそうです。

また、上記ではsymbolを指定していませんが、Nerd Fontsの nf-fa-shopping_bag なんかを指定するとShopifyとわかりやすいかなと思います。

その他の設定について知りたい方は custom-commands を確認してください。

まとめ

今回はStarshipプロンプトにShopify CLIのログインしているストア名を表示する方法をご紹介しました。
早くStarship公式で対応してくれると嬉しいですね！

TsunはShopify Partnersで多数のストア構築実績があります。
ストア構築に興味のある方は、ぜひTsunへお問い合わせください。