danger-danger_plugin_lint 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b4aadd85462ff4126981b6bfc38d37a53b24dd105ad8d110e4ab6e301814287d
-  data.tar.gz: ab819488ca07c850a927b6d34cd3818c1a8378d71f4ec943bc7ab8360ff89f4d
+  metadata.gz: 6ecee1a27602e5a9482de8281996941ecf6ebc80b0b61be8dc39e7da4b5f7d7a
+  data.tar.gz: 432fdff0e74f4cc8363b25c3d7840d061c1cf32ca5617e46e1f3d63af07c25d2
 SHA512:
-  metadata.gz: 29dea3cebac8c2eb9b72f701c93ead9dae5a54ce49ce1c587bf0d6439df796826014a6659f3afe7fe0e159e347f0e2d16e81a7ba16edeeecd820a5cef9f70454
-  data.tar.gz: 5640c96ba572b85cd22e5e10ac251e6647394f6975883b28d1cfa4b4412bd7afdba689418a18cfc1be6e5cf7fa2f76da9494ac22e6405784f430d6a6e8850f41
+  metadata.gz: a354c5f83645d7ef0d545b62b623871f5f5ccfc42f56c91174510f6e17e1b78402bba587f5ba6da93723f83e40dfa7af55b097ebe26509f360c0ed19c45a1914
+  data.tar.gz: 7a0234d5e3ee8aeb86ef07faa6cf41e55439e2ed20911fb3f4cc25ca0e6f919b0155455e7ae524b328bb9e4eee6d579e8707e7dff3fc84b445bd0293c335c894

data/lib/danger/danger_plugin_lint.rb

@@ -20,7 +20,8 @@ module Danger
     # @param [Boolean] warnings_as_errors If `true`, treat all warnings as errors.
     # @return [void]
     def lint_docs(*refs, warnings_as_errors: false)
-      file_resolver = PluginFileResolver.new(refs.empty? ? nil : refs.flatten)
+      refs = refs.flatten.compact
+      file_resolver = PluginFileResolver.new(refs.empty? ? nil : refs)
       data = file_resolver.resolve
 
       parser = PluginParser.new(data[:paths], verbose: true)
@@ -37,10 +38,38 @@ module Danger
 
     def display_rules(method, rules)
       rules.each do |rule|
+        message = format_rule(rule)
         abs_file, line = rule.metadata[:files][0]
         file = Pathname.new(abs_file).relative_path_from(Dir.pwd).to_s
-        public_send(method, rule.description, file: file, line: line)
+        public_send(method, message, file: file, line: line)
       end
     end
+
+    def format_rule(rule)
+      <<~HTML
+        <strong>#{rule.title}</strong> - <strong>#{rule.metadata[:name]}</strong> (#{rule.type}):
+        #{to_html(rule.description)}
+        #{link(rule.ref)}
+      HTML
+    end
+
+    def link(ref)
+      url = case ref
+            when Range
+              "https://github.com/dbgrandi/danger-prose/blob/v2.0.0/lib/danger_plugin.rb#L#{ref.min}-L#{ref.max}"
+            when Integer
+              "https://github.com/dbgrandi/danger-prose/blob/v2.0.0/lib/danger_plugin.rb#L#{ref}"
+            else
+              'https://github.com/dbgrandi/danger-prose/blob/v2.0.0/lib/danger_plugin.rb'
+            end
+      %(@see - <a href="#{url}">#{url}</a>)
+    end
+
+    def to_html(markdown)
+      # As the current Danger uses nothing but backquotes in syntax of Markdown,
+      # this method just replaces backquotes to `<code>` tag.
+      # @see https://github.com/danger/danger/blob/v9.0.0/lib/danger/plugin_support/plugin_linter.rb#L93-L128
+      markdown.gsub(/`(.*?)`/, '<code>\1</code>')
+    end
   end
 end

data/lib/danger_plugin_lint/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DangerPluginLint
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: danger-danger_plugin_lint
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Ryosuke Ito
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-11-06 00:00:00.000000000 Z
+date: 2022-11-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: danger-plugin-api