Add rule URL resolver for Textlint (#987)

Author: pascalberger

docs/input/documentation/issue-providers/tap/features.md

@@ -23,6 +23,8 @@ The [Cake.Issues.Tap addin](https://cakebuild.net/extensions/cake-issues-tap/){t
     - [x] Provides URLs for rules shipped with stylelint.
     - [x] Support for custom URL resolving using the `TapStylelintAddRuleUrlResolver` alias.
 - [x] [TextlintLogFileFormat]{target="_blank"} alias for reading TAP files generated by [Textlint](https://textlint.github.io/){target="_blank"}.
+    - [x] Provides URLs for rules shipped with Textlint.
+    - [x] Support for custom URL resolving using the `TapTextlintAddRuleUrlResolver` alias.
 
 ## Supported IIssue properties
 

src/Cake.Issues.Tap.Tests/LogFileFormat/TextlintLogFileFormatTests.cs

@@ -40,7 +40,7 @@ public void Should_Read_Issue_Correct()
                     "TAP")
                     .InFile(@"file.md", 3, 3)
                     .WithPriority(IssuePriority.Error)
-                    .OfRule("no-todo")
+                    .OfRule("no-todo", new Uri("https://github.com/textlint-rule/textlint-rule-no-todo"))
                     .Create());
         }
     }

src/Cake.Issues.Tap/LogFileFormat/TextlintLogFileFormat.cs

@@ -47,7 +47,8 @@ public override IEnumerable<IIssue> ReadIssues(
 
             if (dataDict != null && dataDict.ContainsKey("line"))
             {
-                issueBuilder = issueBuilder.OfRule(dataDict["ruleId"].ToString());
+                var ruleId = dataDict["ruleId"].ToString();
+                issueBuilder = issueBuilder.OfRule(ruleId, TextlintRuleUrlResolver.Instance.ResolveRuleUrl(ruleId));
             }
 
             result.Add(issueBuilder.Create());

src/Cake.Issues.Tap/LogFileFormat/TextlintRuleUrlResolver.cs

@@ -0,0 +1,28 @@
+namespace Cake.Issues.Tap.LogFileFormat;
+
+using System;
+
+/// <summary>
+/// Class for retrieving a URL linking to a site describing a rule.
+/// </summary>
+internal class TextlintRuleUrlResolver : BaseRuleUrlResolver<BaseRuleDescription>
+{
+    private static readonly Lazy<TextlintRuleUrlResolver> InstanceValue =
+        new(() => new TextlintRuleUrlResolver());
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="TextlintRuleUrlResolver"/> class.
+    /// </summary>
+    private TextlintRuleUrlResolver()
+    {
+        this.AddUrlResolver(x => new Uri("https://github.com/textlint-rule/textlint-rule-" + x.Rule));
+    }
+
+    /// <summary>
+    /// Gets the instance of the rule resolver.
+    /// </summary>
+    public static TextlintRuleUrlResolver Instance => InstanceValue.Value;
+
+    /// <inheritdoc/>
+    protected override bool TryGetRuleDescription(string rule, BaseRuleDescription ruleDescription) => true;
+}

src/Cake.Issues.Tap/TapIssuesAliases.TextlintLogFileFormat.cs

@@ -1,5 +1,6 @@
 namespace Cake.Issues.Tap;
 
+using System;
 using Cake.Core;
 using Cake.Core.Annotations;
 using Cake.Issues.Tap.LogFileFormat;
@@ -23,4 +24,68 @@ public static BaseTapLogFileFormat TextlintLogFileFormat(
 
         return new TextlintLogFileFormat(context.Log);
     }
+
+    /// <summary>
+    /// Registers a new URL resolver with default priority of 0.
+    /// </summary>
+    /// <param name="context">The context.</param>
+    /// <param name="resolver">Resolver which returns an <see cref="Uri"/> linking to a site
+    /// containing help for a specific <see cref="BaseRuleDescription"/>.</param>
+    /// <example>
+    /// <para>Adds a provider with default priority of 0 returning a link for all rules starting
+    /// with the string <c>Foo</c> to search with Google for the rule:</para>
+    /// <code>
+    /// <![CDATA[
+    /// TapTextlintAddRuleUrlResolver(x =>
+    ///     x.Rule.StartsWith("Foo") ?
+    ///     new Uri("https://www.google.com/search?q=%22" + x.Rule + "%22") :
+    ///     null)
+    /// ]]>
+    /// </code>
+    /// </example>
+    [CakeMethodAlias]
+    [CakeAliasCategory(IssuesAliasConstants.IssueProviderCakeAliasCategory)]
+    public static void TapTextlintAddRuleUrlResolver(
+        this ICakeContext context,
+        Func<BaseRuleDescription, Uri> resolver)
+    {
+        context.NotNull();
+        resolver.NotNull();
+
+        TextlintRuleUrlResolver.Instance.AddUrlResolver(resolver);
+    }
+
+    /// <summary>
+    /// Registers a new URL resolver with a specific priority.
+    /// </summary>
+    /// <param name="context">The context.</param>
+    /// <param name="resolver">Resolver which returns an <see cref="Uri"/> linking to a site
+    /// containing help for a specific <see cref="BaseRuleDescription"/>.</param>
+    /// <param name="priority">Priority of the resolver. Resolver with a higher priority are considered
+    /// first during resolving of the URL.</param>
+    /// <example>
+    /// <para>Adds a provider of priority 5 returning a link for all rules starting with the string
+    /// <c>Foo</c> to search with Google for the rule:</para>
+    /// <code>
+    /// <![CDATA[
+    /// TapTextlintAddRuleUrlResolver(x =>
+    ///     x.Rule.StartsWith("Foo") ?
+    ///     new Uri("https://www.google.com/search?q=%22" + x.Rule + "%22") :
+    ///     null,
+    ///     5)
+    /// ]]>
+    /// </code>
+    /// </example>
+    [CakeMethodAlias]
+    [CakeAliasCategory(IssuesAliasConstants.IssueProviderCakeAliasCategory)]
+    public static void TapTextlintAddRuleUrlResolver(
+        this ICakeContext context,
+        Func<BaseRuleDescription, Uri> resolver,
+        int priority)
+    {
+        context.NotNull();
+        resolver.NotNull();
+
+        TextlintRuleUrlResolver.Instance.AddUrlResolver(resolver, priority);
+    }
 }