70 lines
1.4 KiB
JavaScript
70 lines
1.4 KiB
JavaScript
'use strict'
|
|
|
|
const SonarBase = require('./sonar-base')
|
|
const {
|
|
patternBase,
|
|
queryParamSchema,
|
|
getLabel,
|
|
positiveMetricColorScale,
|
|
keywords,
|
|
documentation,
|
|
} = require('./sonar-helpers')
|
|
|
|
const metric = 'public_documented_api_density'
|
|
|
|
module.exports = class SonarDocumentedApiDensity extends SonarBase {
|
|
static get category() {
|
|
return 'analysis'
|
|
}
|
|
|
|
static get route() {
|
|
return {
|
|
base: 'sonar',
|
|
pattern: `${patternBase}/${metric}`,
|
|
queryParamSchema,
|
|
}
|
|
}
|
|
|
|
static get examples() {
|
|
return [
|
|
{
|
|
title: 'Sonar Documented API Density',
|
|
namedParams: {
|
|
protocol: 'http',
|
|
host: 'sonar.petalslink.com',
|
|
component: 'org.ow2.petals:petals-se-ase',
|
|
},
|
|
queryParams: {
|
|
sonarVersion: '4.2',
|
|
},
|
|
staticPreview: this.render({ density: 82 }),
|
|
keywords,
|
|
documentation,
|
|
},
|
|
]
|
|
}
|
|
|
|
static get defaultBadgeData() {
|
|
return { label: getLabel({ metric }) }
|
|
}
|
|
|
|
static render({ density }) {
|
|
return {
|
|
message: `${density}%`,
|
|
color: positiveMetricColorScale(density),
|
|
}
|
|
}
|
|
|
|
async handle({ protocol, host, component }, { sonarVersion }) {
|
|
const json = await this.fetch({
|
|
sonarVersion,
|
|
protocol,
|
|
host,
|
|
component,
|
|
metricName: metric,
|
|
})
|
|
const { metricValue: density } = this.transform({ json, sonarVersion })
|
|
return this.constructor.render({ density })
|
|
}
|
|
}
|