Skip to content

Include link to rule docs in offense message #12

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 27, 2021
Merged

Include link to rule docs in offense message #12

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions lib/erblint-github/linters/custom_helpers.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ def rule_disabled?(processed_source)
indicator_node, _, code_node, = *node
indicator = indicator_node&.loc&.source
comment = code_node&.loc&.source&.strip
rule_name = self.class.name.gsub("ERBLint::Linters::", "")
rule_name = simple_class_name

if indicator == "#" && comment.start_with?("erblint:disable") && comment.match(rule_name)
if @offenses.any?
Expand All @@ -26,8 +26,8 @@ def rule_disabled?(processed_source)

def generate_offense(klass, processed_source, tag, message = nil, replacement = nil)
message ||= klass::MESSAGE
klass_name = klass.name.demodulize
offense = ["#{klass_name}:#{message}", tag.node.loc.source].join("\n")
message += "\nLearn more at https://github.com/github/erblint-github#rules.\n"
offense = ["#{simple_class_name}:#{message}", tag.node.loc.source].join("\n")
add_offense(processed_source.to_source_range(tag.loc), offense, replacement)
end

Expand All @@ -45,6 +45,10 @@ def basic_conditional_code_check(code)
def tags(processed_source)
processed_source.parser.nodes_with_type(:tag).map { |tag_node| BetterHtml::Tree::Tag.from_node(tag_node) }
end

def simple_class_name
self.class.name.gsub("ERBLint::Linters::", "")
end
end
end
end