Skip to content

Make file search os independent and fix doc index on windows #3

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
josbeir merged 2 commits into from
Dec 21, 2025
Merged

Make file search os independent and fix doc index on windows #3

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d8e1244
make file search os independent and fix doc index on windows
skie Dec 20, 2025
1cd47ff
Add test and clean up exception handling for repository file search s…
josbeir Dec 21, 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
41 changes: 25 additions & 16 deletions src/Documentation/Git/Repository.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,10 @@

namespace Synapse\Documentation\Git;

use RecursiveDirectoryIterator;
use RecursiveIteratorIterator;
use RuntimeException;
use UnexpectedValueException;

/**
* Represents a git repository for documentation
Expand Down Expand Up @@ -103,30 +106,36 @@ public function getMarkdownFiles(): array
$searchPath .= DS . str_replace('/', DS, $this->root);
}

if (!is_dir($searchPath)) {
if (!is_dir($searchPath) || !is_readable($searchPath)) {
return [];
}

$command = sprintf(
'find %s -type f -name "*.md" 2>/dev/null',
escapeshellarg($searchPath),
);

$output = [];
exec($command, $output);

$files = [];
$pathPrefix = $this->path . DS;
$pathPrefixLen = strlen($pathPrefix);

foreach ($output as $file) {
// Convert absolute path to relative path from repo root
if (str_starts_with($file, $pathPrefix)) {
$relativePath = substr($file, $pathPrefixLen);
// Normalize directory separators
$relativePath = str_replace(DS, '/', $relativePath);
$files[] = $relativePath;
try {
$iterator = new RecursiveIteratorIterator(
new RecursiveDirectoryIterator(
$searchPath,
RecursiveDirectoryIterator::SKIP_DOTS,
),
);

foreach ($iterator as $file) {
if ($file->isFile() && $file->getExtension() === 'md') {
$absolutePath = $file->getPathname();
if (str_starts_with($absolutePath, $pathPrefix)) {
$relativePath = substr($absolutePath, $pathPrefixLen);
$relativePath = str_replace(DS, '/', $relativePath);
$files[] = $relativePath;
}
}
}
} catch (UnexpectedValueException $unexpectedValueException) {
// Permission denied or unreadable subdirectory encountered
// Return files collected so far to allow partial indexing
return $files;
}

return $files;
Expand Down
31 changes: 31 additions & 0 deletions tests/TestCase/Documentation/Git/RepositoryTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -537,4 +537,35 @@ public function testMultiplePullsTracked(): void
$repository->pull();
$this->assertEquals(3, $this->gitAdapter->getPullCount($repoPath));
}

/**
* Test getMarkdownFiles normalizes path separators to forward slashes
*
* Verifies that the RecursiveDirectoryIterator implementation returns
* paths with forward slashes regardless of the operating system.
*/
public function testGetMarkdownFilesNormalizesPathSeparators(): void
{
$repoPath = $this->testDir . 'test-repo';
mkdir($repoPath . DS . '.git', 0755, true);
mkdir($repoPath . DS . 'docs' . DS . 'guides' . DS . 'advanced', 0755, true);

file_put_contents($repoPath . DS . 'docs' . DS . 'guides' . DS . 'advanced' . DS . 'tips.md', '# Tips');

$repository = new Repository(
url: 'https://github.com/test/repo.git',
branch: 'main',
path: $repoPath,
gitAdapter: $this->gitAdapter,
);

$files = $repository->getMarkdownFiles();

// All paths should use forward slashes, never backslashes
foreach ($files as $file) {
$this->assertStringNotContainsString('\\', $file, 'Path should not contain backslashes: ' . $file);
}

$this->assertContains('docs/guides/advanced/tips.md', $files);
}
}
Loading