-
-
Notifications
You must be signed in to change notification settings - Fork 9.9k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
69 additions
and
0 deletions.
There are no files selected for viewing
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
# typed: strict | ||
# frozen_string_literal: true | ||
|
||
module RuboCop | ||
module Cop | ||
# Checks if rubocop disable comments have a clarifying comment preceding them. | ||
class DisableComment < Base | ||
MSG = "Add a clarifying comment to the RuboCop disable comment" | ||
|
||
def on_new_investigation | ||
super | ||
|
||
processed_source.comments.each do |comment| | ||
next unless disable_comment?(comment) | ||
next if comment?(processed_source[comment.loc.line - 2]) | ||
|
||
add_offense(comment) | ||
end | ||
end | ||
|
||
private | ||
|
||
def disable_comment?(comment) | ||
comment.text.start_with? "# rubocop:disable" | ||
end | ||
|
||
def comment?(line) | ||
line.strip.start_with? "#" | ||
end | ||
end | ||
end | ||
end |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
# frozen_string_literal: true | ||
|
||
require "rubocops/disable_comment" | ||
|
||
RSpec.describe RuboCop::Cop::DisableComment, :config do | ||
shared_examples "offense" do |source, correction, message| | ||
it "registers an offense and corrects" do | ||
expect_offense(<<~RUBY, source:, message:) | ||
#{source} | ||
^{source} #{message} | ||
RUBY | ||
|
||
expect_correction(<<~RUBY) | ||
#{correction} | ||
RUBY | ||
end | ||
end | ||
|
||
it "register a offencse" do | ||
expect_offense(<<~RUBY) | ||
def something; end | ||
# rubocop:disable Naming/AccessorMethodName | ||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Add a clarifying comment to the RuboCop disable comment | ||
def get_decrypted_io; end | ||
RUBY | ||
end | ||
|
||
it "doesn't register an offencse" do | ||
expect_no_offenses(<<~RUBY) | ||
def something; end | ||
# This is a upstream name that we cannot change. | ||
# rubocop:disable Naming/AccessorMethodName | ||
def get_decrypted_io; end | ||
RUBY | ||
end | ||
end |