[ACS-6071] fix jsdoc warnings and errors (#8948)

* fix content docs

* fix extensions docs

* fix insights docs

* [ci:force] fix jsdoc errors and warnings

* enable jsdoc linter

* [ci:force] fix demo shell jsdoc

* [ci:force] fix e2e typings

* fix typo

* fix typo
This commit is contained in:
Denys Vuika
2023-09-29 08:11:58 +01:00
committed by GitHub
parent 501516c8f5
commit d72eb5ebd3
86 changed files with 1233 additions and 254 deletions

View File

@@ -49,6 +49,12 @@ const missingRepositories = {
'rxjs-compat': 'https://github.com/ReactiveX/rxjs/tree/master/compat'
};
/**
* Get a license with MD link
*
* @param licenseExp license expression
* @returns license
*/
function licenseWithMDLinks(licenseExp: string): string {
let licenseUrl = '';
@@ -69,6 +75,12 @@ function licenseWithMDLinks(licenseExp: string): string {
}
}
/**
* Get package file
*
* @param packagePath package.json path
* @returns package model
*/
function getPackageFile(packagePath: string): PackageInfo {
try {
return JSON.parse(fs.readFileSync(packagePath).toString());
@@ -78,6 +90,13 @@ function getPackageFile(packagePath: string): PackageInfo {
}
}
/**
* Licenses command
*
* @param _args (not used)
* @param workingDir working directory
* @returns void function
*/
export default function main(_args: string[], workingDir: string) {
program
.description('Generate a licences report')