Skip to content

fix: prefer classic readme if npm picks up a different filename #130

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
danielroe merged 6 commits into from
Jan 26, 2026
Merged

fix: prefer classic readme if npm picks up a different filename #130

Changes from 3 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
514d7af
fix: fetch readme if filename doesn't match locale
jonathanyeong Jan 26, 2026
de5132f
Use readme based on your locale
jonathanyeong Jan 26, 2026
406ed68
refactor filenames const to a shared location and rename method
jonathanyeong Jan 26, 2026
81a37f9
remove locale since it won't exist on the server
jonathanyeong Jan 26, 2026
40eed21
Merge branch 'main' into jy/fix-incorrect-readme
jonathanyeong Jan 26, 2026
0909eb1
refactor: use regexp, hoist filenames, and fall back to npm readme if…
danielroe Jan 26, 2026
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
46 changes: 34 additions & 12 deletions server/api/registry/readme/[...pkg].get.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,20 +12,12 @@ import {
*/
async function fetchReadmeFromJsdelivr(
packageName: string,
readmeFilenames: string[],
version?: string,
): Promise<string | null> {
const filenames = [
'README.md',
'readme.md',
'Readme.md',
'README',
'readme',
'README.markdown',
'readme.markdown',
]
const versionSuffix = version ? `@${version}` : ''

for (const filename of filenames) {
for (const filename of readmeFilenames) {
try {
const url = `https://cdn.jsdelivr.net/npm/${packageName}${versionSuffix}/${filename}`
const response = await fetch(url)
Expand Down Expand Up @@ -79,9 +71,29 @@ export default defineCachedEventHandler(
readmeContent = packageData.readme
}

const standardReadmeFilenames = [
'README.md',
'readme.md',
'Readme.md',
'README',
'readme',
'README.markdown',
'readme.markdown',
]

// If no README in packument, try fetching from jsdelivr (package tarball)
if (!readmeContent || readmeContent === NPM_MISSING_README_SENTINEL) {
readmeContent = (await fetchReadmeFromJsdelivr(packageName, version)) ?? undefined
if (
!readmeContent ||
readmeContent === NPM_MISSING_README_SENTINEL ||
!isPreferredReadme(packageData.readmeFilename, standardReadmeFilenames)
) {
const locale = navigator.language
Comment thread
danielroe marked this conversation as resolved.
Outdated
readmeContent =
(await fetchReadmeFromJsdelivr(
packageName,
[`README.${locale}.md`, ...standardReadmeFilenames],
version,
)) ?? undefined
}

if (!readmeContent) {
Expand All @@ -108,3 +120,13 @@ export default defineCachedEventHandler(
},
},
)

function isPreferredReadme(
filename: string | undefined,
standardReadmeFilenames: string[],
): boolean {
if (!filename) {
return false
}
return standardReadmeFilenames.includes(filename) || filename.includes(navigator.language)
}