bundle-gem
- 生成用于创建 rubygem 的项目骨架
bundle gem
GEM_NAME OPTIONS
生成一个名为 GEM_NAME
的目录,其中包含 Rakefile
、GEM_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
文件。如果未指定此选项,将显示交互式提示,并将答案保存到 Bundler 的全局配置中,以便将来使用 bundle gem
。
--no-coc
:不要创建 CODE_OF_CONDUCT.md
(覆盖全局配置中指定的 --coc
)。
--ext=c
、--ext=rust
:向生成的项目添加 C 或 Rust(目前基于 magnus)扩展代码的样板。默认情况下,此行为被禁用。
--no-ext
:不要添加扩展代码(覆盖全局配置中指定的 --ext
)。
--mit
:在生成的项目的根目录中的 LICENSE.txt
文件中添加 MIT 许可证。您的姓名来自全局 git 配置,用于版权声明。如果未指定此选项,将显示交互式提示,并将答案保存到 Bundler 的全局配置中,以便将来使用 bundle gem
。
--no-mit
:不要创建 LICENSE.txt
(覆盖全局配置中指定的 --mit
)。
-t
、--test=minitest
、--test=rspec
、--test=test-unit
:指定 Bundler 在生成项目时应使用的测试框架。可接受的值为 minitest
、rspec
和 test-unit
。GEM_NAME.gemspec
将被配置,并且将根据此选项创建骨架测试/规范目录。如果未指定任何选项
当 Bundler 配置为生成测试时,这将默认为 Bundler 的全局配置设置 gem.test
。
当 Bundler 配置为不生成测试时,将显示交互式提示,并将答案用于当前的 rubygem 项目。
当 Bundler 未配置时,将显示交互式提示,并将答案保存到 Bundler 的全局配置中,以便将来使用 bundle gem
。
--ci
, --ci=github
, --ci=gitlab
, --ci=circle
: 指定 Bundler 在生成项目时应使用的持续集成服务。可接受的值为 github
、gitlab
和 circle
。将在项目目录中生成一个配置文件。如果没有指定选项
当 Bundler 配置为生成 CI 文件时,这默认为 Bundler 的全局配置设置 gem.ci
。
当 Bundler 配置为不生成 CI 文件时,将显示一个交互式提示,并且答案将用于当前的 rubygem 项目。
当 Bundler 未配置时,将显示交互式提示,并将答案保存到 Bundler 的全局配置中,以便将来使用 bundle gem
。
--linter
, --linter=rubocop
, --linter=standard
: 指定 Bundler 应添加到项目开发依赖项中的 linter 和代码格式化程序。可接受的值为 rubocop
和 standard
。将在项目目录中生成一个配置文件。如果没有指定选项
当 Bundler 配置为添加 linter 时,这默认为 Bundler 的全局配置设置 gem.linter
。
当 Bundler 配置为不添加 linter 时,将显示一个交互式提示,并且答案将用于当前的 rubygem 项目。
当 Bundler 未配置时,将显示交互式提示,并将答案保存到 Bundler 的全局配置中,以便将来使用 bundle gem
。
-e
, --edit[=EDITOR]
: 在 EDITOR 中打开生成的 GEM_NAME.gemspec,或者如果没有指定,则打开默认编辑器。默认值为 $BUNDLER_EDITOR
、$VISUAL
或 $EDITOR
。