Files
shields/services/codefactor/codefactor-grade.service.js
jNullj 014c827dfd refactor [Amo CiiBestPractices CircleCi Codecov CodeFactor CodeRabbit Conda Feedz Wordpress Debug] to use routeEnum (#12090)
* refactor: use routeEnum in AmoRating service

* refactor: use routeEnum in CIIBestPractices

* refactor: use routeEnum in CircleCi

* refactor: update Codecov to use routeEnum

* refactor: use routeEnum in CodeFactorGrade

* refactor: update CodeRabbitPullRequest to use routeEnum

* refactor: update Conda use routeEnum

* refactor: update Feedz to use routeEnum

* refactor: update Wordpress to use routeEnum

* refactor: update Debug to use routeEnum
2026-08-03 20:37:27 +03:00

84 lines
2.0 KiB
JavaScript

import Joi from 'joi'
import { BaseSvgScrapingService, pathParams } from '../index.js'
import { isValidGrade, gradeColor } from './codefactor-helpers.js'
const schema = Joi.object({
message: isValidGrade,
}).required()
export default class CodeFactorGrade extends BaseSvgScrapingService {
static category = 'analysis'
static route = {
base: 'codefactor/grade',
pattern: ':vcsType/:user/:repo/:branch*',
}
static routeEnum = ['github', 'bitbucket']
static openApi = {
'/codefactor/grade/{vcsType}/{user}/{repo}/{branch}': {
get: {
summary: 'CodeFactor Grade (with branch)',
parameters: pathParams(
{
name: 'vcsType',
example: 'github',
schema: { type: 'string', enum: this.getEnum('vcsType') },
},
{
name: 'user',
example: 'microsoft',
},
{
name: 'repo',
example: 'powertoys',
},
{
name: 'branch',
example: 'main',
},
),
},
},
'/codefactor/grade/{vcsType}/{user}/{repo}': {
get: {
summary: 'CodeFactor Grade',
parameters: pathParams(
{
name: 'vcsType',
example: 'github',
schema: { type: 'string', enum: this.getEnum('vcsType') },
},
{
name: 'user',
example: 'microsoft',
},
{
name: 'repo',
example: 'powertoys',
},
),
},
},
}
static defaultBadgeData = { label: 'code quality' }
static render({ grade }) {
return {
message: grade,
color: gradeColor(grade),
}
}
async handle({ vcsType, user, repo, branch }) {
const { message } = await this._requestSvg({
schema,
url: `https://codefactor.io/repository/${vcsType}/${user}/${repo}/badge/${
branch || ''
}`,
httpErrors: { 404: 'repo or branch not found' },
})
return this.constructor.render({ grade: message })
}
}