[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

@@ -28,6 +28,12 @@ export interface CommitArgs {
skipGnu: boolean;
}
/**
* Get commit SHA
*
* @param args command arguments
* @returns commit SHA value
*/
function getSha(args: CommitArgs): string {
logger.info('Check commit sha...');
@@ -36,7 +42,13 @@ function getSha(args: CommitArgs): string {
return exec('git', [`rev-parse`, `${gitPointer}`], {}).trim();
}
function replacePerform(args: CommitArgs, sha: string) {
/**
* Performs the sha replacement
*
* @param args command parameters
* @param sha value to use
*/
function performReplace(args: CommitArgs, sha: string) {
logger.info(`Replace commit ${sha} in package...`);
// eslint-disable-next-line no-useless-escape
@@ -49,6 +61,11 @@ function replacePerform(args: CommitArgs, sha: string) {
}
}
/**
* Update commit SHA command
*
* @param args command arguments
*/
export default function main(args: CommitArgs) {
program
.version('0.1.0')
@@ -70,5 +87,5 @@ export default function main(args: CommitArgs) {
const sha = getSha(args);
replacePerform(args, sha);
performReplace(args, sha);
}