added detection of a changelog file on the root of the github repo

Author: WilcoSp

app/composables/usePackageHasChangelog.ts

@@ -2,17 +2,10 @@ export function usePackageHasChangelog(
   packageName: MaybeRefOrGetter<string>,
   version?: MaybeRefOrGetter<string | null | undefined>,
 ) {
-  return useLazyFetch<boolean>(
-    () => {
-      const name = toValue(packageName)
-      const ver = toValue(version)
-      const base = `/api/changelog/has/${name}`
-      return ver ? `${base}/v/${ver}` : base
-    },
-    {
-      onResponse(r) {
-        console.log({ r })
-      },
-    },
-  )
+  return useLazyFetch<boolean>(() => {
+    const name = toValue(packageName)
+    const ver = toValue(version)
+    const base = `/api/changelog/has/${name}`
+    return ver ? `${base}/v/${ver}` : base
+  })
 }

app/pages/package/[...package].vue

@@ -119,8 +119,6 @@ const { data: packageAnalysis } = usePackageAnalysis(packageName, requestedVersi
 const { data: moduleReplacement } = useModuleReplacement(packageName)
 const { data: hasChangelog } = usePackageHasChangelog(packageName, requestedVersion)
 
-watchEffect(() => console.log('hasChangelog', hasChangelog.value))
-
 const {
   data: resolvedVersion,
   status: versionStatus,
@@ -759,13 +757,15 @@ onKeyStroke(
                 {{ $t('package.links.issues') }}
               </a>
             </li>
-            <NuxtLink
-              v-if="hasChangelog"
-              class="link-subtle font-mono text-sm inline-flex items-center gap-1.5"
-            >
-              <span class="i-carbon:catalog w-4 h-4" aria-hidden="true" />
-              {{ $t('package.links.changelog') }}
-            </NuxtLink>
+            <li>
+              <NuxtLink
+                v-if="hasChangelog"
+                class="link-subtle font-mono text-sm inline-flex items-center gap-1.5"
+              >
+                <span class="i-carbon:warning w-4 h-4" aria-hidden="true" />
+                {{ $t('package.links.changelog') }}
+              </NuxtLink>
+            </li>
             <li>
               <a
                 :href="`https://www.npmjs.com/package/${pkg.name}`"

server/api/changelog/has/[...pkg].get.ts

@@ -26,7 +26,7 @@ export default defineCachedEventHandler(
         `${NPM_REGISTRY}/${encodedName}${versionSuffix}`,
       )
 
-      return await detectHasChangelog(pkg)
+      return !!(await detectHasChangelog(pkg))
     } catch (error) {
       handleApiError(error, {
         statusCode: 502,

server/utils/has-changelog.ts

@@ -24,7 +24,7 @@ export async function detectHasChangelog(
     return true
   }
 
-  return false
+  return checkChangelogFile(repoRef)
 }
 
 /**
@@ -64,3 +64,53 @@ function getLatestReleaseUrl(ref: RepoRef): null | string[] {
 
   return null
 }
+
+const CHANGELOG_FILENAMES = ['changelog', 'history', 'changes', 'news', 'releases'] as const
+
+async function checkChangelogFile(ref: RepoRef) {
+  const checkUrls = getChangelogUrls(ref)
+
+  for (const checkUrl of checkUrls ?? []) {
+    const exists = await fetch(checkUrl, {
+      headers: {
+        // GitHub API requires User-Agent
+        'User-Agent': 'npmx.dev',
+      },
+      method: 'HEAD', // we just need to know if it exists or not
+    })
+      .then(r => r.ok)
+      .catch(() => false)
+    if (exists) {
+      console.log('exists', checkUrl)
+      return true
+    }
+  }
+  return false
+}
+
+function getChangelogUrls(ref: RepoRef) {
+  const baseUrl = getBaseFileUrl(ref)
+  if (!baseUrl) {
+    return
+  }
+
+  return CHANGELOG_FILENAMES.flatMap(fileName => {
+    const fileNameUpCase = fileName.toUpperCase()
+    return [
+      `${baseUrl}/${fileNameUpCase}.md`,
+      `${baseUrl}/${fileName}.md`,
+      `${baseUrl}/${fileNameUpCase}`,
+      `${baseUrl}/${fileName}`,
+      `${baseUrl}/${fileNameUpCase}.txt`,
+      `${baseUrl}/${fileName}.txt`,
+    ]
+  })
+}
+
+function getBaseFileUrl(ref: RepoRef) {
+  switch (ref.provider) {
+    case 'github':
+      return `https://ungh.cc/repos/${ref.owner}/${ref.repo}/files/HEAD`
+  }
+  return null
+}