Add exteranl links to links.json

Author: reakaleek

docs/source/docset.yml

@@ -77,3 +77,4 @@ toc:
       - file: index.md
       - file: req.md
       - folder: nested
+      - file: external-links.md

docs/source/testing/external-links.md

@@ -0,0 +1,7 @@
+---
+title: External Links
+---
+
+[Kibana][1]
+
+[1] kibana://index.md

src/Elastic.Markdown/Diagnostics/DiagnosticsChannel.cs

@@ -2,6 +2,7 @@
 // Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
 // See the LICENSE file in the project root for more information
 
+using System.Collections.Concurrent;
 using System.Threading.Channels;
 using Microsoft.Extensions.Hosting;
 using Microsoft.Extensions.Logging;
@@ -86,6 +87,8 @@ public class DiagnosticsCollector(ILoggerFactory loggerFactory, IReadOnlyCollect
 
 	public HashSet<string> OffendingFiles { get; } = new();
 
+	public ConcurrentDictionary<string, bool> ExternalLinks { get; } = new();
+
 	public Task StartAsync(Cancel ctx)
 	{
 		if (_started is not null)
@@ -140,6 +143,7 @@ public virtual async Task StopAsync(CancellationToken cancellationToken)
 		await Channel.Reader.Completion;
 	}
 
+	public void EmitExternalLink(string link) => ExternalLinks.TryAdd(link, true);
 
 	public void EmitError(string file, string message, Exception? e = null)
 	{

src/Elastic.Markdown/IO/LinkReference.cs

@@ -17,16 +17,22 @@ public record LinkReference
 	[JsonPropertyName("links")]
 	public required string[] Links { get; init; } = [];
 
+	[JsonPropertyName("external_links")]
+	public required string[] ExternalLinks { get; init; } = [];
+
 	public static LinkReference Create(DocumentationSet set)
 	{
+		var externalLinks = set.Context.Collector.ExternalLinks.Select(i => i.Key).ToArray();
+
 		var links = set.FlatMappedFiles.Values
 			.OfType<MarkdownFile>()
 			.Select(m => m.RelativePath).ToArray();
 		return new LinkReference
 		{
 			UrlPathPrefix = set.Context.UrlPathPrefix,
 			Origin = set.Context.Git,
-			Links = links
+			Links = links,
+			ExternalLinks = externalLinks
 		};
 	}
 }

src/Elastic.Markdown/Myst/InlineParsers/DiagnosticLinkInlineParser.cs

@@ -2,15 +2,14 @@
 // Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
 // See the LICENSE file in the project root for more information
 
+using System.Collections.Immutable;
 using Elastic.Markdown.Diagnostics;
 using Elastic.Markdown.IO;
-using Elastic.Markdown.Myst.Directives;
 using Markdig;
 using Markdig.Helpers;
 using Markdig.Parsers;
 using Markdig.Parsers.Inlines;
 using Markdig.Renderers;
-using Markdig.Syntax;
 using Markdig.Syntax.Inlines;
 
 namespace Elastic.Markdown.Myst.InlineParsers;
@@ -34,6 +33,9 @@ public void Setup(MarkdownPipeline pipeline, IMarkdownRenderer renderer) { }
 
 public class DiagnosticLinkInlineParser : LinkInlineParser
 {
+
+	private static readonly ImmutableHashSet<string> ExcludedSchemes = new[] { "http", "https", "tel", "jdbc" }.ToImmutableHashSet();
+
 	public override bool Match(InlineProcessor processor, ref StringSlice slice)
 	{
 		var match = base.Match(processor, ref slice);
@@ -44,10 +46,14 @@ public override bool Match(InlineProcessor processor, ref StringSlice slice)
 			return match;
 
 		var url = link.Url;
+		var uri = Uri.TryCreate(url, UriKind.Absolute, out var u) ? u : null;
 		var line = link.Line + 1;
 		var column = link.Column;
 		var length = url?.Length ?? 1;
 
+		if (IsExternalLink(uri))
+			processor.GetContext().Build.Collector.EmitExternalLink(url!);
+
 		var context = processor.GetContext();
 		if (processor.GetContext().SkipValidation)
 			return match;
@@ -58,7 +64,7 @@ public override bool Match(InlineProcessor processor, ref StringSlice slice)
 			return match;
 		}
 
-		if (Uri.TryCreate(url, UriKind.Absolute, out var uri) && uri.Scheme.StartsWith("http"))
+		if (uri != null && uri.Scheme.StartsWith("http"))
 		{
 			var baseDomain = uri.Host == "localhost" ? "localhost" : string.Join('.', uri.Host.Split('.')[^2..]);
 			if (!context.Configuration.ExternalLinkHosts.Contains(baseDomain))
@@ -82,15 +88,11 @@ public override bool Match(InlineProcessor processor, ref StringSlice slice)
 		var anchor = anchors.Length > 1 ? anchors[1].Trim() : null;
 		url = anchors[0];
 
-		if (!string.IsNullOrWhiteSpace(url))
+		if (!string.IsNullOrWhiteSpace(url) && uri != null)
 		{
 			var pathOnDisk = Path.Combine(includeFrom, url.TrimStart('/'));
-			if (!context.Build.ReadFileSystem.File.Exists(pathOnDisk))
+			if (uri.IsFile && !context.Build.ReadFileSystem.File.Exists(pathOnDisk))
 				processor.EmitError(line, column, length, $"`{url}` does not exist. resolved to `{pathOnDisk}");
-			else
-			{
-
-			}
 		}
 		else
 			link.Url = "";
@@ -128,8 +130,11 @@ public override bool Match(InlineProcessor processor, ref StringSlice slice)
 			link.Url += $"#{anchor}";
 
 		return match;
-
-
-
 	}
+
+	private static bool IsExternalLink(Uri? uri) =>
+		uri != null
+		&& !ExcludedSchemes.Contains(uri.Scheme)
+		&& !uri.IsFile
+		&& Path.GetExtension(uri.OriginalString) == ".md";
 }

tests/Elastic.Markdown.Tests/Inline/InlineLinkTests.cs

@@ -83,3 +83,74 @@ public void GeneratesHtml() =>
 	[Fact]
 	public void HasNoErrors() => Collector.Diagnostics.Should().HaveCount(0);
 }
+
+public class LinkReferenceTest(ITestOutputHelper output) : LinkTestBase(output,
+	"""
+	[test][test]
+
+	[test]: testing/req.md
+	"""
+)
+{
+	[Fact]
+	public void GeneratesHtml() =>
+		// language=html
+		Html.Should().Contain(
+			"""<p><a href="testing/req.html">test</a></p>"""
+		);
+
+	[Fact]
+	public void HasNoErrors() => Collector.Diagnostics.Should().HaveCount(0);
+}
+
+public class ExternalLinkReferenceTest(ITestOutputHelper output) : LinkTestBase(output,
+	"""
+	[test][test]
+
+	[test]: kibana://index.md
+	"""
+)
+{
+	[Fact]
+	public void GeneratesHtml() =>
+		// language=html
+		Html.Should().Contain(
+			"""<p><a href="kibana://index.html">test</a></p>"""
+		);
+
+	[Fact]
+	public void HasNoErrors() => Collector.Diagnostics.Should().HaveCount(0);
+
+	[Fact]
+	public void EmitsExternalLink()
+	{
+		Collector.ExternalLinks.Should().HaveCount(1);
+		Collector.ExternalLinks.Should().ContainKey("kibana://index.md");
+	}
+}
+
+public class ExternalLinkTest(ITestOutputHelper output) : LinkTestBase(output,
+	"""
+	[test](kibana://index.md)
+	"""
+)
+{
+	[Fact]
+	public void GeneratesHtml() =>
+		// language=html
+		Html.Should().Contain(
+			"""<p><a href="kibana://index.html">test</a></p>"""
+		);
+
+	[Fact]
+	public void HasNoErrors() => Collector.Diagnostics.Should().HaveCount(0);
+
+	[Fact]
+	public void EmitsExternalLink()
+	{
+		Collector.ExternalLinks.Should().HaveCount(1);
+		Collector.ExternalLinks.Should().ContainKey("kibana://index.md");
+	}
+}
+
+