From 1807ebf269bb31ac4277b3f052cd6af545d398ab Mon Sep 17 00:00:00 2001 From: Kate Higa Date: Fri, 3 Dec 2021 16:26:44 -0800 Subject: [PATCH] Include link to rule docs --- lib/erblint-github/linters/custom_helpers.rb | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/lib/erblint-github/linters/custom_helpers.rb b/lib/erblint-github/linters/custom_helpers.rb index 2621a71..0330015 100644 --- a/lib/erblint-github/linters/custom_helpers.rb +++ b/lib/erblint-github/linters/custom_helpers.rb @@ -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? @@ -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 @@ -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