💨
プリケーションをセットアップや実行する際に便利なオプション
rails コマンドには、アプリケーションをセットアップや実行する際に便利なオプションが多数あります。以下は、その中でよく使われる主要なオプションのまとめです。
1. --api
- 用途: API専用のアプリケーションを作成する。
- 説明: ビューやアセットパイプラインなどのWebアプリケーション向けの機能を省略し、JSONレスポンスを返すAPIアプリケーションを作成します。
-
使用例:
rails new my_api_app --api
2. --skip-active-record
- 用途: ActiveRecordをスキップしてアプリケーションを作成。
- 説明: データベースを使わない場合に、ActiveRecord（RailsのORM）をスキップして、データベース関連の設定を避けます。
-
使用例:
rails new my_app --skip-active-record
3. --skip-turbolinks
- 用途: Turbolinksをスキップ。
- 説明: Turbolinksはページ遷移時に全体の再読み込みを避けるために使用されますが、これを無効にして、通常のページ遷移動作を使います。
-
使用例:
rails new my_app --skip-turbolinks
4. --skip-javascript
- 用途: JavaScript関連の設定をスキップ。
- 説明: JavaScriptを使用しない場合に、関連する設定やファイルをスキップします。
-
使用例:
rails new my_app --skip-javascript
5. --skip-test
- 用途: テスト関連の設定をスキップ。
- 説明: テストフレームワーク（RSpecなど）を使わない場合に、Railsのデフォルトテスト関連設定をスキップします。
-
使用例:
rails new my_app --skip-test
6. --skip-bundle
- 用途: Gemのインストールをスキップ。
-
説明: 新しいRailsアプリケーションを作成後、
bundle installをスキップします。 -
使用例:
rails new my_app --skip-bundle
7. --skip-spring
- 用途: Spring（アプリケーションの高速化ツール）をスキップ。
- 説明: Springを使わず、通常のRailsの起動動作に戻します。
-
使用例:
rails new my_app --skip-spring
8. --skip-git
- 用途: Gitの初期化をスキップ。
- 説明: アプリケーション作成時に自動的にGitリポジトリを初期化しないようにします。
-
使用例:
rails new my_app --skip-git
9. --skip-active-storage
- 用途: ActiveStorageをスキップ。
- 説明: ファイルのアップロードやストレージ関連の機能を無効にします。
-
使用例:
rails new my_app --skip-active-storage
10. --skip-action-mailer
- 用途: ActionMailerをスキップ。
- 説明: メール送信機能を使わない場合に、メール関連の設定をスキップします。
-
使用例:
rails new my_app --skip-action-mailer
11. --skip-sprockets
- 用途: Sprockets（アセットパイプライン）をスキップ。
- 説明: Sprocketsを使わず、Webpackerを利用したJavaScriptやCSSの管理を行う場合に使用します。
-
使用例:
rails new my_app --skip-sprockets
12. --skip-bootsnap
- 用途: Bootsnapをスキップ。
- 説明: BootsnapはRailsの起動速度を向上させるために使用されるライブラリで、これを無効にする場合に使用します。
-
使用例:
rails new my_app --skip-bootsnap
13. --skip-action-cable
- 用途: ActionCableをスキップ。
- 説明: WebSocketやリアルタイム通信機能であるActionCableを使わない場合にスキップします。
-
使用例:
rails new my_app --skip-action-cable
14. --skip-puma
- 用途: Pumaをスキップ。
- 説明: RailsのデフォルトWebサーバであるPumaを使わない場合に使用します。
-
使用例:
rails new my_app --skip-puma
15. --skip-webpack-install
- 用途: Webpackerの依存関係インストールをスキップ。
- 説明: Webpackerを使用する際に、依存するNode.jsのパッケージのインストールをスキップします。
-
使用例:
rails new my_app --skip-webpack-install
16. --edge
- 用途: Railsの最新開発版を使用。
- 説明: Railsの最新の開発版（未リリースの最新版）を使ってアプリケーションを作成します。
-
使用例:
rails new my_app --edge
17. --help
- 用途: コマンドのヘルプを表示。
- 説明: 使用可能なオプションやコマンドの詳細を表示します。
-
使用例:
rails new --help
まとめ
Railsには、アプリケーションの作成や設定に役立つオプションが豊富にあります。これらを使いこなすことで、アプリケーションを自分の目的に合わせて柔軟にカスタマイズすることができます。例えば、API専用のアプリケーションを作成したい場合は --api オプション、データベースを使わない場合は --skip-active-record といった具合です。
Discussion