| | | 1 | | using System.Text; |
| | | 2 | | |
| | | 3 | | namespace NexusLabs.Needlr.Generators; |
| | | 4 | | |
| | | 5 | | /// <summary> |
| | | 6 | | /// Helper class for writing documentation breadcrumbs to generated source code. |
| | | 7 | | /// Respects the configured <see cref="BreadcrumbLevel"/> to control output verbosity. |
| | | 8 | | /// </summary> |
| | | 9 | | internal sealed class BreadcrumbWriter |
| | | 10 | | { |
| | | 11 | | private const int BoxWidth = 73; |
| | | 12 | | private const string BoxTopLeft = "┌"; |
| | | 13 | | private const string BoxTopRight = "┐"; |
| | | 14 | | private const string BoxBottomLeft = "└"; |
| | | 15 | | private const string BoxBottomRight = "┘"; |
| | | 16 | | private const string BoxVertical = "│"; |
| | | 17 | | private const string BoxHorizontal = "─"; |
| | | 18 | | |
| | 298312 | 19 | | public BreadcrumbLevel Level { get; } |
| | | 20 | | |
| | 458 | 21 | | public BreadcrumbWriter(BreadcrumbLevel level) |
| | | 22 | | { |
| | 458 | 23 | | Level = level; |
| | 458 | 24 | | } |
| | | 25 | | |
| | | 26 | | /// <summary> |
| | | 27 | | /// Writes a simple inline comment. Only outputs at Minimal or Verbose level. |
| | | 28 | | /// </summary> |
| | | 29 | | public void WriteInlineComment(StringBuilder sb, string indent, string comment) |
| | | 30 | | { |
| | 30496 | 31 | | if (Level == BreadcrumbLevel.None) |
| | 1187 | 32 | | return; |
| | | 33 | | |
| | 29309 | 34 | | sb.AppendLine($"{indent}// {comment}"); |
| | 29309 | 35 | | } |
| | | 36 | | |
| | | 37 | | /// <summary> |
| | | 38 | | /// Writes a verbose box comment with multiple lines. Only outputs at Verbose level. |
| | | 39 | | /// At Minimal level, outputs a simple inline comment with the title. |
| | | 40 | | /// </summary> |
| | | 41 | | public void WriteVerboseBox(StringBuilder sb, string indent, string title, params string[] lines) |
| | | 42 | | { |
| | 15226 | 43 | | if (Level == BreadcrumbLevel.None) |
| | 0 | 44 | | return; |
| | | 45 | | |
| | 15226 | 46 | | if (Level == BreadcrumbLevel.Minimal) |
| | | 47 | | { |
| | 0 | 48 | | sb.AppendLine($"{indent}// {title}"); |
| | 0 | 49 | | return; |
| | | 50 | | } |
| | | 51 | | |
| | | 52 | | // Verbose: Full box |
| | 15226 | 53 | | var horizontalLine = new string('─', BoxWidth); |
| | 15226 | 54 | | sb.AppendLine($"{indent}// {BoxTopLeft}{horizontalLine}{BoxTopRight}"); |
| | 15226 | 55 | | sb.AppendLine($"{indent}// {BoxVertical} {PadRight(title, BoxWidth - 1)}{BoxVertical}"); |
| | | 56 | | |
| | 91566 | 57 | | foreach (var line in lines) |
| | | 58 | | { |
| | 30557 | 59 | | sb.AppendLine($"{indent}// {BoxVertical} {PadRight(line, BoxWidth - 1)}{BoxVertical}"); |
| | | 60 | | } |
| | | 61 | | |
| | 15226 | 62 | | sb.AppendLine($"{indent}// {BoxBottomLeft}{horizontalLine}{BoxBottomRight}"); |
| | 15226 | 63 | | } |
| | | 64 | | |
| | | 65 | | /// <summary> |
| | | 66 | | /// Writes the file header with breadcrumb level indicator. Only at Verbose level. |
| | | 67 | | /// </summary> |
| | | 68 | | public void WriteFileHeader(StringBuilder sb, string assemblyName, string fileDescription) |
| | | 69 | | { |
| | 1012 | 70 | | sb.AppendLine("// <auto-generated/>"); |
| | | 71 | | // Suppress obsolete-type warnings in generated code. Consumers may mark types |
| | | 72 | | // [Obsolete] to signal "migrate away" while still needing them in DI. Skipping |
| | | 73 | | // their registration would silently break injection; suppressing the warning |
| | | 74 | | // lets the typeof() reference compile under TreatWarningsAsErrors. |
| | 1012 | 75 | | sb.AppendLine("#pragma warning disable CS0618 // Type or member is obsolete"); |
| | 1012 | 76 | | sb.AppendLine("#pragma warning disable CS0619 // Type or member is obsolete (error-level)"); |
| | | 77 | | |
| | 1012 | 78 | | if (Level == BreadcrumbLevel.Verbose) |
| | | 79 | | { |
| | 59 | 80 | | sb.AppendLine("// ═══════════════════════════════════════════════════════════════════════════════"); |
| | 59 | 81 | | sb.AppendLine($"// {fileDescription}"); |
| | 59 | 82 | | sb.AppendLine($"// Assembly: {assemblyName}"); |
| | 59 | 83 | | sb.AppendLine($"// Breadcrumb Level: {Level}"); |
| | 59 | 84 | | sb.AppendLine("// ═══════════════════════════════════════════════════════════════════════════════"); |
| | | 85 | | } |
| | 1012 | 86 | | } |
| | | 87 | | |
| | | 88 | | /// <summary> |
| | | 89 | | /// Gets a relative path from an absolute path, using the project directory as base. |
| | | 90 | | /// Falls back to just the filename if project root is unavailable. |
| | | 91 | | /// </summary> |
| | | 92 | | public static string GetRelativeSourcePath(string? absolutePath, string? projectDirectory) |
| | | 93 | | { |
| | 45528 | 94 | | if (absolutePath == null || absolutePath.Length == 0) |
| | 45522 | 95 | | return "[unknown]"; |
| | | 96 | | |
| | | 97 | | // Normalize path separators for cross-platform compatibility |
| | 6 | 98 | | var normalizedPath = absolutePath.Replace("\\", "/"); |
| | | 99 | | |
| | 6 | 100 | | if (projectDirectory == null || projectDirectory.Length == 0) |
| | | 101 | | { |
| | | 102 | | // Fallback to just the filename - use LastIndexOf for cross-platform |
| | 2 | 103 | | var lastSlash = normalizedPath.LastIndexOf('/'); |
| | 2 | 104 | | return lastSlash >= 0 ? normalizedPath.Substring(lastSlash + 1) : normalizedPath; |
| | | 105 | | } |
| | | 106 | | |
| | 4 | 107 | | var normalizedProjectDir = projectDirectory.Replace("\\", "/"); |
| | | 108 | | // Ensure project dir doesn't end with slash for consistent comparison |
| | 4 | 109 | | if (normalizedProjectDir.EndsWith("/")) |
| | 1 | 110 | | normalizedProjectDir = normalizedProjectDir.Substring(0, normalizedProjectDir.Length - 1); |
| | | 111 | | |
| | | 112 | | // Try to make it relative |
| | 4 | 113 | | if (normalizedPath.StartsWith(normalizedProjectDir, StringComparison.OrdinalIgnoreCase)) |
| | | 114 | | { |
| | 3 | 115 | | var relative = normalizedPath.Substring(normalizedProjectDir.Length); |
| | 3 | 116 | | if (relative.StartsWith("/")) |
| | 3 | 117 | | relative = relative.Substring(1); |
| | 3 | 118 | | return relative; |
| | | 119 | | } |
| | | 120 | | |
| | | 121 | | // Couldn't make relative, just return filename |
| | 1 | 122 | | var lastSlashFallback = normalizedPath.LastIndexOf('/'); |
| | 1 | 123 | | return lastSlashFallback >= 0 ? normalizedPath.Substring(lastSlashFallback + 1) : normalizedPath; |
| | | 124 | | } |
| | | 125 | | |
| | | 126 | | private static string PadRight(string text, int totalWidth) |
| | | 127 | | { |
| | 45783 | 128 | | if (text.Length >= totalWidth) |
| | 0 | 129 | | return text.Substring(0, totalWidth); |
| | 45783 | 130 | | return text + new string(' ', totalWidth - text.Length); |
| | | 131 | | } |
| | | 132 | | } |