Tbpgr Blog

元エンジニア 人事 tbpgr(てぃーびー) のブログ

TbpgrKnowledge | 作業用スクリプトを共有しやすい形式にする方法を覚える(gem、gradleなど)

概要

作業用スクリプトを共有しやすい形式にする方法を覚える(gem、gradle)

詳細

作業用の自作ツールの作成にも慣れ、汎用的で自分以外にも使ってもらえるようなものを
作れるようになってくると手軽に導入できて使いやすい形式で配布するよって自分以外の人にも
喜んで利用してもらえるようになります。

Rubyはgem形式が非常に使いやすいため、業務ドメインに関わらない汎用的なツールならgemで公開。
公開する程でもなかったり、外部に出したりするようなものではないなら社内・チームなどで
管理しているリポジトリに公開してそこからインストールしてもらいます。

JavaのプロジェクトでEclipseを利用しているなら、Gradleのタスクにするのが手軽です。
Gradleが敷居が高い現場ならCLIツールなど。

配布の際はユーザが迷わず利用できるようにREADMEを付属します。
GitHub+gemの場合は通常README.mdを書くことになるので、そこで細かな手順を書いておけば良いです。

公開する段階である程度ソースコードは綺麗にしておき、クラスヘッダーやメソッドヘッダーなど
設計概念の補足が必要な箇所などは補足のコメントを追加しておきます。
GitHubオープンソースとして公開する場合は当然として、社内や特定のメンバー用に作った場合に
ソースが汚いとツールの成長を阻害します。
綺麗に拡張しやすく、すぐ読めるコードになっていればチームメンバーの中でも優秀なメンバーは
勝手に改良してくれたりします。

もちろん、普段から使い捨てのコードも綺麗に書いているなら特に意識すべきことはありません。