inteligr8/alfresco-ng2-components
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-ng2-components.git synced 2025-07-31 17:38:48 +00:00
Code Issues Packages Projects Releases Wiki Activity

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

Browse Source 
* 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
Download Patch File Download Diff File Expand all files Collapse all files

38
lib/cli/scripts/update-version.ts
View File

@@ -37,6 +37,12 @@ export interface PackageInfo {
devDependencies?: string[];
}
/**
* Parse alfresco libraries in package.json file
*
* @param workingDir working directory
* @returns package info model
*/
function parseAlfrescoLibs(workingDir: string): PackageInfo {
const packagePath = path.resolve(path.join(workingDir, 'package.json'));
@@ -57,10 +63,23 @@ function parseAlfrescoLibs(workingDir: string): PackageInfo {
};
}
/**
* Format npm command
*
* @param deps dependencies
* @param tag tag
* @returns npm command to execute
*/
function formatNpmCommand(deps: string[], tag: string): string {
return ['npm i -E', deps.map((name) => `${name}@${tag}`).join(' ')].join(' ');
}
/**
* Run npm command
*
* @param command command to execute
* @param workingDir working directory
*/
function runNpmCommand(command: string, workingDir: string) {
if (shell.exec(command, { cwd: workingDir }).code !== 0) {
shell.echo('Error running NPM command');
@@ -68,6 +87,13 @@ function runNpmCommand(command: string, workingDir: string) {
}
}
/**
* Update libraries
*
* @param pkg package info model
* @param tag tag name
* @param workingDir working directory
*/
function updateLibs(pkg: PackageInfo, tag: string, workingDir: string) {
if (pkg.dependencies && pkg.dependencies.length > 0) {
runNpmCommand(formatNpmCommand(pkg.dependencies, tag), workingDir);
@@ -78,6 +104,12 @@ function updateLibs(pkg: PackageInfo, tag: string, workingDir: string) {
}
}
/**
* Parse tag
*
* @param args update arguments
* @returns tag value
*/
function parseTag(args: UpdateArgs): string {
if (args.alpha) {
return 'alpha';
@@ -90,6 +122,12 @@ function parseTag(args: UpdateArgs): string {
return args.version || 'latest';
}
/**
* update version command
*
* @param args arguments
* @param workingDir working directory
*/
export default function main(args: UpdateArgs, workingDir: string) {
program
.description(