Skip to content

Commit f9881a7

Browse files
ghostdevvtrivikr
authored andcommitted
chore: add some comments
1 parent 500e0c5 commit f9881a7

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

server/utils/readme-loaders.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -104,10 +104,13 @@ export const resolvePackageReadmeSource = defineCachedFunction(
104104
readmeContent!.length >= NPM_README_TRUNCATION_THRESHOLD
105105
) {
106106
const resolvedVersion = version ?? packageData['dist-tags']?.latest
107+
108+
// try fetching the given readme file first
107109
let jsdelivrReadme =
108110
readmeFilename &&
109111
(await fetchReadmeFromJsdelivr(packageName, [readmeFilename], resolvedVersion))
110112

113+
// if it's unsucessful, fetch all known readme filenames
111114
if (!jsdelivrReadme) {
112115
const readmeCandidates = buildReadmeFetchCandidates(readmeFilename)
113116
jsdelivrReadme = await fetchReadmeFromJsdelivr(
@@ -117,6 +120,7 @@ export const resolvePackageReadmeSource = defineCachedFunction(
117120
)
118121
}
119122

123+
// if we found sometihng, use it
120124
if (jsdelivrReadme) {
121125
readmeContent = jsdelivrReadme
122126
}

0 commit comments

Comments
 (0)