now able to detect whether gh releases are biing used by a package.

Author: WilcoSp

app/composables/usePackageAnalysis.ts

@@ -10,6 +10,8 @@ export interface PackageAnalysisResponse {
     npm?: string
   }
   createPackage?: CreatePackageInfo
+  // TODO move this to it's own composable
+  hasChangelog?: boolean
 }
 
 /**

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

@@ -699,6 +699,14 @@ defineOgImageComponent('Package', {
                 {{ $t('package.links.issues') }}
               </a>
             </li>
+
+            <NuxtLink
+              v-if="packageAnalysis?.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>
               <a
                 :href="`https://www.npmjs.com/package/${pkg.name}`"

server/api/registry/analysis/[...pkg].get.ts

@@ -19,6 +19,7 @@ import {
 } from '#shared/utils/constants'
 import { parseRepoUrl } from '#shared/utils/git-providers'
 import { getLatestVersion, getLatestVersionBatch } from 'fast-npm-meta'
+import { detectHasChangelog } from '~~/server/utils/has-changelog'
 
 export default defineCachedEventHandler(
   async event => {
@@ -53,11 +54,13 @@ export default defineCachedEventHandler(
       const createPackage = await findAssociatedCreatePackage(packageName, pkg)
 
       const analysis = analyzePackage(pkg, { typesPackage, createPackage })
-
+      // TODO move this to it's own endpoint
+      const hasChangelog = await detectHasChangelog(pkg)
       return {
         package: packageName,
         version: pkg.version ?? version ?? 'latest',
         ...analysis,
+        hasChangelog,
       } satisfies PackageAnalysisResponse
     } catch (error: unknown) {
       handleApiError(error, {
@@ -215,4 +218,5 @@ function hasSameRepositoryOwner(
 export interface PackageAnalysisResponse extends PackageAnalysis {
   package: string
   version: string
+  hasChangelog: boolean | null
 }

server/utils/has-changelog.ts

@@ -0,0 +1,66 @@
+import type { ExtendedPackageJson } from '~~/shared/utils/package-analysis'
+import { parseRepoUrl, type RepoRef } from '~~/shared/utils/git-providers'
+
+/**
+ * Detect whether changelogs/releases are available for this package
+ *
+ * first checks if releases are available and then changelog.md
+ */
+export async function detectHasChangelog(
+  pkg: ExtendedPackageJson,
+  // packageName: string,
+  // version: string,
+) {
+  if (!pkg.repository?.url) {
+    return false
+  }
+
+  const repoRef = parseRepoUrl(pkg.repository.url)
+  if (!repoRef) {
+    return false
+  }
+
+  if (await checkReleases(repoRef)) {
+    return true
+  }
+
+  return null
+}
+
+/**
+ * check whether releases are being used with this repo
+ * @returns true if in use
+ */
+async function checkReleases(ref: RepoRef): Promise<boolean> {
+  const checkUrls = getLatestReleaseUrl(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) {
+      return true
+    }
+  }
+  return false
+}
+
+/**
+ * get the url to check if releases are being used.
+ *
+ * @returns returns an array so that if providers don't have a latest that we can check for versions
+ */
+function getLatestReleaseUrl(ref: RepoRef): null | string[] {
+  switch (ref.provider) {
+    case 'github':
+      return [`https://ungh.cc/repos/${ref.owner}/${ref.repo}/releases/latest`]
+  }
+
+  return null
+}