Skip to content

Improve error message when deleting a file locally to add redirects and update call sites #1872

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 2 commits into from
Sep 11, 2025
Merged

Improve error message when deleting a file locally to add redirects and update call sites #1872

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a2126a7
Improve error message when deleting a file locally to add redirects a…
Mpdreamz Sep 11, 2025
60b2453
Emit as warning, its non breaking but we want folks to fix it
Mpdreamz Sep 11, 2025
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
17 changes: 15 additions & 2 deletions src/Elastic.Markdown/Myst/InlineParsers/DiagnosticLinkInlineParser.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
// 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 System.Diagnostics.CodeAnalysis;
using System.IO.Abstractions;
using System.Runtime.InteropServices;
Expand Down Expand Up @@ -248,9 +247,23 @@ private static void ValidateInternalUrl(InlineProcessor processor, string url, s
if (string.IsNullOrWhiteSpace(url))
return;


var pathOnDisk = Path.GetFullPath(Path.Combine(includeFrom, url.TrimStart('/')));
if (!context.Build.ReadFileSystem.File.Exists(pathOnDisk))
processor.EmitError(link, $"`{url}` does not exist. resolved to `{pathOnDisk}");
{
if (context.Configuration.Redirects is not null && context.Configuration.Redirects.TryGetValue(url.TrimStart('/'), out var redirect))
{
var name = redirect.To ??
(redirect.Many is not null
? $"one of: {string.Join(", ", redirect.Many.Select(m => m.To))}"
: "unknown"
);
processor.EmitWarning(link, $"Local file `{url}` has a redirect, please update this reference to: {name}");
}
else
processor.EmitError(link, $"`{url}` does not exist. If it was recently removed add a redirect. resolved to `{pathOnDisk}");

}
}

private static void ProcessLinkText(InlineProcessor processor, LinkInline link, MarkdownFile? markdown, string? anchor, string url, IFileInfo file)
Expand Down
Loading