RubyMineに開発用コマンドを登録してチームで共有しよう

クラウド債務支払チーム、サーバサイドエンジニアのいいねです。

私は開発環境としてJetBrains製のRubyMineを使っています。
『統合開発環境』を称するだけの多機能さを愛してやみません。

ところでみなさん、開発用のコマンドの管理はどのように行っていますか。
README.md、または社内Wikiに書いているというパターンが多いのではないでしょうか。
開発用コマンドは開発作業中に使用するので、普段使用している開発環境上で管理・実行できると嬉しいですよね。

また、チーム内で開発コマンドの追加・変更をどのように浸透させていくかも課題の一つだと思います。
できれば変更があった際は漏れなくチーム内に伝えて混乱を減らしたいですよね。

この記事ではこれらの課題を解決するために、以下の方法をご紹介いたします。

  • RubyMineでの開発コマンドの管理
  • RubyMineに登録した開発コマンドをGit管理してチームで共有する

インストールするだけで必要な機能がほとんど揃ってしまうRubyMineですが、
更に一歩進んでプロジェクト固有の環境構築もサポートしてもらいましょう。

RubyMineでの開発コマンドの管理

RubyMine(JetBrains製IDE)では、Run/Debug Configurations 画面にて各種スクリプトの実行設定を登録することができます。

1. Run > Edit Configurations...を選択

2.+ボタンよりテンプレートを選択してコマンドを登録

Shell ScriptテンプレートのScript textを選ぶことで、生のコマンドを登録することができます。

3. 作成したコマンドを選択して▶︎ボタンで実行

コマンドを実行する際はRubyMineのメイン画面でコマンドを選択して、▶︎ボタンで実行することができます。

4. 登録したコマンドをディレクトリで整理する

ディレクトリを作って登録したコマンドを整理することもできます。

RubyMineに登録した開発コマンドをGit管理してチームで共有する

RubyMineに登録したコマンドをGit管理対象に含めてチームに登録内容を共有しましょう。

注意

この設定を行うことで他のRubyMine使用者の環境に影響します。
チーム内での了解を得るのを忘れないようにしてください。

1. 共有したいコマンドをファイルにエクスポート

共有したいコマンドの編集画面でStore as project fileにチェックを入れます。

2. 保存先を選択

RubyMine用設定ファイルだと分かりやすくするために、.idea の配下などに置くといいと思います。

3. エクスポートしたファイルをgit commitする

エクスポートされたxmlファイルをgit commitします。

/.idea/*
!/.idea/runConfigurations

.ideaディレクトリには個人のRubyMine設定も含まれているので、
上記のように.gitignoreを編集して必要なものだけGit管理するようにしましょう。

.ideaフォルダがRubyMineのProjectツリーに表示されない時

.ideaフォルダはProjectツリーの表示モードをProject Filesに設定することで確認することができます。

4. コマンドをインポートする

登録されたコマンドをインポートするのに特別な手順は必要ありません。
先ほどgit commitしたプロジェクトをRubyMineで開くだけで自動で読み込まれます。

ファイルパスについてはエクスポートの際に自動で定数化してくれているので、
共有された側はコマンドの編集を行う必要なくコマンドを使用することができます。
RubyMineえらすぎる。

参考

公式ドキュメント Run/debug configurations | RubyMine


マネーフォワード福岡拠点では、エンジニアを募集しています❗️
エンジニアは希望すればJetBrains製IDEのライセンスを発行してもらうことができます。

JetBrains製IDE好きの同士の方は是非❗️
ご応募お待ちしております😊

株式会社マネーフォワード 福岡 の求人一覧

福岡開発拠点のサイトもあるので是非見てください₍₍⁽⁽🐈₎₎⁾⁾

https://fukuoka.moneyforward.com/


マネーフォワードでは、エンジニアを募集しています。
ご応募お待ちしています。

【会社情報】
Wantedly
株式会社マネーフォワード
福岡開発拠点
関西開発拠点(大阪/京都)

【SNS】
マネーフォワード公式note
Twitter – 【公式】マネーフォワード
Twitter – Money Forward Developers
connpass – マネーフォワード
YouTube – Money Forward Developers

Pocket