This is a feature request. I’ll be happy to provide a PR for this, but I want to discuss the feature in advance to see if it makes sense.
Running Ruby executables like rspec or rubocop turns out to be rather complicated nowadays: You need to support binstubs, Gemfiles and bundle exec, maybe RVM or rbenv, …
Currently, various bundles implement something along this lines on their own, reinventing the wheel again and again. See the discussion in #99 for an example. Other bundles that come to my mind are (and I wouldn’t be surprised if there are more):
I think this functionality – “reliably run a Ruby executable” – should be provided by the Ruby bundle as a public API to be used by other bundles (note that it’s possible for bundles to require other bundles).
Before implementing this I want to discuss two questions:
Should the Ruby bundle provide this feature?
What is the definitive way of running a Ruby executable anyway? (All current implementations are slightly different).
Here’s my suggestion on how to implement the feature:
Look for a binstub (e.g. bin/rubocop, bin/rspec, …) and use it, if present. (This is especially important for projects using preloaders like Spring.)
Check if a Gemfile (or a Gemfile.lock?) exists and contains an entry for the executable’s gem. If so, run the executable with bundle exec …
Assume that the executable is installed globally and in the search path, so just run it via it’s name (with the project directory as working dir, to make sure rbenv is happy). If the corresponding environment variable (TM_RUBOCOP, TM_RSPEC, …) is set, use this as name instead.
Comments and feedback welcome! (Especially from RVM users as this is something I don’t use myself. Do we need any special steps to make this work smoothly with RVM?)
noniq
commented
7 years ago
This is a feature request. I’ll be happy to provide a PR for this, but I want to discuss the feature in advance to see if it makes sense.
Running Ruby executables like rspec or rubocop turns out to be rather complicated nowadays: You need to support binstubs, Gemfiles and
bundle exec, maybe RVM or rbenv, …Currently, various bundles implement something along this lines on their own, reinventing the wheel again and again. See the discussion in #99 for an example. Other bundles that come to my mind are (and I wouldn’t be surprised if there are more):
I think this functionality – “reliably run a Ruby executable” – should be provided by the Ruby bundle as a public API to be used by other bundles (note that it’s possible for bundles to require other bundles).
Before implementing this I want to discuss two questions:
Here’s my suggestion on how to implement the feature:
bin/rubocop,bin/rspec, …) and use it, if present. (This is especially important for projects using preloaders like Spring.)Gemfile(or aGemfile.lock?) exists and contains an entry for the executable’s gem. If so, run the executable withbundle exec …TM_RUBOCOP,TM_RSPEC, …) is set, use this as name instead.Comments and feedback welcome! (Especially from RVM users as this is something I don’t use myself. Do we need any special steps to make this work smoothly with RVM?)