sonarcube-react: migrate to use exports

Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
This commit is contained in:
Patrik Oldsberg
2023-01-16 00:44:50 +01:00
parent 6b9eefae6b
commit 817a5cde69
2 changed files with 77 additions and 5 deletions
@@ -0,0 +1,65 @@
## API Report File for "@backstage/plugin-sonarqube-react"
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
import { ApiRef } from '@backstage/core-plugin-api';
import { Entity } from '@backstage/catalog-model';
// @public (undocumented)
export interface FindingSummary {
// (undocumented)
getComponentMeasuresUrl: SonarUrlProcessorFunc;
// (undocumented)
getIssuesUrl: SonarUrlProcessorFunc;
// (undocumented)
getSecurityHotspotsUrl: () => string;
// (undocumented)
lastAnalysis: string;
// (undocumented)
metrics: Metrics;
// (undocumented)
projectUrl: string;
}
// @public (undocumented)
export type MetricKey =
| 'alert_status'
| 'bugs'
| 'reliability_rating'
| 'vulnerabilities'
| 'security_rating'
| 'code_smells'
| 'sqale_rating'
| 'security_hotspots_reviewed'
| 'security_review_rating'
| 'coverage'
| 'duplicated_lines_density';
// @public
export type Metrics = {
[key in MetricKey]: string | undefined;
};
// @public (undocumented)
export type SonarQubeApi = {
getFindingSummary(options: {
componentKey?: string;
projectInstance?: string;
}): Promise<FindingSummary | undefined>;
};
// @public (undocumented)
export const sonarQubeApiRef: ApiRef<SonarQubeApi>;
// @public (undocumented)
export type SonarUrlProcessorFunc = (identifier: string) => string;
// @public
export const useProjectInfo: (entity: Entity) => {
projectInstance: string | undefined;
projectKey: string | undefined;
};
// (No @packageDocumentation comment for this package)
```
+12 -5
View File
@@ -5,10 +5,17 @@
"types": "src/index.ts",
"license": "Apache-2.0",
"publishConfig": {
"access": "public",
"main": "dist/index.esm.js",
"types": "dist/index.d.ts",
"alphaTypes": "dist/index.alpha.d.ts"
"access": "public"
},
"exports": {
".": "./src/index.ts"
},
"typesVersions": {
"*": {
"*": [
"src/index.ts"
]
}
},
"backstage": {
"role": "web-library"
@@ -23,7 +30,7 @@
"backstage"
],
"scripts": {
"build": "backstage-cli package build --experimental-type-build",
"build": "backstage-cli package build",
"lint": "backstage-cli package lint",
"test": "backstage-cli package test",
"prepack": "backstage-cli package prepack",