1
0
Fork 0
mirror of https://github.com/ruby/ruby.git synced 2022-11-09 12:17:21 -05:00
ruby--ruby/man/bundle-gem.1.txt
hsbt e97741e12a Merge Bundler 2.0.1 from upstream.
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@66710 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2019-01-04 13:10:58 +00:00

91 lines
3.3 KiB
Text

BUNDLE-GEM(1) BUNDLE-GEM(1)
1mNAME0m
1mbundle-gem 22m- Generate a project skeleton for creating a rubygem
1mSYNOPSIS0m
1mbundle gem 4m22mGEM_NAME24m 4mOPTIONS0m
1mDESCRIPTION0m
Generates a directory named 1mGEM_NAME 22mwith a 1mRakefile22m, 1mGEM_NAME.gemspec22m,
and other supporting files and directories that can be used to develop
a rubygem with that name.
Run 1mrake -T 22min the resulting project for a list of Rake tasks that can
be used to test and publish the gem to rubygems.org.
The generated project skeleton can be customized with OPTIONS, as ex-
plained below. Note that these options can also be specified via
Bundler's global configuration file using the following names:
o 1mgem.coc0m
o 1mgem.mit0m
o 1mgem.test0m
1mOPTIONS0m
1m--exe 22mor 1m-b 22mor 1m--bin0m
Specify that Bundler should create a binary executable (as
1mexe/GEM_NAME22m) in the generated rubygem project. This binary will
also be added to the 1mGEM_NAME.gemspec 22mmanifest. This behavior is
disabled by default.
1m--no-exe0m
Do not create a binary (overrides 1m--exe 22mspecified in the global
config).
1m--coc 22mAdd a 1mCODE_OF_CONDUCT.md 22mfile to the root of the generated
project. If this option is unspecified, an interactive prompt
will be displayed and the answer will be saved in Bundler's
global config for future 1mbundle gem 22muse.
1m--no-coc0m
Do not create a 1mCODE_OF_CONDUCT.md 22m(overrides 1m--coc 22mspecified in
the global config).
1m--ext 22mAdd boilerplate for C extension code to the generated project.
This behavior is disabled by default.
1m--no-ext0m
Do not add C extension code (overrides 1m--ext 22mspecified in the
global config).
1m--mit 22mAdd an MIT license to a 1mLICENSE.txt 22mfile in the root of the gen-
erated project. Your name from the global git config is used for
the copyright statement. If this option is unspecified, an in-
teractive prompt will be displayed and the answer will be saved
in Bundler's global config for future 1mbundle gem 22muse.
1m--no-mit0m
Do not create a 1mLICENSE.txt 22m(overrides 1m--mit 22mspecified in the
global config).
1m-t22m, 1m--test=minitest22m, 1m--test=rspec0m
Specify the test framework that Bundler should use when generat-
ing the project. Acceptable values are 1mminitest 22mand 1mrspec22m. The
1mGEM_NAME.gemspec 22mwill be configured and a skeleton test/spec di-
rectory will be created based on this option. If this option is
unspecified, an interactive prompt will be displayed and the an-
swer will be saved in Bundler's global config for future 1mbundle0m
1mgem 22muse. If no option is specified, the default testing frame-
work is RSpec.
1m-e22m, 1m--edit[=EDITOR]0m
Open the resulting GEM_NAME.gemspec in EDITOR, or the default
editor if not specified. The default is 1m$BUNDLER_EDITOR22m, 1m$VIS-0m
1mUAL22m, or 1m$EDITOR22m.
1mSEE ALSO0m
o bundle config(1) 4mbundle-config.1.html0m
November 2018 BUNDLE-GEM(1)