-
Notifications
You must be signed in to change notification settings - Fork 122
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #249 from khiga8/kh-allow_linter_disable_by_comment
[Feature] Allow rule to be disabled by comment
- Loading branch information
Showing
12 changed files
with
417 additions
and
4 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
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,45 @@ | ||
# frozen_string_literal: true | ||
|
||
require "erb_lint/utils/inline_configs" | ||
|
||
module ERBLint | ||
module Linters | ||
# Checks for unused disable comments. | ||
class NoUnusedDisable < Linter | ||
include LinterRegistry | ||
|
||
def run(processed_source, offenses) | ||
disabled_rules_and_line_number = {} | ||
|
||
processed_source.source_buffer.source_lines.each_with_index do |line, index| | ||
rule_disables = Utils::InlineConfigs.disabled_rules(line) | ||
next unless rule_disables | ||
|
||
rule_disables.split(",").each do |rule| | ||
disabled_rules_and_line_number[rule.strip] = | ||
(disabled_rules_and_line_number[rule.strip] ||= []).push(index + 1) | ||
end | ||
end | ||
|
||
offenses.each do |offense| | ||
rule_name = offense.linter.class.simple_name | ||
line_numbers = disabled_rules_and_line_number[rule_name] | ||
next unless line_numbers | ||
|
||
line_numbers.reject do |line_number| | ||
if (offense.source_range.line_span.first..offense.source_range.line_span.last).include?(line_number) | ||
disabled_rules_and_line_number[rule_name].delete(line_number) | ||
end | ||
end | ||
end | ||
|
||
disabled_rules_and_line_number.each do |rule, line_numbers| | ||
line_numbers.each do |line_number| | ||
add_offense(processed_source.source_buffer.line_range(line_number), | ||
"Unused erblint:disable comment for #{rule}") | ||
end | ||
end | ||
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
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,15 @@ | ||
# frozen_string_literal: true | ||
|
||
module ERBLint | ||
module Utils | ||
class InlineConfigs | ||
def self.rule_disable_comment_for_lines?(rule, lines) | ||
lines.match?(/# erblint:disable (?<rules>.*#{rule}).*/) | ||
end | ||
|
||
def self.disabled_rules(line) | ||
line.match(/# erblint:disable (?<rules>.*) %>/)&.named_captures&.fetch("rules") | ||
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
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,108 @@ | ||
# frozen_string_literal: true | ||
|
||
require "spec_helper" | ||
require "spec_utils" | ||
|
||
describe ERBLint::Linters::NoUnusedDisable do | ||
let(:linter_config) { described_class.config_schema.new } | ||
|
||
let(:file_loader) { ERBLint::FileLoader.new(".") } | ||
let(:linter) { described_class.new(file_loader, linter_config) } | ||
let(:processed_source) { ERBLint::ProcessedSource.new("file.rb", file) } | ||
let(:offenses) { linter.offenses } | ||
|
||
module ERBLint | ||
module Linters | ||
class Fake < ERBLint::Linter | ||
attr_accessor :offenses | ||
end | ||
end | ||
end | ||
|
||
describe "offenses" do | ||
subject { offenses } | ||
context "when file has unused disable comment" do | ||
let(:file) { "<span></span><%# erblint:disable Fake %>" } | ||
before { linter.run(processed_source, []) } | ||
it do | ||
expect(subject.size).to(eq(1)) | ||
expect(subject.first.message).to(eq("Unused erblint:disable comment for Fake")) | ||
end | ||
end | ||
|
||
context "when file has a disable comment and a corresponding offense" do | ||
let(:file) { "<span></span><%# erblint:disable Fake %>" } | ||
before do | ||
offense = ERBLint::Offense.new(ERBLint::Linters::Fake.new(file_loader, linter_config), | ||
SpecUtils.source_range_for_code(processed_source, "<span></span>"), | ||
"some fake linter message") | ||
offense.disabled = true | ||
linter.run(processed_source, [offense]) | ||
end | ||
|
||
it "does not report anything" do | ||
expect(subject.size).to(eq(0)) | ||
end | ||
end | ||
|
||
context "when file has a disable comment in wrong place and a corresponding offense" do | ||
let(:file) { <<~FILE } | ||
<%# erblint:disable Fake %> | ||
<span>bad content</span> | ||
FILE | ||
before do | ||
offense = ERBLint::Offense.new( | ||
ERBLint::Linters::Fake.new(file_loader, linter_config), | ||
SpecUtils.source_range_for_code(processed_source, "<span>bad content</span>"), | ||
"some fake linter message" | ||
) | ||
offense.disabled = true | ||
linter.run(processed_source, [offense]) | ||
end | ||
|
||
it "reports the unused inline comment" do | ||
expect(subject.size).to(eq(1)) | ||
expect(subject.first.message).to(eq("Unused erblint:disable comment for Fake")) | ||
end | ||
end | ||
|
||
context "when file has disable comment for multiple rules" do | ||
let(:file) { "<span></span><%# erblint:disable Fake, Fake2 %>" } | ||
before do | ||
offense = ERBLint::Offense.new( | ||
ERBLint::Linters::Fake.new(file_loader, linter_config), | ||
SpecUtils.source_range_for_code(processed_source, "<span></span>"), | ||
"some fake linter message" | ||
) | ||
offense.disabled = true | ||
linter.run(processed_source, [offense]) | ||
end | ||
|
||
it "reports the unused inline comment" do | ||
expect(subject.size).to(eq(1)) | ||
expect(subject.first.message).to(eq("Unused erblint:disable comment for Fake2")) | ||
end | ||
end | ||
|
||
context "when file has multiple disable comments for one offense" do | ||
let(:file) { <<~ERB } | ||
<%# erblint:disable Fake %> | ||
<span></span><%# erblint:disable Fake %> | ||
ERB | ||
before do | ||
offense = ERBLint::Offense.new( | ||
ERBLint::Linters::Fake.new(file_loader, linter_config), | ||
SpecUtils.source_range_for_code(processed_source, "<span></span>"), | ||
"some fake linter message" | ||
) | ||
offense.disabled = true | ||
linter.run(processed_source, [offense]) | ||
end | ||
|
||
it "reports the unused inline comment" do | ||
expect(subject.size).to(eq(1)) | ||
expect(subject.first.message).to(eq("Unused erblint:disable comment for Fake")) | ||
end | ||
end | ||
end | ||
end |
Oops, something went wrong.