From 09665dfbe24e3dbafe47d5adfd88a0c6de59e92b Mon Sep 17 00:00:00 2001 From: lotte <lotte_hofstede@hotmail.com> Date: Tue, 30 Jun 2020 13:44:38 +0200 Subject: [PATCH] solved lint issues, added typedoc, fixed lgtm warnings --- src/app/core/data/processes/script-data.service.ts | 2 +- src/app/process-page/form/process-form.component.ts | 3 +++ .../parameter-select/parameter-select.component.ts | 3 +-- .../date-value-input/date-value-input.component.ts | 6 +++++- .../parameter-value-input.component.ts | 6 ++++-- .../string-value-input.component.ts | 6 +++++- .../process-parameters.component.ts | 4 ++++ .../form/scripts-select/scripts-select.component.ts | 6 ++++++ src/app/process-page/new/new-process.component.ts | 11 +++++++++-- src/app/process-page/processes/process.model.ts | 3 --- src/app/shared/utils/route.utils.ts | 2 +- src/test.ts | 1 - 12 files changed, 39 insertions(+), 14 deletions(-) diff --git a/src/app/core/data/processes/script-data.service.ts b/src/app/core/data/processes/script-data.service.ts index b5bfca075f..6600444ea0 100644 --- a/src/app/core/data/processes/script-data.service.ts +++ b/src/app/core/data/processes/script-data.service.ts @@ -10,7 +10,7 @@ import { HttpClient } from '@angular/common/http'; import { DefaultChangeAnalyzer } from '../default-change-analyzer.service'; import { Script } from '../../../process-page/scripts/script.model'; import { ProcessParameter } from '../../../process-page/processes/process-parameter.model'; -import { find, map, switchMap, tap } from 'rxjs/operators'; +import { find, map, switchMap } from 'rxjs/operators'; import { URLCombiner } from '../../url-combiner/url-combiner'; import { MultipartPostRequest, RestRequest } from '../request.models'; import { RequestService } from '../request.service'; diff --git a/src/app/process-page/form/process-form.component.ts b/src/app/process-page/form/process-form.component.ts index 25c47e584b..a4066a3178 100644 --- a/src/app/process-page/form/process-form.component.ts +++ b/src/app/process-page/form/process-form.component.ts @@ -41,6 +41,9 @@ export class ProcessFormComponent implements OnInit { */ public files: File[] = []; + /** + * Message key for the header of the form + */ @Input() public headerKey: string; /** diff --git a/src/app/process-page/form/process-parameters/parameter-select/parameter-select.component.ts b/src/app/process-page/form/process-parameters/parameter-select/parameter-select.component.ts index 89f69c0980..e016d3442f 100644 --- a/src/app/process-page/form/process-parameters/parameter-select/parameter-select.component.ts +++ b/src/app/process-page/form/process-parameters/parameter-select/parameter-select.component.ts @@ -1,7 +1,6 @@ -import { Component, EventEmitter, Input, OnInit, Output, Optional } from '@angular/core'; +import { Component, EventEmitter, Input, Optional, Output } from '@angular/core'; import { ProcessParameter } from '../../../processes/process-parameter.model'; import { ScriptParameter } from '../../../scripts/script-parameter.model'; -import { hasNoValue } from '../../../../shared/empty.util'; import { ControlContainer, NgForm } from '@angular/forms'; import { controlContainerFactory } from '../../process-form.component'; diff --git a/src/app/process-page/form/process-parameters/parameter-value-input/date-value-input/date-value-input.component.ts b/src/app/process-page/form/process-parameters/parameter-value-input/date-value-input/date-value-input.component.ts index 600dcbb946..7a4fbc0965 100644 --- a/src/app/process-page/form/process-parameters/parameter-value-input/date-value-input/date-value-input.component.ts +++ b/src/app/process-page/form/process-parameters/parameter-value-input/date-value-input/date-value-input.component.ts @@ -1,4 +1,4 @@ -import { Component, OnInit, Optional, Input } from '@angular/core'; +import { Component, Input, Optional } from '@angular/core'; import { ValueInputComponent } from '../value-input.component'; import { ControlContainer, NgForm } from '@angular/forms'; import { controlContainerFactory } from '../../../process-form.component'; @@ -19,6 +19,10 @@ export class DateValueInputComponent extends ValueInputComponent<string> { * The current value of the date string */ value: string; + + /** + * Initial value of the field + */ @Input() initialValue; ngOnInit() { diff --git a/src/app/process-page/form/process-parameters/parameter-value-input/parameter-value-input.component.ts b/src/app/process-page/form/process-parameters/parameter-value-input/parameter-value-input.component.ts index 6626639068..ec29ee5e1e 100644 --- a/src/app/process-page/form/process-parameters/parameter-value-input/parameter-value-input.component.ts +++ b/src/app/process-page/form/process-parameters/parameter-value-input/parameter-value-input.component.ts @@ -1,4 +1,4 @@ -import { Component, EventEmitter, Input, OnChanges, OnInit, Optional, Output } from '@angular/core'; +import { Component, EventEmitter, Input, Optional, Output } from '@angular/core'; import { ScriptParameterType } from '../../../scripts/script-parameter-type.model'; import { ScriptParameter } from '../../../scripts/script-parameter.model'; import { ControlContainer, NgForm } from '@angular/forms'; @@ -23,7 +23,9 @@ export class ParameterValueInputComponent { */ @Input() parameter: ScriptParameter; - + /** + * Initial value for input + */ @Input() initialValue: any; /** * Emits the value of the input when its updated diff --git a/src/app/process-page/form/process-parameters/parameter-value-input/string-value-input/string-value-input.component.ts b/src/app/process-page/form/process-parameters/parameter-value-input/string-value-input/string-value-input.component.ts index 12278a0e18..0e55669432 100644 --- a/src/app/process-page/form/process-parameters/parameter-value-input/string-value-input/string-value-input.component.ts +++ b/src/app/process-page/form/process-parameters/parameter-value-input/string-value-input/string-value-input.component.ts @@ -19,12 +19,16 @@ export class StringValueInputComponent extends ValueInputComponent<string> { * The current value of the string */ value: string; + + /** + * Initial value of the field + */ @Input() initialValue; ngOnInit() { this.value = this.initialValue; } - + setValue(value) { this.value = value; this.updateValue.emit(value) diff --git a/src/app/process-page/form/process-parameters/process-parameters.component.ts b/src/app/process-page/form/process-parameters/process-parameters.component.ts index 4f5c61c8d7..dfbe078463 100644 --- a/src/app/process-page/form/process-parameters/process-parameters.component.ts +++ b/src/app/process-page/form/process-parameters/process-parameters.component.ts @@ -24,6 +24,10 @@ export class ProcessParametersComponent implements OnChanges { * The currently selected script */ @Input() script: Script; + + /** + * Initial parameters on load + */ @Input() initialParams: ProcessParameter[]; /** * Emits the parameter values when they're updated diff --git a/src/app/process-page/form/scripts-select/scripts-select.component.ts b/src/app/process-page/form/scripts-select/scripts-select.component.ts index 98ed9f6dce..1e3ecfda0d 100644 --- a/src/app/process-page/form/scripts-select/scripts-select.component.ts +++ b/src/app/process-page/form/scripts-select/scripts-select.component.ts @@ -24,7 +24,13 @@ const SCRIPT_QUERY_PARAMETER = 'script'; deps: [[new Optional(), NgForm]] } ] }) export class ScriptsSelectComponent implements OnInit, OnDestroy { + /** + * Emits the selected script when the selection changes + */ @Output() select: EventEmitter<Script> = new EventEmitter<Script>(); + /** + * All available scripts + */ scripts$: Observable<Script[]>; private _selectedScript: Script; private routeSub: Subscription; diff --git a/src/app/process-page/new/new-process.component.ts b/src/app/process-page/new/new-process.component.ts index 882d974a6c..f97ce1bc6b 100644 --- a/src/app/process-page/new/new-process.component.ts +++ b/src/app/process-page/new/new-process.component.ts @@ -18,13 +18,21 @@ import { Script } from '../scripts/script.model'; styleUrls: ['./new-process.component.scss'], }) export class NewProcessComponent implements OnInit { + /** + * Emits preselected process if there is one + */ fromExisting$?: Observable<Process>; + /** + * Emits preselected script if there is one + */ script$?: Observable<Script>; constructor(private route: ActivatedRoute, private processService: ProcessDataService, private linkService: LinkService) { - } + /** + * If there's an id parameter, use this the process with this identifier as presets for the form + */ ngOnInit() { const id = this.route.snapshot.queryParams.id; if (id) { @@ -37,4 +45,3 @@ export class NewProcessComponent implements OnInit { } } } - diff --git a/src/app/process-page/processes/process.model.ts b/src/app/process-page/processes/process.model.ts index cbf52701c9..85de5337e7 100644 --- a/src/app/process-page/processes/process.model.ts +++ b/src/app/process-page/processes/process.model.ts @@ -7,13 +7,10 @@ import { PROCESS } from './process.resource-type'; import { excludeFromEquals } from '../../core/utilities/equals.decorators'; import { ResourceType } from '../../core/shared/resource-type'; import { link, typedObject } from '../../core/cache/builders/build-decorators'; -import { COLLECTION } from '../../core/shared/collection.resource-type'; import { Observable } from 'rxjs/internal/Observable'; import { RemoteData } from '../../core/data/remote-data'; -import { Collection } from '../../core/shared/collection.model'; import { SCRIPT } from '../scripts/script.resource-type'; import { Script } from '../scripts/script.model'; -import { PaginatedList } from '../../core/data/paginated-list'; /** * Object representing a process diff --git a/src/app/shared/utils/route.utils.ts b/src/app/shared/utils/route.utils.ts index b949852b88..f43204930d 100644 --- a/src/app/shared/utils/route.utils.ts +++ b/src/app/shared/utils/route.utils.ts @@ -1,4 +1,4 @@ -import { ActivatedRoute, ActivatedRouteSnapshot, Router } from '@angular/router'; +import { ActivatedRouteSnapshot, Router } from '@angular/router'; import { hasValue } from '../empty.util'; import { URLCombiner } from '../../core/url-combiner/url-combiner'; diff --git a/src/test.ts b/src/test.ts index 3406bf7d5a..16317897b1 100644 --- a/src/test.ts +++ b/src/test.ts @@ -18,4 +18,3 @@ getTestBed().initTestEnvironment( const context = require.context('./', true, /\.spec\.ts$/); // And load the modules. context.keys().map(context); - -- GitLab