Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
15 changes: 15 additions & 0 deletions src/module.ts
Original file line number Diff line number Diff line change
Expand Up @@ -109,12 +109,18 @@ export default defineNuxtModule<ModuleOptions>({
nitroConfig.handlers.push({
route: '/api/_github/repository',
handler: resolveModule('./server/api/repository', { paths: runtimeDir })
}, {
route: '/api/_github/repository/:query',
handler: resolveModule('./server/api/repository', { paths: runtimeDir })
})

// Setup readme file API
nitroConfig.handlers.push({
route: '/api/_github/readme',
handler: resolveModule('./server/api/readme', { paths: runtimeDir })
}, {
route: '/api/_github/readme/:query',
handler: resolveModule('./server/api/readme', { paths: runtimeDir })
})

// Repository component
Expand Down Expand Up @@ -144,6 +150,9 @@ export default defineNuxtModule<ModuleOptions>({
nitroConfig.handlers.push({
route: '/api/_github/releases',
handler: resolveModule('./server/api/releases/index', { paths: runtimeDir })
}, {
route: '/api/_github/releases/:query',
handler: resolveModule('./server/api/releases/index', { paths: runtimeDir })
})
nitroConfig.prerender.routes.push('/api/_github/releases')

Expand All @@ -170,13 +179,19 @@ export default defineNuxtModule<ModuleOptions>({
nitroConfig.handlers.push({
route: '/api/_github/contributors',
handler: resolveModule('./server/api/contributors', { paths: runtimeDir })
}, {
route: '/api/_github/contributors/:query',
handler: resolveModule('./server/api/contributors', { paths: runtimeDir })
})
nitroConfig.prerender.routes.push('/api/_github/contributors')

// TODO: Add prerender for file arguments (using :source argument)
nitroConfig.handlers.push({
route: '/api/_github/contributors/file',
handler: resolveModule('./server/api/contributors/file', { paths: runtimeDir })
}, {
route: '/api/_github/contributors/file/:query',
handler: resolveModule('./server/api/contributors/file', { paths: runtimeDir })
})

// Contributors components
Expand Down
22 changes: 14 additions & 8 deletions src/runtime/composables/useGithub.ts
Original file line number Diff line number Diff line change
@@ -1,39 +1,39 @@
import { withQuery, QueryObject } from 'ufo'
import type { ParsedContent } from '@nuxt/content/dist/runtime/types'
import type { GithubRepositoryOptions, GithubContributorsQuery, GithubReleasesQuery, GithubRepository, GithubRawRelease, GithubRawContributor, GithubReleaseQuery } from '../types'

export const useGithub = () => {
const fetchRepository = (query: GithubRepositoryOptions): Promise<GithubRepository> => {
const url = withQuery('/api/_github/repository', query as QueryObject)
const url = `/api/_github/repository/${encodeParams(query)}`
return $fetch(url, { responseType: 'json' })
}

const fetchRelease = (query: GithubReleaseQuery): Promise<GithubRawRelease> => {
const url = withQuery('/api/_github/releases', query as QueryObject)
const url = `/api/_github/releases/${encodeParams(query)}`
return $fetch(url, { responseType: 'json' })
}

const fetchLastRelease = (query: GithubRepositoryOptions): Promise<GithubRawRelease> => {
const url = withQuery('/api/_github/releases', { ...query, last: 'true' } as QueryObject)
const url = `/api/_github/releases/${encodeParams({ ...query, last: true })}`
return $fetch(url, { responseType: 'json' })
}

const fetchReleases = (query: GithubReleasesQuery): Promise<GithubRawRelease[]> => {
const url = withQuery('/api/_github/releases', query as QueryObject)
const url = `/api/_github/releases/${encodeParams(query)}`
return $fetch(url, { responseType: 'json' })
}

const fetchContributors = (query: GithubContributorsQuery): Promise<GithubRawContributor[]> => {
const url = withQuery('/api/_github/contributors', query as QueryObject)
const url = `/api/_github/contributors/${encodeParams(query)}`
return $fetch(url, { responseType: 'json' })
}

const fetchFileContributors = (query: GithubContributorsQuery): Promise<GithubRawContributor[]> => {
const url = withQuery('/api/_github/contributors/file', query as QueryObject)
const url = `/api/_github/contributors/file/${encodeParams(query)}`
return $fetch(url, { responseType: 'json' })
}

const fetchReadme = (query: GithubRepositoryOptions): Promise<ParsedContent> => {
const url = withQuery('/api/_github/readme', query as QueryObject)
const url = `/api/_github/readme/${encodeParams(query)}`
return $fetch(url, { responseType: 'json' })
}

Expand All @@ -47,3 +47,9 @@ export const useGithub = () => {
fetchReadme
}
}

function encodeParams (params: any) {
return Object.entries(params)
.map(([key, value]) => `${key}_${String(value)}`)
.join(',')
}
7 changes: 3 additions & 4 deletions src/runtime/server/api/contributors/file.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
import { useQuery } from 'h3'
import type { ModuleOptions } from '../../../../module'
import { fetchFileContributors, overrideConfig } from '../../utils/queries'
import { decodeParams, fetchFileContributors, overrideConfig } from '../../utils/queries'
import { GithubContributorsQuery } from '../../../types'
// @ts-ignore
import * as imports from '#imports'
Expand All @@ -19,9 +18,9 @@ if (process.env.NODE_ENV === 'development' || moduleConfig.disableCache) {
}

export default handler(
async ({ req }) => {
async (event) => {
// Get query
const query = useQuery(req) as GithubContributorsQuery
const query = decodeParams(event.context.params.query) as GithubContributorsQuery

// Merge query in module config
const githubConfig = overrideConfig(moduleConfig, query)
Expand Down
7 changes: 3 additions & 4 deletions src/runtime/server/api/contributors/index.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
import { useQuery } from 'h3'
import type { ModuleOptions } from '../../../../module'
import { fetchRepositoryContributors, overrideConfig } from '../../utils/queries'
import { decodeParams, fetchRepositoryContributors, overrideConfig } from '../../utils/queries'
import { GithubContributorsQuery } from '../../../types'
// @ts-ignore
import * as imports from '#imports'
Expand All @@ -20,9 +19,9 @@ if (process.env.NODE_ENV === 'development' || moduleConfig.disableCache) {

// eslint-disable-next-line import/namespace
export default handler(
async ({ req }) => {
async (event) => {
// Get query
const query = useQuery(req) as GithubContributorsQuery
const query = decodeParams(event.context.params.query) as GithubContributorsQuery

// Merge query in module config
const githubConfig = overrideConfig(moduleConfig, query)
Expand Down
7 changes: 3 additions & 4 deletions src/runtime/server/api/readme.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
import { useQuery } from 'h3'
import { overrideConfig, fetchReadme } from '../utils/queries'
import { overrideConfig, fetchReadme, decodeParams } from '../utils/queries'
import type { ModuleOptions } from '../../../module'
import { GithubRepositoryOptions, GithubRepositoryReadme } from '../../types'
// @ts-ignore
Expand All @@ -21,9 +20,9 @@ if (process.env.NODE_ENV === 'development' || moduleConfig.disableCache) {
}

export default handler(
async ({ req }) => {
async (event) => {
// Get query
const query = useQuery(req) as GithubRepositoryOptions
const query = decodeParams(event.context.params.query) as GithubRepositoryOptions

// Merge query in base config
const githubConfig = overrideConfig(moduleConfig, query)
Expand Down
7 changes: 3 additions & 4 deletions src/runtime/server/api/releases/index.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
import { useQuery } from 'h3'
import { fetchReleases, overrideConfig, parseRelease } from '../../utils/queries'
import { decodeParams, fetchReleases, overrideConfig, parseRelease } from '../../utils/queries'
import type { ModuleOptions } from '../../../../module'
import { GithubRawRelease, GithubReleasesQuery } from '../../../types'
// @ts-ignore
Expand All @@ -19,9 +18,9 @@ if (process.env.NODE_ENV === 'development' || moduleConfig.disableCache) {
}

export default handler(
async ({ req }) => {
async (event) => {
// Get query
const query = useQuery(req) as GithubReleasesQuery
const query = decodeParams(event.context.params.query) as GithubReleasesQuery

// Merge query in base config
const githubConfig = overrideConfig(moduleConfig, query)
Expand Down
7 changes: 3 additions & 4 deletions src/runtime/server/api/repository.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
import { useQuery } from 'h3'
import { fetchRepository, overrideConfig } from '../utils/queries'
import { decodeParams, fetchRepository, overrideConfig } from '../utils/queries'
import { ModuleOptions } from '../../../module'
import { GithubRepository, GithubRepositoryOptions } from '../../types'
// @ts-ignore
Expand All @@ -20,9 +19,9 @@ if (process.env.NODE_ENV === 'development' || moduleConfig.disableCache) {

// eslint-disable-next-line import/namespace
export default handler(
async ({ req }) => {
async (event) => {
// Get query
const query = useQuery(req) as GithubRepositoryOptions
const query = decodeParams(event.context.params.query) as GithubRepositoryOptions

// Merge query in module config
const githubConfig = overrideConfig(moduleConfig, query)
Expand Down
11 changes: 11 additions & 0 deletions src/runtime/server/utils/queries.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import { joinURL, withQuery, QueryObject } from 'ufo'
import { graphql } from '@octokit/graphql'
import remarkGithub from 'remark-github'
import { defu } from 'defu'
import type {
ModuleOptions
Expand All @@ -8,6 +9,15 @@ import { GithubRawRelease, GithubRepositoryOptions, GithubRawContributor, Github
// @ts-ignore
import { parseContent } from '#content/server'

export function decodeParams (params: string = '') {
const result = {}
for (const param of params.split(',')) {
const [key, ...value] = param.split('_')
result[key] = value.join('_')
}
return result
}

function isBot (user) {
return user.login.includes('[bot]') || user.login.includes('-bot') || user.login.includes('.bot')
}
Expand Down Expand Up @@ -68,6 +78,7 @@ export const parseRelease = async (release: GithubRawRelease, githubConfig: Gith
markdown: {
remarkPlugins: {
'remark-github': {
instance: remarkGithub,
repository: `${githubConfig.owner}/${githubConfig.repo}`
}
}
Expand Down