feat(parsecontents): rename parseReleases into parseContents, add remark-github on readme & realease

Author: Tahul

package.json

@@ -29,6 +29,7 @@
     "@nuxt/kit": "^3.0.0-rc.5",
     "@octokit/graphql": "^5.0.0",
     "@octokit/rest": "^19.0.3",
+    "remark-gfm": "^3.0.1",
     "remark-github": "^11.2.4"
   },
   "devDependencies": {

src/module.ts

@@ -13,13 +13,13 @@ export interface ModuleOptions extends GithubRepositoryOptions {
   contributors?: boolean
   maxContributors?: number
   /**
-   * Parse release notes markdown and return AST tree
+   * Parse contents (releases content, readme) Markdown and return AST tree.
    *
    * Note: This option is only available when you have `@nuxt/content` installed in your project.
    *
    * @default true
    */
-  parseReleases?: boolean
+  parseContents?: boolean
 }
 
 declare module '@nuxt/schema' {
@@ -49,7 +49,7 @@ export default defineNuxtModule<ModuleOptions>({
     releases: true,
     contributors: true,
     maxContributors: 100,
-    parseReleases: true
+    parseContents: true
   },
   setup (options, nuxt) {
     const { resolve } = createResolver(import.meta.url)
@@ -73,7 +73,7 @@ export default defineNuxtModule<ModuleOptions>({
       branch: options.branch || process.env.GITHUB_BRANCH,
       repo: options.repo || process.env.GITHUB_REPO,
       token: options.token || process.env.GITHUB_TOKEN,
-      parseReleases: options.parseReleases,
+      parseContents: options.parseContents,
       maxContributors: options.maxContributors
     }
 

src/runtime/server/api/contributors/file.ts

@@ -2,6 +2,7 @@ import { useQuery } from 'h3'
 import type { ModuleOptions } from '../../../../module'
 import { fetchFileContributors, overrideConfig } from '../../utils/queries'
 import { GithubContributorsQuery } from '../../../types'
+// @ts-ignore
 import * as imports from '#imports'
 
 let handler

src/runtime/server/api/contributors/index.ts

@@ -2,6 +2,7 @@ import { useQuery } from 'h3'
 import type { ModuleOptions } from '../../../../module'
 import { fetchRepositoryContributors, overrideConfig } from '../../utils/queries'
 import { GithubContributorsQuery } from '../../../types'
+// @ts-ignore
 import * as imports from '#imports'
 
 let handler

src/runtime/server/api/readme.ts

@@ -33,8 +33,25 @@ export default handler(
     // Fetch readme from GitHub
     const readme = await fetchReadme(githubConfig) as GithubRepositoryReadme
 
-    // Return parsed content
-    return await parseContent(`${githubConfig.owner}:${githubConfig.repo}:readme.md`, Buffer.from(readme.content, 'base64').toString())
+    // Readme readable content
+    const content = Buffer.from(readme.content, 'base64').toString()
+
+    // Parse contents with @nuxt/content if enabled
+    if (moduleConfig.parseContents) {
+      // Return parsed content
+      return await parseContent(`${githubConfig.owner}:${githubConfig.repo}:readme.md`, content, {
+        markdown: {
+          remarkPlugins: {
+          // Use current Github repository for remark-github plugin
+            'remark-github': {
+              repository: `${githubConfig.owner}/${githubConfig.repo}`
+            }
+          }
+        }
+      })
+    }
+
+    return content
   },
   {
     maxAge: 60 // cache for one minute

src/runtime/server/api/releases/index.ts

@@ -2,6 +2,7 @@ import { useQuery } from 'h3'
 import { fetchReleases, overrideConfig, parseRelease } from '../../utils/queries'
 import type { ModuleOptions } from '../../../../module'
 import { GithubRawRelease, GithubReleasesQuery } from '../../../types'
+// @ts-ignore
 import * as imports from '#imports'
 
 let handler
@@ -33,8 +34,8 @@ export default handler(
     if (!releases) { return }
 
     // Parse release notes when `parse` option is enabled and `@nuxt/content` is installed.
-    if (moduleConfig.parseReleases) {
-      releases = await Promise.all(releases.map(parseRelease))
+    if (moduleConfig.parseContents) {
+      releases = await Promise.all(releases.map(release => parseRelease(release, githubConfig)))
     }
 
     // Sort DESC by release version or date

src/runtime/server/api/releases/last.ts

@@ -1,6 +1,8 @@
+import { useQuery } from 'h3'
 import { fetchReleases, overrideConfig, parseRelease } from '../../utils/queries'
 import type { ModuleOptions } from '../../../../module'
 import { GithubRawRelease, GithubRepositoryOptions } from '../../../types'
+// @ts-ignore
 import * as imports from '#imports'
 
 let handler
@@ -29,8 +31,8 @@ export default handler(
     // Fetches releases from GitHub
     let release = await fetchReleases({ last: true }, githubConfig)
 
-    if (release && moduleConfig.parseReleases) {
-      release = await parseRelease(release as GithubRawRelease)
+    if (release && moduleConfig.parseContents) {
+      release = await parseRelease(release as GithubRawRelease, githubConfig)
     }
 
     return release

src/runtime/server/api/repository.ts

@@ -1,6 +1,8 @@
+import { useQuery } from 'h3'
 import { fetchRepository, overrideConfig } from '../utils/queries'
 import { ModuleOptions } from '../../../module'
 import { GithubRepository, GithubRepositoryOptions } from '../../types'
+// @ts-ignore
 import * as imports from '#imports'
 
 let handler

src/runtime/server/utils/queries.ts

@@ -5,7 +5,9 @@ import type {
   ModuleOptions
 } from '../../../module'
 import { GithubRawRelease, GithubRepositoryOptions, GithubRawContributors, GithubContributorsQuery, GithubReleasesQuery, GithubRepositoryReadme, GithubRepository } from '../../types'
+// @ts-ignore
 import { parseContent } from '#content/server'
+
 function isBot (user) {
   return user.login.includes('[bot]') || user.login.includes('-bot') || user.login.includes('.bot')
 }
@@ -54,11 +56,19 @@ export function githubGraphqlQuery<T = any> (query: string, options: Partial<Mod
   return gq<T>(query)
 }
 
-export const parseRelease = async (release: GithubRawRelease) => {
+export const parseRelease = async (release: GithubRawRelease, githubConfig: GithubRepositoryOptions) => {
   return {
     ...release,
     // Parse release notes when `@nuxt/content` is installed.
-    ...(typeof parseContent === 'function' && release?.body && release?.name ? await parseContent(`github:${release.name}.md`, release.body) : {})
+    ...(typeof parseContent === 'function' && release?.body && release?.name ? await parseContent(`github:${release.name}.md`, release.body) : {}, {
+      markdown: {
+        remarkPlugins: {
+          'remark-github': {
+            repository: `${githubConfig.owner}/${githubConfig.repo}`
+          }
+        }
+      }
+    })
   }
 }
 
@@ -77,15 +87,12 @@ export async function fetchRepository ({ api, owner, repo, token }: GithubReposi
     }
   }).catch((_) => {
     /*
-
     // eslint-disable-next-line no-console
     console.warn(`Cannot fetch GitHub Repository on ${url} [${err.response?.status || 500}]`)
 
     // eslint-disable-next-line no-console
     console.info('If your repository is private, make sure to provide GITHUB_TOKEN environment in `.env`')
-
     */
-
     return {}
   })
 
@@ -103,7 +110,6 @@ export async function fetchRepositoryContributors ({ max }: Partial<GithubContri
     }
   }).catch((_) => {
     /*
-
     // eslint-disable-next-line no-console
     console.warn(`Cannot fetch GitHub contributors on ${url} [${err.response?.status || 500}]`)
 
@@ -114,9 +120,7 @@ export async function fetchRepositoryContributors ({ max }: Partial<GithubContri
       // eslint-disable-next-line no-console
       console.info('To disable fetching contributors, set `github.contributors` to `false` in `nuxt.config.ts`')
     }
-
     */
-
     return []
   })
 
@@ -151,7 +155,6 @@ export async function fetchFileContributors ({ source, max }: Partial<GithubCont
     { token }
   ).catch((_) => {
     /*
-
     // eslint-disable-next-line no-console
     console.warn(`Cannot fetch GitHub file contributors on ${source} [${err.response?.status || 500}]`)
 
@@ -162,7 +165,6 @@ export async function fetchFileContributors ({ source, max }: Partial<GithubCont
       // eslint-disable-next-line no-console
       console.info('To disable fetching contributors, set `github.contributors` to `false` in `nuxt.config.ts`')
     }
-
     */
   })
 
@@ -202,7 +204,6 @@ export async function fetchReleases (query: Partial<GithubReleasesQuery>, { api,
     }
   }).catch((_) => {
     /*
-
     // eslint-disable-next-line no-console
     console.warn(`Cannot fetch GitHub releases on ${url} [${err.response?.status || 500}]`)
 
@@ -213,7 +214,6 @@ export async function fetchReleases (query: Partial<GithubReleasesQuery>, { api,
       // eslint-disable-next-line no-console
       console.info('To disable fetching releases, set `github.releases` to `false` in `nuxt.config.ts`')
     }
-
     */
   })
 
@@ -233,13 +233,11 @@ export async function fetchReadme ({ api, owner, repo, token }: GithubRepository
     }
   }).catch((_) => {
     /*
-
     // eslint-disable-next-line no-console
     console.warn(`Cannot fetch GitHub readme on ${url} [${err.response?.status || 500}]`)
 
     // eslint-disable-next-line no-console
     console.info('If your repository is private, make sure to provide GITHUB_TOKEN environment in `.env`')
-
     */
 
     return {}