Skip to content

Fix local plugin readme file resolution #16376

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
msujew merged 1 commit into from
Oct 4, 2025
Merged

Fix local plugin readme file resolution #16376

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
14 changes: 9 additions & 5 deletions packages/vsx-registry/src/browser/vsx-extensions-model.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -177,9 +177,14 @@ export class VSXExtensionsModel {
// Attempt to read the local readme first
// It saves network resources and is faster
if (installedReadme) {
const readmeContent = await this.fileService.readFile(installedReadme);
rawReadme = readmeContent.value.toString();
} else if (extension.readmeUrl) {
try {
const readmeContent = await this.fileService.readFile(installedReadme);
rawReadme = readmeContent.value.toString();
} catch {
// fall through
}
}
if (!rawReadme && extension.readmeUrl) {
rawReadme = RequestContext.asText(
await this.request.request({ url: extension.readmeUrl })
);
Expand All @@ -203,8 +208,7 @@ export class VSXExtensionsModel {
// Since we don't know the exact capitalization of the readme file (might be README.md, readme.md, etc.)
// We attempt to find the readme file by searching through the plugin's directories
const packageUri = new URI(extension.plugin.metadata.model.packageUri);
const pluginUri = packageUri.withPath(packageUri.path.join('..'));
const pluginDirStat = await this.fileService.resolve(pluginUri);
const pluginDirStat = await this.fileService.resolve(packageUri);
const possibleNames = ['readme.md', 'readme.txt', 'readme'];
const readmeFileUri = pluginDirStat.children
?.find(child => possibleNames.includes(child.name.toLowerCase()))
Expand Down
Loading