[Fix #107] Fix style guide URLs #109
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
|
Hmm, maybe we should come up with a way for plugins to provide their own base url as well, so we can avoid this repetition? |
|
My explanation was lacking. This PR is a workaround patch. So I prepared this PR that workaround patch because release cycle is different between RuboCop core and RuboCop Rails. This patch can be released independently of RuboCop core. |
|
Understood. Thanks for the extra details! |
8 tasks
koic
added a commit
to koic/rubocop
that referenced
this pull request
Aug 19, 2019
### Summary Resolves rubocop/rubocop-rails#107 and follow up rubocop/rubocop-rails#109 (comment). This PR makes it possible to set a style guide URL (`StyleGuideBaseURL`) for each department. For example, RuboCop Rails gem (Rails department) supports The Rails Style Guide. In that case, set .rubocop.yml as follows. ```yaml # .rubocop.yml require: - rubocop-rails AllCops: StyleGuideBaseURL: https://rubystyle.guide Rails: StyleGuideBaseURL: https://rails.rubystyle.guide ``` In practice `Rails: StyleGuideBaseURL: https://rails.rubystyle.guide` will be set in config/default.yml of rubocop-rails. ```console % cat example.rb # frozen_string_literal: true time = Time.new ``` ```console % bundle exec rubocop --display-style-guide example.rb Inspecting 1 file W Offenses: example.rb:3:1: W: Lint/UselessAssignment: Useless assignment to variable - time. (https://rubystyle.guide#underscore-unused-vars) time = Time.new ^^^^ example.rb:3:13: C: Rails/TimeZone: Do not use Time.new without zone. Use one of Time.zone.now, Time.current, Time.new.in_time_zone, Time.new.utc, Time.new.getlocal, Time.new.xmlschema, Time.new.iso8601, Time.new.jisx0301, Time.new.rfc3339, Time.new.httpdate, Time.new.to_i, Time.new.to_f instead. (https://rails.rubystyle.guide#time, http://danilenko.org/2012/7/6/rails_timezones) time = Time.new ^^^ 1 file inspected, 2 offenses detected ``` The style guide URLs set for each department is displayed. - https://rubystyle.guide#underscore-unused-vars for `Lint/UselessAssignment` cop - https://rails.rubystyle.guide#time for for `Rails/TimeZone` cop So `AllCops` style guide URL is used when there is no style guide URL for a specific department. ### Other Information Note that tasks/cops_documentation.rake will require the following patch: ```diff diff --git a/tasks/cops_documentation.rake b/tasks/cops_documentation.rake index bd93ffe31..751222fcb 100644 --- a/tasks/cops_documentation.rake +++ b/tasks/cops_documentation.rake @@ -155,7 +155,9 @@ task generate_cops_documentation: :yard_for_generate_documentation do def references(config, cop) cop_config = config.for_cop(cop) - urls = RuboCop::Cop::MessageAnnotator.new(config, cop_config, {}).urls + urls = RuboCop::Cop::MessageAnnotator.new( + config, cop.name, cop_config, {} + ).urls return '' if urls.empty? content = h3('References') ``` AFAIK, rubocop-performance, rubocop-rails, rubocop-rspec, and rubocop-minitest repositories are targeted.
Fixes rubocop#107. This PR fixes style guide URLs when specifying `rubocop --display-style-guide` option. The following is an execution using RuboCop Rails. ```console % bundle exec rubocop --display-style-guide --only Style/StringLiterals Inspecting 2 files C. Offenses: Gemfile:3:8: C: Style/StringLiterals: Prefer single-quoted strings when you don't need string interpolation or special symbols. (https://rails.rubystyle.guide#consistent-string-literals) source "https://rubygems.org" ^^^^^^^^^^^^^^^^^^^^^^ 2 files inspected, 1 offense detected ``` The correct URL is `https://rubystyle.guide#consistent-string-literals` instead of `https://rails.rubystyle.guide#consistent-string-literals`.
koic
force-pushed
the
fix_a_style_guild_url
branch
from
9b802df to
0092e77
Compare
bbatsov
pushed a commit
to rubocop/rubocop
that referenced
this pull request
Aug 19, 2019
### Summary Resolves rubocop/rubocop-rails#107 and follow up rubocop/rubocop-rails#109 (comment). This PR makes it possible to set a style guide URL (`StyleGuideBaseURL`) for each department. For example, RuboCop Rails gem (Rails department) supports The Rails Style Guide. In that case, set .rubocop.yml as follows. ```yaml # .rubocop.yml require: - rubocop-rails AllCops: StyleGuideBaseURL: https://rubystyle.guide Rails: StyleGuideBaseURL: https://rails.rubystyle.guide ``` In practice `Rails: StyleGuideBaseURL: https://rails.rubystyle.guide` will be set in config/default.yml of rubocop-rails. ```console % cat example.rb # frozen_string_literal: true time = Time.new ``` ```console % bundle exec rubocop --display-style-guide example.rb Inspecting 1 file W Offenses: example.rb:3:1: W: Lint/UselessAssignment: Useless assignment to variable - time. (https://rubystyle.guide#underscore-unused-vars) time = Time.new ^^^^ example.rb:3:13: C: Rails/TimeZone: Do not use Time.new without zone. Use one of Time.zone.now, Time.current, Time.new.in_time_zone, Time.new.utc, Time.new.getlocal, Time.new.xmlschema, Time.new.iso8601, Time.new.jisx0301, Time.new.rfc3339, Time.new.httpdate, Time.new.to_i, Time.new.to_f instead. (https://rails.rubystyle.guide#time, http://danilenko.org/2012/7/6/rails_timezones) time = Time.new ^^^ 1 file inspected, 2 offenses detected ``` The style guide URLs set for each department is displayed. - https://rubystyle.guide#underscore-unused-vars for `Lint/UselessAssignment` cop - https://rails.rubystyle.guide#time for for `Rails/TimeZone` cop So `AllCops` style guide URL is used when there is no style guide URL for a specific department. ### Other Information Note that tasks/cops_documentation.rake will require the following patch: ```diff diff --git a/tasks/cops_documentation.rake b/tasks/cops_documentation.rake index bd93ffe31..751222fcb 100644 --- a/tasks/cops_documentation.rake +++ b/tasks/cops_documentation.rake @@ -155,7 +155,9 @@ task generate_cops_documentation: :yard_for_generate_documentation do def references(config, cop) cop_config = config.for_cop(cop) - urls = RuboCop::Cop::MessageAnnotator.new(config, cop_config, {}).urls + urls = RuboCop::Cop::MessageAnnotator.new( + config, cop.name, cop_config, {} + ).urls return '' if urls.empty? content = h3('References') ``` AFAIK, rubocop-performance, rubocop-rails, rubocop-rspec, and rubocop-minitest repositories are targeted.
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.
Fixes #107.
This PR fixes style guide URLs when specifying
rubocop --display-style-guideoption.The following is an execution using RuboCop Rails.
The correct URL is
https://rubystyle.guide#consistent-string-literalsinstead ofhttps://rails.rubystyle.guide#consistent-string-literals.Before submitting the PR make sure the following are checked:
[Fix #issue-number](if the related issue exists).master(if not - rebase it).and description in grammatically correct, complete sentences.
bundle exec rake default. It executes all tests and RuboCop for itself, and generates the documentation.