Fix: files with _snippets in their name incorrectly treated as snippet-only files (#2743)

* Initial plan

* Fix: treat only _snippets directories as special, not filenames containing _snippets

Co-authored-by: reakaleek <16325797+reakaleek@users.noreply.github.com>

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: reakaleek <16325797+reakaleek@users.noreply.github.com>
Co-authored-by: Felipe Cotti <felipe.cotti@elastic.co>

Author: 3 people

src/Elastic.Markdown/IO/MarkdownFileFactory.cs

@@ -117,7 +117,8 @@ private DocumentationFile CreateMarkDownFile(IFileInfo file, BuildContext contex
 		if (context.Configuration.IsExcluded(relativePath))
 			return new ExcludedFile(file, sourceDirectory, context.Git.RepositoryName);
 
-		if (relativePath.Contains("_snippets"))
+		if (relativePath.Contains($"{Path.DirectorySeparatorChar}_snippets{Path.DirectorySeparatorChar}")
+			|| relativePath.StartsWith($"_snippets{Path.DirectorySeparatorChar}"))
 			return new SnippetFile(file, sourceDirectory, context.Git.RepositoryName);
 
 		// we ignore files in folders that start with an underscore

src/Elastic.Markdown/Myst/Directives/Include/IncludeBlock.cs

@@ -93,7 +93,7 @@ private void ExtractInclusionPath(ParserContext context)
 		if (Literal)
 			return;
 
-		if (file.Directory != null && file.Directory.FullName.IndexOf("_snippets", StringComparison.Ordinal) < 0)
+		if (file.Directory != null && !file.Directory.FullName.Split(Path.DirectorySeparatorChar, Path.AltDirectorySeparatorChar).Contains("_snippets"))
 		{
 			this.EmitError($"{{include}} only supports including snippets from `_snippet` folders. `{IncludePath}` is not a snippet");
 			Found = false;

tests/Elastic.Markdown.Tests/MockFileSystemExtensions.cs

@@ -34,7 +34,7 @@ public static void GenerateDocSetYaml(
 			.EnumerateFiles(root.FullName, "*.md", SearchOption.AllDirectories);
 		foreach (var markdownFile in markdownFiles)
 		{
-			if (markdownFile.Contains("_snippet"))
+			if (markdownFile.Contains($"{Path.DirectorySeparatorChar}_snippets{Path.DirectorySeparatorChar}"))
 				continue;
 			var relative = fileSystem.Path.GetRelativePath(root.FullName, markdownFile);
 			yaml.WriteLine($" - file: {relative}");

tests/Elastic.Markdown.Tests/OutputDirectoryTests.cs

@@ -44,6 +44,35 @@ public async Task CreatesDefaultOutputDirectory()
 		fileSystem.Directory.Exists(".artifacts").Should().BeTrue();
 	}
 
+	[Fact]
+	public void FilesWithSnippetsInNameNotTreatedAsSnippets()
+	{
+		var logger = new TestLoggerFactory(output);
+		var fileSystem = new MockFileSystem(new Dictionary<string, MockFileData>
+		{
+			{ "docs/docset.yml",
+				//language=yaml
+				new MockFileData("""
+project: test
+toc:
+- file: index.md
+- file: top_snippets.md
+""") },
+			{ "docs/index.md", new MockFileData("# Test") },
+			{ "docs/top_snippets.md", new MockFileData("# Top Snippets") }
+		}, new MockFileSystemOptions
+		{
+			CurrentDirectory = Paths.WorkingDirectoryRoot.FullName
+		});
+		var collector = new TestDiagnosticsCollector(output);
+		var configurationContext = TestHelpers.CreateConfigurationContext(fileSystem);
+		var context = new BuildContext(collector, FileSystemFactory.ScopeCurrentWorkingDirectory(fileSystem), configurationContext);
+		var linkResolver = new TestCrossLinkResolver();
+		var set = new DocumentationSet(context, logger, linkResolver);
+
+		set.MarkdownFiles.Should().Contain(f => f.RelativePath.EndsWith("top_snippets.md"));
+	}
+
 	[Theory]
 	[MemberData(nameof(ValidFileNames))]
 	public void OutputFileValidationValidNames(string fileName)