bundler 1.16.1 → 1.17.3
Sign up to get free protection for your applications and to get access to all the features.
Potentially problematic release.
This version of bundler might be problematic. Click here for more details.
- checksums.yaml +5 -5
- data/CHANGELOG.md +195 -0
- data/README.md +5 -1
- data/bundler.gemspec +9 -2
- data/lib/bundler/build_metadata.rb +19 -4
- data/lib/bundler/cli/add.rb +15 -5
- data/lib/bundler/cli/binstubs.rb +8 -2
- data/lib/bundler/cli/check.rb +1 -1
- data/lib/bundler/cli/doctor.rb +47 -1
- data/lib/bundler/cli/exec.rb +4 -4
- data/lib/bundler/cli/gem.rb +5 -2
- data/lib/bundler/cli/init.rb +5 -0
- data/lib/bundler/cli/install.rb +10 -7
- data/lib/bundler/cli/list.rb +41 -5
- data/lib/bundler/cli/outdated.rb +8 -2
- data/lib/bundler/cli/pristine.rb +4 -0
- data/lib/bundler/cli/remove.rb +18 -0
- data/lib/bundler/cli/update.rb +3 -3
- data/lib/bundler/cli.rb +66 -22
- data/lib/bundler/compact_index_client/updater.rb +10 -1
- data/lib/bundler/current_ruby.rb +8 -1
- data/lib/bundler/definition.rb +48 -39
- data/lib/bundler/dep_proxy.rb +2 -2
- data/lib/bundler/dependency.rb +3 -2
- data/lib/bundler/deprecate.rb +2 -1
- data/lib/bundler/dsl.rb +19 -3
- data/lib/bundler/endpoint_specification.rb +1 -1
- data/lib/bundler/env.rb +10 -8
- data/lib/bundler/feature_flag.rb +7 -0
- data/lib/bundler/fetcher/downloader.rb +10 -5
- data/lib/bundler/fetcher/index.rb +2 -2
- data/lib/bundler/fetcher.rb +3 -3
- data/lib/bundler/friendly_errors.rb +2 -0
- data/lib/bundler/gem_helper.rb +1 -1
- data/lib/bundler/gem_version_promoter.rb +16 -2
- data/lib/bundler/injector.rb +173 -14
- data/lib/bundler/installer/gem_installer.rb +9 -2
- data/lib/bundler/installer/parallel_installer.rb +6 -1
- data/lib/bundler/installer.rb +41 -10
- data/lib/bundler/lazy_specification.rb +1 -1
- data/lib/bundler/mirror.rb +2 -2
- data/lib/bundler/plugin/events.rb +61 -0
- data/lib/bundler/plugin/index.rb +7 -2
- data/lib/bundler/plugin.rb +12 -5
- data/lib/bundler/process_lock.rb +1 -1
- data/lib/bundler/resolver/spec_group.rb +0 -5
- data/lib/bundler/resolver.rb +11 -10
- data/lib/bundler/ruby_version.rb +1 -1
- data/lib/bundler/rubygems_gem_installer.rb +7 -0
- data/lib/bundler/rubygems_integration.rb +9 -3
- data/lib/bundler/runtime.rb +10 -4
- data/lib/bundler/settings/validator.rb +23 -0
- data/lib/bundler/settings.rb +24 -3
- data/lib/bundler/shared_helpers.rb +33 -5
- data/lib/bundler/source/git/git_proxy.rb +6 -1
- data/lib/bundler/source/git.rb +2 -1
- data/lib/bundler/source/metadata.rb +2 -3
- data/lib/bundler/source/rubygems/remote.rb +4 -1
- data/lib/bundler/source/rubygems.rb +11 -2
- data/lib/bundler/source.rb +9 -9
- data/lib/bundler/spec_set.rb +4 -1
- data/lib/bundler/templates/Executable +1 -1
- data/lib/bundler/templates/newgem/lib/newgem.rb.tt +1 -0
- data/lib/bundler/templates/newgem/newgem.gemspec.tt +8 -2
- data/lib/bundler/templates/newgem/travis.yml.tt +2 -0
- data/lib/bundler/ui/shell.rb +3 -1
- data/lib/bundler/vendor/molinillo/lib/molinillo/dependency_graph/vertex.rb +11 -1
- data/lib/bundler/vendor/molinillo/lib/molinillo/errors.rb +7 -2
- data/lib/bundler/vendor/molinillo/lib/molinillo/gem_metadata.rb +1 -1
- data/lib/bundler/version.rb +1 -1
- data/lib/bundler.rb +38 -16
- data/man/bundle-add.1 +18 -3
- data/man/bundle-add.1.txt +17 -5
- data/man/bundle-add.ronn +13 -2
- data/man/bundle-binstubs.1 +4 -4
- data/man/bundle-binstubs.1.txt +4 -4
- data/man/bundle-binstubs.ronn +3 -3
- data/man/bundle-check.1 +4 -4
- data/man/bundle-check.1.txt +6 -5
- data/man/bundle-check.ronn +3 -3
- data/man/bundle-clean.1 +1 -1
- data/man/bundle-clean.1.txt +1 -1
- data/man/bundle-config.1 +48 -6
- data/man/bundle-config.1.txt +64 -26
- data/man/bundle-config.ronn +34 -9
- data/man/bundle-doctor.1 +44 -0
- data/man/bundle-doctor.1.txt +44 -0
- data/man/bundle-doctor.ronn +33 -0
- data/man/bundle-exec.1 +4 -4
- data/man/bundle-exec.1.txt +9 -9
- data/man/bundle-exec.ronn +3 -3
- data/man/bundle-gem.1 +2 -2
- data/man/bundle-gem.1.txt +2 -2
- data/man/bundle-gem.ronn +1 -1
- data/man/bundle-info.1 +1 -1
- data/man/bundle-info.1.txt +1 -1
- data/man/bundle-init.1 +9 -4
- data/man/bundle-init.1.txt +16 -6
- data/man/bundle-init.ronn +15 -4
- data/man/bundle-inject.1 +4 -4
- data/man/bundle-inject.1.txt +5 -5
- data/man/bundle-inject.ronn +3 -3
- data/man/bundle-install.1 +7 -4
- data/man/bundle-install.1.txt +119 -108
- data/man/bundle-install.ronn +13 -4
- data/man/bundle-list.1 +32 -2
- data/man/bundle-list.1.txt +24 -2
- data/man/bundle-list.ronn +19 -1
- data/man/bundle-lock.1 +2 -2
- data/man/bundle-lock.1.txt +2 -2
- data/man/bundle-lock.ronn +1 -1
- data/man/bundle-open.1 +1 -1
- data/man/bundle-open.1.txt +1 -1
- data/man/bundle-outdated.1 +7 -3
- data/man/bundle-outdated.1.txt +11 -7
- data/man/bundle-outdated.ronn +5 -1
- data/man/bundle-package.1 +3 -3
- data/man/bundle-package.1.txt +6 -6
- data/man/bundle-package.ronn +3 -3
- data/man/bundle-platform.1 +1 -1
- data/man/bundle-platform.1.txt +1 -1
- data/man/bundle-pristine.1 +1 -1
- data/man/bundle-pristine.1.txt +1 -1
- data/man/bundle-remove.1 +31 -0
- data/man/bundle-remove.1.txt +34 -0
- data/man/bundle-remove.ronn +23 -0
- data/man/bundle-show.1 +3 -3
- data/man/bundle-show.1.txt +6 -4
- data/man/bundle-show.ronn +3 -2
- data/man/bundle-update.1 +17 -13
- data/man/bundle-update.1.txt +68 -63
- data/man/bundle-update.ronn +19 -15
- data/man/bundle-viz.1 +2 -2
- data/man/bundle-viz.1.txt +3 -2
- data/man/bundle-viz.ronn +1 -1
- data/man/bundle.1 +32 -28
- data/man/bundle.1.txt +31 -28
- data/man/bundle.ronn +30 -27
- data/man/gemfile.5 +19 -9
- data/man/gemfile.5.ronn +24 -9
- data/man/gemfile.5.txt +114 -97
- data/man/index.txt +2 -0
- metadata +16 -3
data/man/bundle-config.1
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
.\" generated with Ronn/v0.7.3
|
2
2
|
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
3
3
|
.
|
4
|
-
.TH "BUNDLE\-CONFIG" "1" "December
|
4
|
+
.TH "BUNDLE\-CONFIG" "1" "December 2018" "" ""
|
5
5
|
.
|
6
6
|
.SH "NAME"
|
7
7
|
\fBbundle\-config\fR \- Set bundler configuration options
|
@@ -10,7 +10,24 @@
|
|
10
10
|
\fBbundle config\fR [\fIname\fR [\fIvalue\fR]]
|
11
11
|
.
|
12
12
|
.SH "DESCRIPTION"
|
13
|
-
This command allows you to interact with
|
13
|
+
This command allows you to interact with Bundler\'s configuration system\.
|
14
|
+
.
|
15
|
+
.P
|
16
|
+
Bundler loads configuration settings in this order:
|
17
|
+
.
|
18
|
+
.IP "1." 4
|
19
|
+
Local config (\fBapp/\.bundle/config\fR)
|
20
|
+
.
|
21
|
+
.IP "2." 4
|
22
|
+
Environmental variables (\fBENV\fR)
|
23
|
+
.
|
24
|
+
.IP "3." 4
|
25
|
+
Global config (\fB~/\.bundle/config\fR)
|
26
|
+
.
|
27
|
+
.IP "4." 4
|
28
|
+
Bundler default config
|
29
|
+
.
|
30
|
+
.IP "" 0
|
14
31
|
.
|
15
32
|
.P
|
16
33
|
Executing \fBbundle config\fR with no parameters will print a list of all bundler configuration for the current bundle, and where that configuration was set\.
|
@@ -63,7 +80,7 @@ A space\-separated list of groups referencing gems to skip during installation\.
|
|
63
80
|
A space\-separated list of groups referencing gems to include during installation\.
|
64
81
|
.
|
65
82
|
.SH "BUILD OPTIONS"
|
66
|
-
You can use \fBbundle config\fR to give
|
83
|
+
You can use \fBbundle config\fR to give Bundler the flags to pass to the gem installer every time bundler tries to install a particular gem\.
|
67
84
|
.
|
68
85
|
.P
|
69
86
|
A very common example, the \fBmysql\fR gem, requires Snow Leopard users to pass configuration flags to \fBgem install\fR to specify where to find the \fBmysql_config\fR executable\.
|
@@ -98,7 +115,7 @@ After running this command, every time bundler needs to install the \fBmysql\fR
|
|
98
115
|
Configuration keys in bundler have two forms: the canonical form and the environment variable form\.
|
99
116
|
.
|
100
117
|
.P
|
101
|
-
For instance, passing the \fB\-\-without\fR flag to
|
118
|
+
For instance, passing the \fB\-\-without\fR flag to bundle install(1) \fIbundle\-install\.1\.html\fR prevents Bundler from installing certain groups specified in the Gemfile(5)\. Bundler persists this value in \fBapp/\.bundle/config\fR so that calls to \fBBundler\.setup\fR do not try to find gems from the \fBGemfile\fR that you didn\'t install\. Additionally, subsequent calls to bundle install(1) \fIbundle\-install\.1\.html\fR remember this setting and skip those groups\.
|
102
119
|
.
|
103
120
|
.P
|
104
121
|
The canonical form of this configuration is \fB"without"\fR\. To convert the canonical form to the environment variable form, capitalize it, and prepend \fBBUNDLE_\fR\. The environment variable form of \fB"without"\fR is \fBBUNDLE_WITHOUT\fR\.
|
@@ -107,7 +124,7 @@ The canonical form of this configuration is \fB"without"\fR\. To convert the can
|
|
107
124
|
Any periods in the configuration keys must be replaced with two underscores when setting it via environment variables\. The configuration key \fBlocal\.rack\fR becomes the environment variable \fBBUNDLE_LOCAL__RACK\fR\.
|
108
125
|
.
|
109
126
|
.SH "LIST OF AVAILABLE KEYS"
|
110
|
-
The following is a list of all configuration keys and their purpose\. You can learn more about their operation in
|
127
|
+
The following is a list of all configuration keys and their purpose\. You can learn more about their operation in bundle install(1) \fIbundle\-install\.1\.html\fR\.
|
111
128
|
.
|
112
129
|
.IP "\(bu" 4
|
113
130
|
\fBallow_bundler_dependency_conflicts\fR (\fBBUNDLE_ALLOW_BUNDLER_DEPENDENCY_CONFLICTS\fR): Allow resolving to specifications that have dependencies on \fBbundler\fR that are incompatible with the running Bundler version\.
|
@@ -161,6 +178,9 @@ The following is a list of all configuration keys and their purpose\. You can le
|
|
161
178
|
\fBdisable_multisource\fR (\fBBUNDLE_DISABLE_MULTISOURCE\fR): When set, Gemfiles containing multiple sources will produce errors instead of warnings\. Use \fBbundle config \-\-delete disable_multisource\fR to unset\.
|
162
179
|
.
|
163
180
|
.IP "\(bu" 4
|
181
|
+
\fBdisable_platform_warnings\fR (\fBBUNDLE_DISABLE_PLATFORM_WARNINGS\fR): Disable warnings during bundle install when a dependency is unused on the current platform\.
|
182
|
+
.
|
183
|
+
.IP "\(bu" 4
|
164
184
|
\fBdisable_shared_gems\fR (\fBBUNDLE_DISABLE_SHARED_GEMS\fR): Stop Bundler from accessing gems installed to RubyGems\' normal location\.
|
165
185
|
.
|
166
186
|
.IP "\(bu" 4
|
@@ -185,6 +205,9 @@ The following is a list of all configuration keys and their purpose\. You can le
|
|
185
205
|
\fBglobal_gem_cache\fR (\fBBUNDLE_GLOBAL_GEM_CACHE\fR): Whether Bundler should cache all gems globally, rather than locally to the installing Ruby installation\.
|
186
206
|
.
|
187
207
|
.IP "\(bu" 4
|
208
|
+
\fBglobal_path_appends_ruby_scope\fR (\fBBUNDLE_GLOBAL_PATH_APPENDS_RUBY_SCOPE\fR): Whether Bundler should append the Ruby scope (e\.g\. engine and ABI version) to a globally\-configured path\.
|
209
|
+
.
|
210
|
+
.IP "\(bu" 4
|
188
211
|
\fBignore_messages\fR (\fBBUNDLE_IGNORE_MESSAGES\fR): When set, no post install messages will be printed\. To silence a single gem, use dot notation like \fBignore_messages\.httparty true\fR\.
|
189
212
|
.
|
190
213
|
.IP "\(bu" 4
|
@@ -215,6 +238,9 @@ The following is a list of all configuration keys and their purpose\. You can le
|
|
215
238
|
\fBpath\.system\fR (\fBBUNDLE_PATH__SYSTEM\fR): Whether Bundler will install gems into the default system path (\fBGem\.dir\fR)\.
|
216
239
|
.
|
217
240
|
.IP "\(bu" 4
|
241
|
+
\fBpath_relative_to_cwd\fR (\fBPATH_RELATIVE_TO_CWD\fR) Makes \fB\-\-path\fR relative to the CWD instead of the \fBGemfile\fR\.
|
242
|
+
.
|
243
|
+
.IP "\(bu" 4
|
218
244
|
\fBplugins\fR (\fBBUNDLE_PLUGINS\fR): Enable Bundler\'s experimental plugin system\.
|
219
245
|
.
|
220
246
|
.IP "\(bu" 4
|
@@ -280,7 +306,7 @@ The following is a list of all configuration keys and their purpose\. You can le
|
|
280
306
|
.IP "" 0
|
281
307
|
.
|
282
308
|
.P
|
283
|
-
In general, you should set these settings per\-application by using the applicable flag to the
|
309
|
+
In general, you should set these settings per\-application by using the applicable flag to the bundle install(1) \fIbundle\-install\.1\.html\fR or bundle package(1) \fIbundle\-package\.1\.html\fR command\.
|
284
310
|
.
|
285
311
|
.P
|
286
312
|
You can set them globally either via environment variables or \fBbundle config\fR, whichever is preferable for your setup\. If you use both, environment variables will take preference over global settings\.
|
@@ -452,4 +478,20 @@ export BUNDLE_GITHUB__COM=abcd0123generatedtoken:x\-oauth\-basic
|
|
452
478
|
.fi
|
453
479
|
.
|
454
480
|
.IP "" 0
|
481
|
+
.
|
482
|
+
.SH "CONFIGURE BUNDLER DIRECTORIES"
|
483
|
+
Bundler\'s home, config, cache and plugin directories are able to be configured through environment variables\. The default location for Bundler\'s home directory is \fB~/\.bundle\fR, which all directories inherit from by default\. The following outlines the available environment variables and their default values
|
484
|
+
.
|
485
|
+
.IP "" 4
|
486
|
+
.
|
487
|
+
.nf
|
488
|
+
|
489
|
+
BUNDLE_USER_HOME : $HOME/\.bundle
|
490
|
+
BUNDLE_USER_CACHE : $BUNDLE_USER_HOME/cache
|
491
|
+
BUNDLE_USER_CONFIG : $BUNDLE_USER_HOME/config
|
492
|
+
BUNDLE_USER_PLUGIN : $BUNDLE_USER_HOME/plugin
|
493
|
+
.
|
494
|
+
.fi
|
495
|
+
.
|
496
|
+
.IP "" 0
|
455
497
|
|
data/man/bundle-config.1.txt
CHANGED
@@ -9,10 +9,20 @@ SYNOPSIS
|
|
9
9
|
bundle config [name [value]]
|
10
10
|
|
11
11
|
DESCRIPTION
|
12
|
-
This command allows you to interact with
|
13
|
-
tem.
|
14
|
-
|
15
|
-
|
12
|
+
This command allows you to interact with Bundler's configuration sys-
|
13
|
+
tem.
|
14
|
+
|
15
|
+
Bundler loads configuration settings in this order:
|
16
|
+
|
17
|
+
1. Local config (app/.bundle/config)
|
18
|
+
|
19
|
+
2. Environmental variables (ENV)
|
20
|
+
|
21
|
+
3. Global config (~/.bundle/config)
|
22
|
+
|
23
|
+
4. Bundler default config
|
24
|
+
|
25
|
+
|
16
26
|
|
17
27
|
Executing bundle config with no parameters will print a list of all
|
18
28
|
bundler configuration for the current bundle, and where that configura-
|
@@ -81,7 +91,7 @@ REMEMBERING OPTIONS
|
|
81
91
|
during installation.
|
82
92
|
|
83
93
|
BUILD OPTIONS
|
84
|
-
You can use bundle config to give
|
94
|
+
You can use bundle config to give Bundler the flags to pass to the gem
|
85
95
|
installer every time bundler tries to install a particular gem.
|
86
96
|
|
87
97
|
A very common example, the mysql gem, requires Snow Leopard users to
|
@@ -110,13 +120,13 @@ CONFIGURATION KEYS
|
|
110
120
|
Configuration keys in bundler have two forms: the canonical form and
|
111
121
|
the environment variable form.
|
112
122
|
|
113
|
-
For instance, passing the
|
114
|
-
dle-install
|
115
|
-
in
|
116
|
-
that calls to Bundler.setup do not try to find gems from
|
117
|
-
that
|
118
|
-
install(1)
|
119
|
-
groups.
|
123
|
+
For instance, passing the --without flag to bundle install(1) bun-
|
124
|
+
dle-install.1.html prevents Bundler from installing certain groups
|
125
|
+
specified in the Gemfile(5). Bundler persists this value in app/.bun-
|
126
|
+
dle/config so that calls to Bundler.setup do not try to find gems from
|
127
|
+
the Gemfile that you didn't install. Additionally, subsequent calls to
|
128
|
+
bundle install(1) bundle-install.1.html remember this setting and skip
|
129
|
+
those groups.
|
120
130
|
|
121
131
|
The canonical form of this configuration is "without". To convert the
|
122
132
|
canonical form to the environment variable form, capitalize it, and
|
@@ -129,8 +139,8 @@ CONFIGURATION KEYS
|
|
129
139
|
|
130
140
|
LIST OF AVAILABLE KEYS
|
131
141
|
The following is a list of all configuration keys and their purpose.
|
132
|
-
You can learn more
|
133
|
-
dle-install
|
142
|
+
You can learn more about their operation in bundle install(1) bun-
|
143
|
+
dle-install.1.html.
|
134
144
|
|
135
145
|
o allow_bundler_dependency_conflicts (BUNDLE_ALLOW_BUNDLER_DEPEN-
|
136
146
|
DENCY_CONFLICTS): Allow resolving to specifications that have
|
@@ -195,6 +205,10 @@ LIST OF AVAILABLE KEYS
|
|
195
205
|
files containing multiple sources will produce errors instead of
|
196
206
|
warnings. Use bundle config --delete disable_multisource to unset.
|
197
207
|
|
208
|
+
o disable_platform_warnings (BUNDLE_DISABLE_PLATFORM_WARNINGS): Dis-
|
209
|
+
able warnings during bundle install when a dependency is unused on
|
210
|
+
the current platform.
|
211
|
+
|
198
212
|
o disable_shared_gems (BUNDLE_DISABLE_SHARED_GEMS): Stop Bundler from
|
199
213
|
accessing gems installed to RubyGems' normal location.
|
200
214
|
|
@@ -228,41 +242,49 @@ LIST OF AVAILABLE KEYS
|
|
228
242
|
cache all gems globally, rather than locally to the installing Ruby
|
229
243
|
installation.
|
230
244
|
|
245
|
+
o global_path_appends_ruby_scope (BUN-
|
246
|
+
DLE_GLOBAL_PATH_APPENDS_RUBY_SCOPE): Whether Bundler should append
|
247
|
+
the Ruby scope (e.g. engine and ABI version) to a globally-config-
|
248
|
+
ured path.
|
249
|
+
|
231
250
|
o ignore_messages (BUNDLE_IGNORE_MESSAGES): When set, no post install
|
232
251
|
messages will be printed. To silence a single gem, use dot notation
|
233
252
|
like ignore_messages.httparty true.
|
234
253
|
|
235
|
-
o init_gems_rb
|
254
|
+
o init_gems_rb (BUNDLE_INIT_GEMS_RB) Generate a gems.rb instead of a
|
236
255
|
Gemfile when running bundle init.
|
237
256
|
|
238
|
-
o jobs
|
257
|
+
o jobs (BUNDLE_JOBS): The number of gems Bundler can install in par-
|
239
258
|
allel. Defaults to 1.
|
240
259
|
|
241
260
|
o list_command (BUNDLE_LIST_COMMAND) Enable new list command feature
|
242
261
|
|
243
|
-
o major_deprecations
|
262
|
+
o major_deprecations (BUNDLE_MAJOR_DEPRECATIONS): Whether Bundler
|
244
263
|
should print deprecation warnings for behavior that will be changed
|
245
264
|
in the next major version.
|
246
265
|
|
247
|
-
o no_install
|
266
|
+
o no_install (BUNDLE_NO_INSTALL): Whether bundle package should skip
|
248
267
|
installing gems.
|
249
268
|
|
250
|
-
o no_prune
|
269
|
+
o no_prune (BUNDLE_NO_PRUNE): Whether Bundler should leave outdated
|
251
270
|
gems unpruned when caching.
|
252
271
|
|
253
272
|
o only_update_to_newer_versions (BUNDLE_ONLY_UPDATE_TO_NEWER_VER-
|
254
273
|
SIONS): During bundle update, only resolve to newer versions of the
|
255
274
|
gems in the lockfile.
|
256
275
|
|
257
|
-
o path
|
276
|
+
o path (BUNDLE_PATH): The location on disk where all gems in your
|
258
277
|
bundle will be located regardless of $GEM_HOME or $GEM_PATH values.
|
259
|
-
Bundle
|
260
|
-
install.
|
278
|
+
Bundle gems not found in this location will be installed by bundle
|
279
|
+
install. Defaults to Gem.dir. When --deployment is used, defaults
|
261
280
|
to vendor/bundle.
|
262
281
|
|
263
|
-
o path.system
|
282
|
+
o path.system (BUNDLE_PATH__SYSTEM): Whether Bundler will install
|
264
283
|
gems into the default system path (Gem.dir).
|
265
284
|
|
285
|
+
o path_relative_to_cwd (PATH_RELATIVE_TO_CWD) Makes --path relative
|
286
|
+
to the CWD instead of the Gemfile.
|
287
|
+
|
266
288
|
o plugins (BUNDLE_PLUGINS): Enable Bundler's experimental plugin sys-
|
267
289
|
tem.
|
268
290
|
|
@@ -342,8 +364,8 @@ LIST OF AVAILABLE KEYS
|
|
342
364
|
|
343
365
|
|
344
366
|
In general, you should set these settings per-application by using the
|
345
|
-
applicable flag
|
346
|
-
package(1)
|
367
|
+
applicable flag to the bundle install(1) bundle-install.1.html or bun-
|
368
|
+
dle package(1) bundle-package.1.html command.
|
347
369
|
|
348
370
|
You can set them globally either via environment variables or bundle
|
349
371
|
config, whichever is preferable for your setup. If you use both, envi-
|
@@ -485,7 +507,23 @@ CREDENTIALS FOR GEM SOURCES
|
|
485
507
|
|
486
508
|
|
487
509
|
|
510
|
+
CONFIGURE BUNDLER DIRECTORIES
|
511
|
+
Bundler's home, config, cache and plugin directories are able to be
|
512
|
+
configured through environment variables. The default location for
|
513
|
+
Bundler's home directory is ~/.bundle, which all directories inherit
|
514
|
+
from by default. The following outlines the available environment vari-
|
515
|
+
ables and their default values
|
516
|
+
|
517
|
+
|
518
|
+
|
519
|
+
BUNDLE_USER_HOME : $HOME/.bundle
|
520
|
+
BUNDLE_USER_CACHE : $BUNDLE_USER_HOME/cache
|
521
|
+
BUNDLE_USER_CONFIG : $BUNDLE_USER_HOME/config
|
522
|
+
BUNDLE_USER_PLUGIN : $BUNDLE_USER_HOME/plugin
|
523
|
+
|
524
|
+
|
525
|
+
|
488
526
|
|
489
527
|
|
490
528
|
|
491
|
-
December
|
529
|
+
December 2018 BUNDLE-CONFIG(1)
|
data/man/bundle-config.ronn
CHANGED
@@ -7,10 +7,14 @@ bundle-config(1) -- Set bundler configuration options
|
|
7
7
|
|
8
8
|
## DESCRIPTION
|
9
9
|
|
10
|
-
This command allows you to interact with
|
11
|
-
|
12
|
-
|
13
|
-
|
10
|
+
This command allows you to interact with Bundler's configuration system.
|
11
|
+
|
12
|
+
Bundler loads configuration settings in this order:
|
13
|
+
|
14
|
+
1. Local config (`app/.bundle/config`)
|
15
|
+
2. Environmental variables (`ENV`)
|
16
|
+
3. Global config (`~/.bundle/config`)
|
17
|
+
4. Bundler default config
|
14
18
|
|
15
19
|
Executing `bundle config` with no parameters will print a list of all
|
16
20
|
bundler configuration for the current bundle, and where that configuration
|
@@ -76,7 +80,7 @@ The options that can be configured are:
|
|
76
80
|
|
77
81
|
## BUILD OPTIONS
|
78
82
|
|
79
|
-
You can use `bundle config` to give
|
83
|
+
You can use `bundle config` to give Bundler the flags to pass to the gem
|
80
84
|
installer every time bundler tries to install a particular gem.
|
81
85
|
|
82
86
|
A very common example, the `mysql` gem, requires Snow Leopard users to
|
@@ -98,11 +102,11 @@ After running this command, every time bundler needs to install the
|
|
98
102
|
Configuration keys in bundler have two forms: the canonical form and the
|
99
103
|
environment variable form.
|
100
104
|
|
101
|
-
For instance, passing the `--without` flag to [bundle install(1)]
|
105
|
+
For instance, passing the `--without` flag to [bundle install(1)](bundle-install.1.html)
|
102
106
|
prevents Bundler from installing certain groups specified in the Gemfile(5). Bundler
|
103
107
|
persists this value in `app/.bundle/config` so that calls to `Bundler.setup`
|
104
108
|
do not try to find gems from the `Gemfile` that you didn't install. Additionally,
|
105
|
-
subsequent calls to [bundle install(1)]
|
109
|
+
subsequent calls to [bundle install(1)](bundle-install.1.html) remember this setting
|
106
110
|
and skip those groups.
|
107
111
|
|
108
112
|
The canonical form of this configuration is `"without"`. To convert the canonical
|
@@ -116,7 +120,7 @@ the environment variable `BUNDLE_LOCAL__RACK`.
|
|
116
120
|
## LIST OF AVAILABLE KEYS
|
117
121
|
|
118
122
|
The following is a list of all configuration keys and their purpose. You can
|
119
|
-
learn more about their operation in [bundle install(1)]
|
123
|
+
learn more about their operation in [bundle install(1)](bundle-install.1.html).
|
120
124
|
|
121
125
|
* `allow_bundler_dependency_conflicts` (`BUNDLE_ALLOW_BUNDLER_DEPENDENCY_CONFLICTS`):
|
122
126
|
Allow resolving to specifications that have dependencies on `bundler` that
|
@@ -166,6 +170,8 @@ learn more about their operation in [bundle install(1)][bundle-install].
|
|
166
170
|
When set, Gemfiles containing multiple sources will produce errors
|
167
171
|
instead of warnings.
|
168
172
|
Use `bundle config --delete disable_multisource` to unset.
|
173
|
+
* `disable_platform_warnings` (`BUNDLE_DISABLE_PLATFORM_WARNINGS`):
|
174
|
+
Disable warnings during bundle install when a dependency is unused on the current platform.
|
169
175
|
* `disable_shared_gems` (`BUNDLE_DISABLE_SHARED_GEMS`):
|
170
176
|
Stop Bundler from accessing gems installed to RubyGems' normal location.
|
171
177
|
* `disable_version_check` (`BUNDLE_DISABLE_VERSION_CHECK`):
|
@@ -192,6 +198,9 @@ learn more about their operation in [bundle install(1)][bundle-install].
|
|
192
198
|
* `global_gem_cache` (`BUNDLE_GLOBAL_GEM_CACHE`):
|
193
199
|
Whether Bundler should cache all gems globally, rather than locally to the
|
194
200
|
installing Ruby installation.
|
201
|
+
* `global_path_appends_ruby_scope` (`BUNDLE_GLOBAL_PATH_APPENDS_RUBY_SCOPE`):
|
202
|
+
Whether Bundler should append the Ruby scope (e.g. engine and ABI version)
|
203
|
+
to a globally-configured path.
|
195
204
|
* `ignore_messages` (`BUNDLE_IGNORE_MESSAGES`): When set, no post install
|
196
205
|
messages will be printed. To silence a single gem, use dot notation like
|
197
206
|
`ignore_messages.httparty true`.
|
@@ -218,6 +227,8 @@ learn more about their operation in [bundle install(1)][bundle-install].
|
|
218
227
|
is used, defaults to vendor/bundle.
|
219
228
|
* `path.system` (`BUNDLE_PATH__SYSTEM`):
|
220
229
|
Whether Bundler will install gems into the default system path (`Gem.dir`).
|
230
|
+
* `path_relative_to_cwd` (`PATH_RELATIVE_TO_CWD`)
|
231
|
+
Makes `--path` relative to the CWD instead of the `Gemfile`.
|
221
232
|
* `plugins` (`BUNDLE_PLUGINS`):
|
222
233
|
Enable Bundler's experimental plugin system.
|
223
234
|
* `prefer_gems_rb` (`BUNDLE_PREFER_GEMS_RB`)
|
@@ -277,7 +288,7 @@ learn more about their operation in [bundle install(1)][bundle-install].
|
|
277
288
|
A `:`-separated list of groups whose gems bundler should not install.
|
278
289
|
|
279
290
|
In general, you should set these settings per-application by using the applicable
|
280
|
-
flag to the [bundle install(1)]
|
291
|
+
flag to the [bundle install(1)](bundle-install.1.html) or [bundle package(1)](bundle-package.1.html) command.
|
281
292
|
|
282
293
|
You can set them globally either via environment variables or `bundle config`,
|
283
294
|
whichever is preferable for your setup. If you use both, environment variables
|
@@ -370,3 +381,17 @@ This is especially useful for private repositories on hosts such as Github,
|
|
370
381
|
where you can use personal OAuth tokens:
|
371
382
|
|
372
383
|
export BUNDLE_GITHUB__COM=abcd0123generatedtoken:x-oauth-basic
|
384
|
+
|
385
|
+
|
386
|
+
## CONFIGURE BUNDLER DIRECTORIES
|
387
|
+
|
388
|
+
Bundler's home, config, cache and plugin directories are able to be configured
|
389
|
+
through environment variables. The default location for Bundler's home directory is
|
390
|
+
`~/.bundle`, which all directories inherit from by default. The following
|
391
|
+
outlines the available environment variables and their default values
|
392
|
+
|
393
|
+
BUNDLE_USER_HOME : $HOME/.bundle
|
394
|
+
BUNDLE_USER_CACHE : $BUNDLE_USER_HOME/cache
|
395
|
+
BUNDLE_USER_CONFIG : $BUNDLE_USER_HOME/config
|
396
|
+
BUNDLE_USER_PLUGIN : $BUNDLE_USER_HOME/plugin
|
397
|
+
|
data/man/bundle-doctor.1
ADDED
@@ -0,0 +1,44 @@
|
|
1
|
+
.\" generated with Ronn/v0.7.3
|
2
|
+
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
3
|
+
.
|
4
|
+
.TH "BUNDLE\-DOCTOR" "1" "November 2018" "" ""
|
5
|
+
.
|
6
|
+
.SH "NAME"
|
7
|
+
\fBbundle\-doctor\fR \- Checks the bundle for common problems
|
8
|
+
.
|
9
|
+
.SH "SYNOPSIS"
|
10
|
+
\fBbundle doctor\fR [\-\-quiet] [\-\-gemfile=GEMFILE]
|
11
|
+
.
|
12
|
+
.SH "DESCRIPTION"
|
13
|
+
Checks your Gemfile and gem environment for common problems\. If issues are detected, Bundler prints them and exits status 1\. Otherwise, Bundler prints a success message and exits status 0\.
|
14
|
+
.
|
15
|
+
.P
|
16
|
+
Examples of common problems caught by bundle\-doctor include:
|
17
|
+
.
|
18
|
+
.IP "\(bu" 4
|
19
|
+
Invalid Bundler settings
|
20
|
+
.
|
21
|
+
.IP "\(bu" 4
|
22
|
+
Mismatched Ruby versions
|
23
|
+
.
|
24
|
+
.IP "\(bu" 4
|
25
|
+
Mismatched platforms
|
26
|
+
.
|
27
|
+
.IP "\(bu" 4
|
28
|
+
Uninstalled gems
|
29
|
+
.
|
30
|
+
.IP "\(bu" 4
|
31
|
+
Missing dependencies
|
32
|
+
.
|
33
|
+
.IP "" 0
|
34
|
+
.
|
35
|
+
.SH "OPTIONS"
|
36
|
+
.
|
37
|
+
.TP
|
38
|
+
\fB\-\-quiet\fR
|
39
|
+
Only output warnings and errors\.
|
40
|
+
.
|
41
|
+
.TP
|
42
|
+
\fB\-\-gemfile=<gemfile>\fR
|
43
|
+
The location of the Gemfile(5) which Bundler should use\. This defaults to a Gemfile(5) in the current working directory\. In general, Bundler will assume that the location of the Gemfile(5) is also the project\'s root and will try to find \fBGemfile\.lock\fR and \fBvendor/cache\fR relative to this location\.
|
44
|
+
|
@@ -0,0 +1,44 @@
|
|
1
|
+
BUNDLE-DOCTOR(1) BUNDLE-DOCTOR(1)
|
2
|
+
|
3
|
+
|
4
|
+
|
5
|
+
NAME
|
6
|
+
bundle-doctor - Checks the bundle for common problems
|
7
|
+
|
8
|
+
SYNOPSIS
|
9
|
+
bundle doctor [--quiet] [--gemfile=GEMFILE]
|
10
|
+
|
11
|
+
DESCRIPTION
|
12
|
+
Checks your Gemfile and gem environment for common problems. If issues
|
13
|
+
are detected, Bundler prints them and exits status 1. Otherwise,
|
14
|
+
Bundler prints a success message and exits status 0.
|
15
|
+
|
16
|
+
Examples of common problems caught by bundle-doctor include:
|
17
|
+
|
18
|
+
o Invalid Bundler settings
|
19
|
+
|
20
|
+
o Mismatched Ruby versions
|
21
|
+
|
22
|
+
o Mismatched platforms
|
23
|
+
|
24
|
+
o Uninstalled gems
|
25
|
+
|
26
|
+
o Missing dependencies
|
27
|
+
|
28
|
+
|
29
|
+
|
30
|
+
OPTIONS
|
31
|
+
--quiet
|
32
|
+
Only output warnings and errors.
|
33
|
+
|
34
|
+
--gemfile=<gemfile>
|
35
|
+
The location of the Gemfile(5) which Bundler should use. This
|
36
|
+
defaults to a Gemfile(5) in the current working directory. In
|
37
|
+
general, Bundler will assume that the location of the Gemfile(5)
|
38
|
+
is also the project's root and will try to find Gemfile.lock and
|
39
|
+
vendor/cache relative to this location.
|
40
|
+
|
41
|
+
|
42
|
+
|
43
|
+
|
44
|
+
November 2018 BUNDLE-DOCTOR(1)
|
@@ -0,0 +1,33 @@
|
|
1
|
+
bundle-doctor(1) -- Checks the bundle for common problems
|
2
|
+
=========================================================
|
3
|
+
|
4
|
+
## SYNOPSIS
|
5
|
+
|
6
|
+
`bundle doctor` [--quiet]
|
7
|
+
[--gemfile=GEMFILE]
|
8
|
+
|
9
|
+
## DESCRIPTION
|
10
|
+
|
11
|
+
Checks your Gemfile and gem environment for common problems. If issues
|
12
|
+
are detected, Bundler prints them and exits status 1. Otherwise,
|
13
|
+
Bundler prints a success message and exits status 0.
|
14
|
+
|
15
|
+
Examples of common problems caught by bundle-doctor include:
|
16
|
+
|
17
|
+
* Invalid Bundler settings
|
18
|
+
* Mismatched Ruby versions
|
19
|
+
* Mismatched platforms
|
20
|
+
* Uninstalled gems
|
21
|
+
* Missing dependencies
|
22
|
+
|
23
|
+
## OPTIONS
|
24
|
+
|
25
|
+
* `--quiet`:
|
26
|
+
Only output warnings and errors.
|
27
|
+
|
28
|
+
* `--gemfile=<gemfile>`:
|
29
|
+
The location of the Gemfile(5) which Bundler should use. This defaults
|
30
|
+
to a Gemfile(5) in the current working directory. In general, Bundler
|
31
|
+
will assume that the location of the Gemfile(5) is also the project's
|
32
|
+
root and will try to find `Gemfile.lock` and `vendor/cache` relative
|
33
|
+
to this location.
|
data/man/bundle-exec.1
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
.\" generated with Ronn/v0.7.3
|
2
2
|
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
3
3
|
.
|
4
|
-
.TH "BUNDLE\-EXEC" "1" "
|
4
|
+
.TH "BUNDLE\-EXEC" "1" "November 2018" "" ""
|
5
5
|
.
|
6
6
|
.SH "NAME"
|
7
7
|
\fBbundle\-exec\fR \- Execute a command in the context of the bundle
|
@@ -10,10 +10,10 @@
|
|
10
10
|
\fBbundle exec\fR [\-\-keep\-file\-descriptors] \fIcommand\fR
|
11
11
|
.
|
12
12
|
.SH "DESCRIPTION"
|
13
|
-
This command executes the command, making all gems specified in the \fBGemfile(5)\fR available to \fBrequire\fR in Ruby programs\.
|
13
|
+
This command executes the command, making all gems specified in the [\fBGemfile(5)\fR][Gemfile(5)] available to \fBrequire\fR in Ruby programs\.
|
14
14
|
.
|
15
15
|
.P
|
16
|
-
Essentially, if you would normally have run something like \fBrspec spec/my_spec\.rb\fR, and you want to use the gems specified in the \fBGemfile(5)\fR and installed via
|
16
|
+
Essentially, if you would normally have run something like \fBrspec spec/my_spec\.rb\fR, and you want to use the gems specified in the [\fBGemfile(5)\fR][Gemfile(5)] and installed via bundle install(1) \fIbundle\-install\.1\.html\fR, you should run \fBbundle exec rspec spec/my_spec\.rb\fR\.
|
17
17
|
.
|
18
18
|
.P
|
19
19
|
Note that \fBbundle exec\fR does not require that an executable is available on your shell\'s \fB$PATH\fR\.
|
@@ -25,7 +25,7 @@ Note that \fBbundle exec\fR does not require that an executable is available on
|
|
25
25
|
Exec in Ruby 2\.0 began discarding non\-standard file descriptors\. When this flag is passed, exec will revert to the 1\.9 behaviour of passing all file descriptors to the new process\.
|
26
26
|
.
|
27
27
|
.SH "BUNDLE INSTALL \-\-BINSTUBS"
|
28
|
-
If you use the \fB\-\-binstubs\fR flag in
|
28
|
+
If you use the \fB\-\-binstubs\fR flag in bundle install(1) \fIbundle\-install\.1\.html\fR, Bundler will automatically create a directory (which defaults to \fBapp_root/bin\fR) containing all of the executables available from gems in the bundle\.
|
29
29
|
.
|
30
30
|
.P
|
31
31
|
After using \fB\-\-binstubs\fR, \fBbin/rspec spec/my_spec\.rb\fR is identical to \fBbundle exec rspec spec/my_spec\.rb\fR\.
|
data/man/bundle-exec.1.txt
CHANGED
@@ -10,12 +10,12 @@ SYNOPSIS
|
|
10
10
|
|
11
11
|
DESCRIPTION
|
12
12
|
This command executes the command, making all gems specified in the
|
13
|
-
Gemfile(5) available to require in Ruby programs.
|
13
|
+
[Gemfile(5)][Gemfile(5)] available to require in Ruby programs.
|
14
14
|
|
15
15
|
Essentially, if you would normally have run something like rspec
|
16
|
-
spec/my_spec.rb, and you want
|
17
|
-
file(5)
|
18
|
-
should run bundle exec rspec spec/my_spec.rb.
|
16
|
+
spec/my_spec.rb, and you want to use the gems specified in the [Gem-
|
17
|
+
file(5)][Gemfile(5)] and installed via bundle install(1) bun-
|
18
|
+
dle-install.1.html, you should run bundle exec rspec spec/my_spec.rb.
|
19
19
|
|
20
20
|
Note that bundle exec does not require that an executable is available
|
21
21
|
on your shell's $PATH.
|
@@ -27,10 +27,10 @@ OPTIONS
|
|
27
27
|
of passing all file descriptors to the new process.
|
28
28
|
|
29
29
|
BUNDLE INSTALL --BINSTUBS
|
30
|
-
If
|
31
|
-
Bundler
|
32
|
-
app_root/bin)
|
33
|
-
the bundle.
|
30
|
+
If you use the --binstubs flag in bundle install(1) bun-
|
31
|
+
dle-install.1.html, Bundler will automatically create a directory
|
32
|
+
(which defaults to app_root/bin) containing all of the executables
|
33
|
+
available from gems in the bundle.
|
34
34
|
|
35
35
|
After using --binstubs, bin/rspec spec/my_spec.rb is identical to bun-
|
36
36
|
dle exec rspec spec/my_spec.rb.
|
@@ -175,4 +175,4 @@ RUBYGEMS PLUGINS
|
|
175
175
|
|
176
176
|
|
177
177
|
|
178
|
-
|
178
|
+
November 2018 BUNDLE-EXEC(1)
|
data/man/bundle-exec.ronn
CHANGED
@@ -8,11 +8,11 @@ bundle-exec(1) -- Execute a command in the context of the bundle
|
|
8
8
|
## DESCRIPTION
|
9
9
|
|
10
10
|
This command executes the command, making all gems specified in the
|
11
|
-
`Gemfile(5)` available to `require` in Ruby programs.
|
11
|
+
[`Gemfile(5)`][Gemfile(5)] available to `require` in Ruby programs.
|
12
12
|
|
13
13
|
Essentially, if you would normally have run something like
|
14
14
|
`rspec spec/my_spec.rb`, and you want to use the gems specified
|
15
|
-
in the `Gemfile(5)` and installed via [bundle install(1)]
|
15
|
+
in the [`Gemfile(5)`][Gemfile(5)] and installed via [bundle install(1)](bundle-install.1.html), you
|
16
16
|
should run `bundle exec rspec spec/my_spec.rb`.
|
17
17
|
|
18
18
|
Note that `bundle exec` does not require that an executable is
|
@@ -27,7 +27,7 @@ available on your shell's `$PATH`.
|
|
27
27
|
|
28
28
|
## BUNDLE INSTALL --BINSTUBS
|
29
29
|
|
30
|
-
If you use the `--binstubs` flag in [bundle install(1)]
|
30
|
+
If you use the `--binstubs` flag in [bundle install(1)](bundle-install.1.html), Bundler will
|
31
31
|
automatically create a directory (which defaults to `app_root/bin`)
|
32
32
|
containing all of the executables available from gems in the bundle.
|
33
33
|
|
data/man/bundle-gem.1
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
.\" generated with Ronn/v0.7.3
|
2
2
|
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
3
3
|
.
|
4
|
-
.TH "BUNDLE\-GEM" "1" "
|
4
|
+
.TH "BUNDLE\-GEM" "1" "November 2018" "" ""
|
5
5
|
.
|
6
6
|
.SH "NAME"
|
7
7
|
\fBbundle\-gem\fR \- Generate a project skeleton for creating a rubygem
|
@@ -74,7 +74,7 @@ Open the resulting GEM_NAME\.gemspec in EDITOR, or the default editor if not spe
|
|
74
74
|
.SH "SEE ALSO"
|
75
75
|
.
|
76
76
|
.IP "\(bu" 4
|
77
|
-
bundle
|
77
|
+
bundle config(1) \fIbundle\-config\.1\.html\fR
|
78
78
|
.
|
79
79
|
.IP "" 0
|
80
80
|
|
data/man/bundle-gem.1.txt
CHANGED
data/man/bundle-gem.ronn
CHANGED