Skip to content

Allow _docset.yml and _toc.yml as configuration filenames #361

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 4 commits into from
Jan 29, 2025
Merged

Allow _docset.yml and _toc.yml as configuration filenames #361

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
bf864d9
Allow _docset.yml and _toc.yml as configuration filenames
Mpdreamz Jan 28, 2025
1d8fa5e
revert enhanced code block parser changes
Mpdreamz Jan 28, 2025
b72199b
fix slow lookup and randomly use underscore docset.yml in tests
Mpdreamz Jan 28, 2025
ce2905b
target known locations first before initiating a folder scan
Mpdreamz Jan 29, 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
28 changes: 20 additions & 8 deletions src/Elastic.Markdown/BuildContext.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,29 +49,41 @@ public BuildContext(IFileSystem readFileSystem, IFileSystem writeFileSystem, str
var rootFolder = !string.IsNullOrWhiteSpace(source)
? ReadFileSystem.DirectoryInfo.New(source)
: ReadFileSystem.DirectoryInfo.New(Path.Combine(Paths.Root.FullName));
SourcePath = FindDocsFolderFromRoot(rootFolder);

(SourcePath, ConfigurationPath) = FindDocsFolderFromRoot(rootFolder);

OutputPath = !string.IsNullOrWhiteSpace(output)
? WriteFileSystem.DirectoryInfo.New(output)
: WriteFileSystem.DirectoryInfo.New(Path.Combine(Paths.Root.FullName, ".artifacts/docs/html"));

ConfigurationPath =
ReadFileSystem.FileInfo.New(Path.Combine(SourcePath.FullName, "docset.yml"));

if (ConfigurationPath.FullName != SourcePath.FullName)
SourcePath = ConfigurationPath.Directory!;

Git = GitCheckoutInformation.Create(ReadFileSystem);
}

private IDirectoryInfo FindDocsFolderFromRoot(IDirectoryInfo rootPath)
private (IDirectoryInfo, IFileInfo) FindDocsFolderFromRoot(IDirectoryInfo rootPath)
{
var configurationPath = ReadFileSystem.FileInfo.New(Path.Combine(rootPath.FullName, "docset.yml"));
if (rootPath.Exists &&
ReadFileSystem.File.Exists(Path.Combine(rootPath.FullName, "docset.yml")))
return rootPath;
return (rootPath, configurationPath);

configurationPath = ReadFileSystem.FileInfo.New(Path.Combine(rootPath.FullName, "_docset.yml"));
if (rootPath.Exists &&
ReadFileSystem.File.Exists(Path.Combine(rootPath.FullName, "_docset.yml")))
return (rootPath, configurationPath);

configurationPath = rootPath
.EnumerateFiles("docset.yml", SearchOption.AllDirectories)
.OrderByDescending(f => f.Name switch { "docset.yml" => 2, "_docset.yml" => 1, _ => 0 })
.FirstOrDefault()
?? throw new Exception($"Can not locate docset.yml file in '{rootPath}'");

var docsFolder = configurationPath.Directory
?? throw new Exception($"Can not locate docset.yml file in '{rootPath}'");

var docsFolder = rootPath.EnumerateFiles("docset.yml", SearchOption.AllDirectories).FirstOrDefault();
return docsFolder?.Directory ?? throw new Exception($"Can not locate docset.yml file in '{rootPath}'");
return (docsFolder, configurationPath);
}

}
11 changes: 10 additions & 1 deletion src/Elastic.Markdown/IO/Configuration/ConfigurationFile.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -257,8 +257,17 @@ private Dictionary<string, string> ReadDictionary(KeyValuePair<YamlNode, YamlNod
var rootPath = _context.ReadFileSystem.DirectoryInfo.New(Path.Combine(_rootPath.FullName, tocPath));
var path = Path.Combine(rootPath.FullName, "toc.yml");
var source = _context.ReadFileSystem.FileInfo.New(path);

var errorMessage = $"Nested toc: '{source.Directory}' directory has no toc.yml or _toc.yml file";

if (!source.Exists)
{
path = Path.Combine(rootPath.FullName, "_toc.yml");
source = _context.ReadFileSystem.FileInfo.New(path);
}

if (!source.Exists)
EmitError($"Nested toc: '{source.FullName}' does not exist", entry.Key);
EmitError(errorMessage, entry.Key);
else
found = true;

Expand Down