Docs header transparent bg

bundle gem

bundle-gem - rubygem を作成するためのプロジェクトのスケルトンを生成する

bundle gem GEM_NAME OPTIONS

説明

GEM_NAME という名前のディレクトリを、RakefileGEM_NAME.gemspec、およびその名前の rubygem を開発するために使用できるその他のサポートファイルとディレクトリとともに生成します。

生成されたプロジェクトで rake -T を実行すると、gem をテストして rubygems.org に公開するために使用できる Rake タスクのリストが表示されます。

生成されたプロジェクトのスケルトンは、以下で説明するように OPTIONS を使用してカスタマイズできます。これらのオプションは、次の名前を使用して Bundler のグローバル設定ファイルで指定することもできます。

  • gem.coc
  • gem.mit
  • gem.test

オプション

  • --exe または -b または --bin: Bundler が、生成された rubygem プロジェクト内にバイナリ実行可能ファイル (exe/GEM_NAME として) を作成するように指定します。このバイナリは GEM_NAME.gemspec マニフェストにも追加されます。この動作はデフォルトでは無効になっています。

  • --no-exe: バイナリを作成しません (グローバル設定で指定された --exe をオーバーライドします)。

  • --coc: 生成されたプロジェクトのルートに CODE_OF_CONDUCT.md ファイルを追加します。このオプションが指定されていない場合は、インタラクティブプロンプトが表示され、その回答は、将来の bundle gem の使用のために Bundler のグローバル設定に保存されます。

  • --no-coc: CODE_OF_CONDUCT.md を作成しません (グローバル設定で指定された --coc をオーバーライドします)。

  • --ext=c, --ext=rust: C または Rust (現在は magnus ベース) 拡張コードのボイラープレートを生成されたプロジェクトに追加します。この動作はデフォルトでは無効になっています。

  • --no-ext: 拡張コードを追加しません (グローバル設定で指定された --ext をオーバーライドします)。

  • --mit: 生成されたプロジェクトのルートにある LICENSE.txt ファイルに MIT ライセンスを追加します。グローバル git 設定の名前が著作権表示に使用されます。このオプションが指定されていない場合は、インタラクティブプロンプトが表示され、その回答は、将来の bundle gem の使用のために Bundler のグローバル設定に保存されます。

  • --no-mit: LICENSE.txt を作成しません (グローバル設定で指定された --mit をオーバーライドします)。

  • -t, --test=minitest, --test=rspec, --test=test-unit: プロジェクトを生成するときに Bundler が使用するテストフレームワークを指定します。使用可能な値は、minitestrspec、および test-unit です。GEM_NAME.gemspec が設定され、このオプションに基づいてスケルトンテスト/spec ディレクトリが作成されます。オプションが指定されていない場合

    Bundler がテストを生成するように設定されている場合、これは Bundler のグローバル設定 gem.test にデフォルト設定されます。

    Bundler がテストを生成しないように設定されている場合は、インタラクティブプロンプトが表示され、その回答は現在の rubygem プロジェクトに使用されます。

    Bundler が設定されていない場合は、インタラクティブプロンプトが表示され、その回答は、将来の bundle gem の使用のために Bundler のグローバル設定に保存されます。

  • --ci, --ci=github, --ci=gitlab, --ci=circle: プロジェクトを生成するときに Bundler が使用する継続的インテグレーションサービスを指定します。使用可能な値は、githubgitlab、および circle です。プロジェクトディレクトリに設定ファイルが生成されます。オプションが指定されていない場合

    Bundler が CI ファイルを生成するように設定されている場合、これは Bundler のグローバル設定 gem.ci にデフォルト設定されます。

    Bundler が CI ファイルを生成しないように設定されている場合は、インタラクティブプロンプトが表示され、その回答は現在の rubygem プロジェクトに使用されます。

    Bundler が設定されていない場合は、インタラクティブプロンプトが表示され、その回答は、将来の bundle gem の使用のために Bundler のグローバル設定に保存されます。

  • --linter, --linter=rubocop, --linter=standard: Bundler がプロジェクトの開発依存関係に追加する必要があるリンターとコードフォーマッタを指定します。使用可能な値は rubocopstandard です。プロジェクトディレクトリに設定ファイルが生成されます。オプションが指定されていない場合

    Bundler がリンターを追加するように設定されている場合、これは Bundler のグローバル設定 gem.linter にデフォルト設定されます。

    Bundler がリンターを追加しないように設定されている場合は、インタラクティブプロンプトが表示され、その回答は現在の rubygem プロジェクトに使用されます。

    Bundler が設定されていない場合は、インタラクティブプロンプトが表示され、その回答は、将来の bundle gem の使用のために Bundler のグローバル設定に保存されます。

  • -e, --edit[=EDITOR]: 結果の GEM_NAME.gemspec を EDITOR で開きます。EDITOR が指定されていない場合はデフォルトのエディターで開きます。デフォルトは $BUNDLER_EDITOR$VISUAL、または $EDITOR です。

参考資料

エラーを発見したり、何か不足していることに気付いた場合は、GitHub でこのドキュメントを編集してください。