Have the command parse docset

Author: theletterf

docs/_docset.yml

@@ -123,6 +123,7 @@ toc:
           - file: index.md
           - file: build.md
           - file: diff-validate.md
+          - file: format.md
           - file: index-command.md
           - file: mv.md
           - file: serve.md

docs/cli/docset/format.md

@@ -18,7 +18,9 @@ docs-builder format [options...] [-h|--help] [--version]
 
 ## Description
 
-The `format` command automatically detects and fixes formatting issues in your documentation files. Currently, it handles irregular whitespace characters that may impair Markdown rendering.
+The `format` command automatically detects and fixes formatting issues in your documentation files. The command only processes Markdown files (`.md`) that are included in your `_docset.yml` table of contents, ensuring that only intentional documentation files are modified.
+
+Currently, it handles irregular whitespace characters that may impair Markdown rendering.
 
 ### Irregular Whitespace Detection
 

src/authoring/Elastic.Documentation.Refactor/FormatService.cs

@@ -7,13 +7,16 @@
 using System.Text;
 using Elastic.Documentation.Configuration;
 using Elastic.Documentation.Diagnostics;
+using Elastic.Documentation.Links.CrossLinks;
 using Elastic.Documentation.Services;
+using Elastic.Markdown.IO;
 using Microsoft.Extensions.Logging;
 
 namespace Elastic.Documentation.Refactor;
 
 public class FormatService(
-	ILoggerFactory logFactory
+	ILoggerFactory logFactory,
+	IConfigurationContext configurationContext
 ) : IService
 {
 	private readonly ILogger _logger = logFactory.CreateLogger<FormatService>();
@@ -58,37 +61,33 @@ Cancel ctx
 	)
 	{
 		var isDryRun = dryRun ?? false;
-		var rootPath = string.IsNullOrEmpty(path) ? fs.Directory.GetCurrentDirectory() : path;
-		var rootDir = fs.DirectoryInfo.New(rootPath);
 
-		if (!rootDir.Exists)
-		{
-			collector.EmitError(string.Empty, $"Directory not found: {rootPath}");
-			return false;
-		}
+		// Create BuildContext to load the documentation set
+		var context = new BuildContext(collector, fs, fs, configurationContext, ExportOptions.MetadataOnly, path, null);
+		var set = new DocumentationSet(context, logFactory, NoopCrossLinkResolver.Instance);
 
-		_logger.LogInformation("Formatting documentation in: {Path}", rootDir.FullName);
+		_logger.LogInformation("Formatting documentation in: {Path}", set.SourceDirectory.FullName);
 		if (isDryRun)
 			_logger.LogInformation("Running in dry-run mode - no files will be modified");
 
-		var markdownFiles = rootDir.GetFiles("*.md", SearchOption.AllDirectories);
 		var totalFilesProcessed = 0;
 		var totalFilesModified = 0;
 		var totalReplacements = 0;
 
-		foreach (var file in markdownFiles)
+		// Only process markdown files that are part of the documentation set
+		foreach (var docFile in set.Files.OfType<MarkdownFile>())
 		{
 			if (ctx.IsCancellationRequested)
 				break;
 
 			totalFilesProcessed++;
-			var (modified, replacements) = await ProcessFile(file, isDryRun, fs);
+			var (modified, replacements) = await ProcessFile(docFile.SourceFile, isDryRun, fs);
 
 			if (modified)
 			{
 				totalFilesModified++;
 				totalReplacements += replacements;
-				_logger.LogInformation("Fixed {Count} irregular whitespace(s) in: {File}", replacements, GetRelativePath(rootDir, file));
+				_logger.LogInformation("Fixed {Count} irregular whitespace(s) in: {File}", replacements, docFile.RelativePath);
 			}
 		}
 
@@ -140,17 +139,4 @@ Cancel ctx
 
 		return (modified, replacements);
 	}
-
-	private static string GetRelativePath(IDirectoryInfo root, IFileInfo file)
-	{
-		var rootPath = root.FullName.TrimEnd(Path.DirectorySeparatorChar, Path.AltDirectorySeparatorChar);
-		var filePath = file.FullName;
-
-		if (filePath.StartsWith(rootPath, StringComparison.OrdinalIgnoreCase))
-		{
-			return filePath.Substring(rootPath.Length).TrimStart(Path.DirectorySeparatorChar, Path.AltDirectorySeparatorChar);
-		}
-
-		return filePath;
-	}
 }

src/tooling/docs-builder/Commands/FormatCommand.cs

@@ -14,7 +14,8 @@ namespace Documentation.Builder.Commands;
 
 internal sealed class FormatCommand(
 	ILoggerFactory logFactory,
-	IDiagnosticsCollector collector
+	IDiagnosticsCollector collector,
+	IConfigurationContext configurationContext
 )
 {
 	/// <summary>
@@ -32,7 +33,7 @@ public async Task<int> Format(
 	{
 		await using var serviceInvoker = new ServiceInvoker(collector);
 
-		var service = new FormatService(logFactory);
+		var service = new FormatService(logFactory, configurationContext);
 		var fs = new FileSystem();
 
 		serviceInvoker.AddCommand(service, (path, dryRun, fs),