Support asdf's .tool-versions file #9319
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
(For the of sake of transparency: I had this on draft with a note eliciting opinions on whether/how to eliminate some duplication in the original commit, but eventually I realized the file detection logic I had for |
dvandersluis
reviewed
Jan 1, 2021
Augments the TargetRuby class with a ToolVersionsFile class, giving asdf [1] users the option to specify the target Ruby syntax through its default config file .tool-versions [2]. The file detection and content matching logic is the same whether .tool-versions or .ruby-version is in use. The only differences between the two cases are the file name and pattern used to extract the version number. So, have ToolVersionsFile subclass RubyVersionFile, and modify find_version to get file name and pattern from available instance methods. Since the author is in the process of replacing rbenv with asdf in their dev environment, it felt sensible to stipulate that ToolVersionsFile would be more authoritative than RubyVersionFile (but still less than RuboCopConfig). In the absence of a .tool-versions file, or when it doesn't happen to specify a ruby version, revert to the original logic and allow both rbenv and asdf (in asdf-ruby legacy mode) to be used. [1] asdf is a plugin-based runtime installer/manager - think RVM or rbenv, but not limited to Ruby: github.com/asdf-vm/asdf Ruby support for asdf is provided by the asdf-ruby plugin: github.com/asdf-vm/asdf-ruby [2] Each line in .tool-versions identifies the runtimes and the version needed. For example, here's the contents of the .tool-versions in the author's home dir in their personal laptop: ``` nodejs 14.9.0 ruby 3.0.0 yarn 1.22.5 ```
|
Looks good. Thanks! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Hey all,
Happy new year! 馃帀
First time contribution so apologies in advance if I'm going about this the wrong way. I figured this could be a worthwhile feature addition to Rubocop.
For context:
I recently switched to asdf from rbenv on my personal dev environment.
I decided to try out Ruby 3.0 today on a project, and when I started getting errors from Rubocop on Ruby 3.0-specific syntax, I realized that project had a leftover
.ruby-versionpointing to 2.6.3 which surprisingly Rubocop was picking up.At that point I felt there was an opportunity to extend the target version detection logic to be aware of asdf's
.tool-versionsfile, so here is a proposed change to support that.Suggest reading the commit message for detail.
Thanks!
Before submitting the PR make sure the following are checked:
[Fix #issue-number](if the related issue exists).master(if not - rebase it).bundle exec rake default. It executes all tests and runs RuboCop on its own code.{change_type}_{change_description}.mdif the new code introduces user-observable changes. See changelog entry format for details.