a73026faa9
* feat: add gitlab-helper for encapsulate docs and err * update merge requests * fix mr example Co-authored-by: repo-ranger[bot] <39074581+repo-ranger[bot]@users.noreply.github.com>
83 lines
2.0 KiB
JavaScript
83 lines
2.0 KiB
JavaScript
import Joi from 'joi'
|
|
import { optionalUrl } from '../validators.js'
|
|
import { renderLicenseBadge } from '../licenses.js'
|
|
import { documentation, errorMessagesFor } from './gitlab-helper.js'
|
|
import GitLabBase from './gitlab-base.js'
|
|
|
|
const schema = Joi.object({
|
|
license: Joi.object({
|
|
name: Joi.string().required(),
|
|
}).allow(null),
|
|
}).required()
|
|
|
|
const queryParamSchema = Joi.object({
|
|
gitlab_url: optionalUrl,
|
|
}).required()
|
|
|
|
export default class GitlabLicense extends GitLabBase {
|
|
static category = 'license'
|
|
|
|
static route = {
|
|
base: 'gitlab/license',
|
|
pattern: ':project+',
|
|
queryParamSchema,
|
|
}
|
|
|
|
static examples = [
|
|
{
|
|
title: 'GitLab',
|
|
namedParams: {
|
|
project: 'gitlab-org/gitlab',
|
|
},
|
|
staticPreview: {
|
|
label: 'license',
|
|
message: 'MIT License',
|
|
color: 'green',
|
|
},
|
|
documentation,
|
|
},
|
|
{
|
|
title: 'GitLab (self-managed)',
|
|
namedParams: {
|
|
project: 'gitlab-cn/gitlab',
|
|
},
|
|
queryParams: { gitlab_url: 'https://jihulab.com' },
|
|
staticPreview: {
|
|
label: 'license',
|
|
message: 'MIT License',
|
|
color: 'green',
|
|
},
|
|
documentation,
|
|
},
|
|
]
|
|
|
|
static defaultBadgeData = { label: 'license' }
|
|
|
|
static render({ license }) {
|
|
if (license) {
|
|
return renderLicenseBadge({ license })
|
|
} else {
|
|
return { message: 'not specified' }
|
|
}
|
|
}
|
|
|
|
async fetch({ project, baseUrl }) {
|
|
// https://docs.gitlab.com/ee/api/projects.html#get-single-project
|
|
return super.fetch({
|
|
schema,
|
|
url: `${baseUrl}/api/v4/projects/${encodeURIComponent(project)}`,
|
|
options: { searchParams: { license: '1' } },
|
|
errorMessages: errorMessagesFor('project not found'),
|
|
})
|
|
}
|
|
|
|
async handle({ project }, { gitlab_url: baseUrl = 'https://gitlab.com' }) {
|
|
const { license: licenseObject } = await this.fetch({
|
|
project,
|
|
baseUrl,
|
|
})
|
|
const license = licenseObject ? licenseObject.name : undefined
|
|
return this.constructor.render({ license })
|
|
}
|
|
}
|