Files
shields/services/docsrs/docsrs.service.js
T

54 lines
1.3 KiB
JavaScript

import Joi from 'joi'
import { BaseJsonService } from '../index.js'
const schema = Joi.object({
doc_status: Joi.boolean().required(),
}).required()
export default class DocsRs extends BaseJsonService {
static category = 'build'
static route = { base: 'docsrs', pattern: ':crate/:version?' }
static examples = [
{
title: 'docs.rs',
namedParams: { crate: 'regex', version: 'latest' },
staticPreview: this.render({ version: 'latest', docStatus: true }),
keywords: ['rust'],
},
]
static defaultBadgeData = { label: 'docs' }
static render({ docStatus, version }) {
let label = `docs@${version}`
if (version === 'latest') {
label = 'docs'
}
if (docStatus) {
return {
label,
message: 'passing',
color: 'success',
}
} else {
return {
label,
message: 'failing',
color: 'critical',
}
}
}
async fetch({ crate, version }) {
return await this._requestJson({
schema,
url: `https://docs.rs/crate/${crate}/${version}/status.json`,
})
}
async handle({ crate, version = 'latest' }) {
const { doc_status: docStatus } = await this.fetch({ crate, version })
return this.constructor.render({ version, docStatus })
}
}