esaに絵文字を追加するCLIツール「wataridori」をリリースしました👏
久々のnoteです。今日はツールを作ったのでその紹介をさせてください。
Pittan / wataridori - GitHub
wataridori (わたりどり) というCLIツールです。
esa というWebサービス上のカスタム絵文字をターミナルからサクサクっとアップロードできます。
esaとは?
esaは「情報を育てる」という視点で作られた、自律的なチームのための情報共有サービス (https://esa.io/ より引用)
です。markdown 形式でドキュメントを書いて、チームで共有することができるWebサービスです。つい最近、ドキュメントの同時編集にも対応しました(ベータ版)。
カスタム絵文字
iOS / Androidでおなじみの絵文字の他に、好きな画像を絵文字として使うことができる機能です。SlackやDiscordをお使いの方であれば、ガンガンカスタム絵文字を活用されていることと思います。
これと同じものをesaでも使いたい!と思って、早速Slackから絵文字を落としてきものの、数が500個を超えていて、手作業では無理…。ということでツールを作りました 🙌
使う準備
インストールするには npm が必要です。
$ npm install -g @pittankopta/wataridori
で入れることができます。インストールせずに使うには
$ npx @pittankopta/wataridori
でもOKです。
また、esaの設定画面からアクセストークンを発行する必要があります。
注意
ぼくの実装不足により、以下の制限があります。
PNGファイル以外は対応しておりません。
esaの制約により、以下の制限があります。
日本語ファイル名は対応していません。
APNGファイルは対応していません。
一枚だけ絵文字を追加する
画像一枚だけを上げるには、
$ wataridori shinchoku.png -t xxx -a xxxxxxxxxxxxx
を実行してください。(-t はチーム名を、 -a はアクセストークンを指定するオプションです)
フォルダごと絵文字を追加する
SlackやDiscordからまとめて絵文字を落としてきたものを一括してesaに追加したい場合はこの方法が使えます。
$ wataridori emojis/ -t xxx -a xxxxxxxxxxxxx
を実行してください。(-t はチーム名を、 -a はアクセストークンを指定するオプションです)
ドライ実行する(追加はせずに挙動だけ確認する)
実行する前にどんな動きを確認したい場合は --dry とつけて実行することができます。このときはAPIとの通信を行いません。
【上級者向け】環境変数を使う
定期的に実行したい場合や、CIから実行する場合など、環境変数を使うこともできます。
ESA_TEAM_NAME (https://xxxx.esa.io の xxxx 部分)
ESA_TOKEN (発行したアクセストークン)
を使ってください。
【上級者向け】追加が完了したファイルを削除する
追加が完了した絵文字ファイルをいつまでも手元に残したくない!という場合は、完了したものを削除するオプションを有効にしてください。
--delete-succeeded-files
です。
まとめ
久しぶりにCLIツールを作りました。めちゃめちゃ楽しい。
要望があれば Issue に書いてもらえれば、可能な範囲で対応してみようと思います 🙋♀️
作ったツールを定期的に実行すれば、Slackだけに絵文字を追加しても、自動的にesaでも使えるようになりますね。Slackから画像を落としてきて、差分を取って…とか大変そうですが、それはまた別ツールで…。
この記事が気に入ったらサポートをしてみませんか?