Merge branch 'tslint' into 'dev'

chore: lint jsdoc rules

See merge request !586

.eslintrc.json

 {
   "root": true,
   "ignorePatterns": ["projects/**/*"],
+  "plugins": ["jsdoc"],
   "overrides": [
     {
       "files": ["*.ts"],
@@ -9,6 +10,7 @@
         "createDefaultProgram": true
       },
       "extends": [
+        "plugin:jsdoc/recommended",
         "plugin:storybook/recommended",
         "plugin:@angular-eslint/recommended",
         "plugin:@angular-eslint/template/process-inline-templates"
@@ -32,7 +34,19 @@
         ],
         "spaced-comment": ["error", "always", { "block": { "exceptions": ["*"] } }],
 
-        "@typescript-eslint/prefer-optional-chain": "warn"
+        "@typescript-eslint/prefer-optional-chain": "warn",
+
+        // JSDOC extends overrides: disable some of extends rules
+        // JSdoc is not always needed
+        "jsdoc/require-jsdoc": 0,
+        // Prefer declaring types with typescript
+        "jsdoc/require-returns": 0,
+        "jsdoc/require-returns-type": 0,
+        "jsdoc/require-param": 0,
+        "jsdoc/require-param-type": 0,
+
+        // Allow some params to be described and some to be omitted
+        "jsdoc/check-param-names": 0
       }
     },
     {

package.json

@@ -76,6 +76,7 @@
     "@typescript-eslint/parser": "^5.43.0",
     "codelyzer": "^6.0.2",
     "eslint": "^8.28.0",
+    "eslint-plugin-jsdoc": "^46.8.1",
     "eslint-plugin-storybook": "^0.6.13",
     "http-server": "^14.1.0",
     "jasmine-core": "~4.5.0",

src/app/form/orientation-form-view/orientation-form-view.component.ts

@@ -606,7 +606,6 @@ export class OrientationFormViewComponent implements OnInit, AfterContentChecked
 
   /**
    * Return if it's a filter form
-   * @returns
    */
   private isFilterForm(): boolean {
     return (
@@ -628,6 +627,7 @@ export class OrientationFormViewComponent implements OnInit, AfterContentChecked
     this.showConfirmationModal = true;
     this.resolve = resolve;
   }
+
   public hasRedirectionAccepted(hasAccept: boolean): void {
     this.resolve(hasAccept);
     if (hasAccept) {

src/app/models/structure.model.ts

@@ -116,7 +116,7 @@ export class Structure {
 
   /**
    * Verify that a structure as not only equipments with 0 as value. This is mostly use for display.
-   * @returns {Boolean} validation
+   * @returns {boolean} validation
    */
   public hasNotOnlyEmptyEquipments(): boolean {
     if (this.nbComputers + this.nbPrinters + this.nbScanners > 0) return true;

src/app/models/week.model.ts

@@ -29,6 +29,7 @@ export class Week {
    * for (let day of structure.hours)...
    * -> day.key = tuesday
    * -> day.value = {open: true, time: [...]}
+   * @yields day of the week
    */
   *[Symbol.iterator](): Generator<{ key: dayType; value: Day }> {
     yield { key: 'monday', value: this.monday };

src/app/structure-list/services/search.service.ts

@@ -18,7 +18,6 @@ export class SearchService {
 
   /**
    * Return repository data for search
-   * @returns {Category[]}
    */
   public getCategories(): Observable<Category[]> {
     return this.http.get('/api/categories').pipe(map((data: any[]) => data.map((item) => new Category(item))));

src/app/utils/formUtils.ts

@@ -64,9 +64,7 @@ export class formUtils {
   ];
 
   /**
-   * @param structure
    * @param isEditMode in edit mode, some validations are not required
-   * @returns
    */
   public createStructureForm(structure: Structure, isEditMode?: boolean): UntypedFormGroup {
     return new UntypedFormGroup(

src/app/utils/orientationUtils.ts

@@ -120,14 +120,7 @@ export class OrientationUtils {
       phone: new UntypedFormControl('', [Validators.required, Validators.pattern(CustomRegExp.PHONE)]),
     });
   }
-  /**
-   *
-   * @param pagesValidation
-   * @param filterForm
-   * @param form
-   * @param updatePageValid
-   * @param step
-   */
+
   public setValidationsLearnSkillsForm(
     pagesValidation: any[],
     filterForm: FormGroup<FiltersForm>,
@@ -143,13 +136,6 @@ export class OrientationUtils {
     };
     updatePageValid(pagesValidation[step].valid);
   }
-  /**
-   *
-   * @param pagesValidation
-   * @param form
-   * @param updatePageValid
-   * @param step
-   */
   public setValidationsOnlineDemarchesForm(
     pagesValidation: any[],
     form: UntypedFormGroup,
@@ -165,13 +151,6 @@ export class OrientationUtils {
     updatePageValid(pagesValidation[step].valid);
   }
 
-  /**
-   *
-   * @param pagesValidation
-   * @param form
-   * @param updatePageValid
-   * @param step
-   */
   public setValidationsOnlineMediationForm(
     pagesValidation: any[],
     form: UntypedFormGroup,
@@ -196,13 +175,6 @@ export class OrientationUtils {
     updatePageValid(pagesValidation[step].valid);
   }
 
-  /**
-   *
-   * @param pagesValidation
-   * @param form
-   * @param updatePageValid
-   * @param step
-   */
   public setValidationsStructuresForm(
     pagesValidation: any[],
     form: FormGroup<StructureOrientationForm>,
@@ -227,13 +199,6 @@ export class OrientationUtils {
     updatePageValid(pagesValidation[step].valid);
   }
 
-  /**
-   *
-   * @param pagesValidation
-   * @param form
-   * @param updatePageValid
-   * @param step
-   */
   public setValidationsAppointmentForm(
     pagesValidation: any[],
     form: FormGroup<AppointmentForm>,
@@ -269,13 +234,6 @@ export class OrientationUtils {
     updatePageValid(pagesValidation[step].valid);
   }
 
-  /**
-   *
-   * @param pagesValidation
-   * @param form
-   * @param updatePageValid
-   * @param step
-   */
   public setValidationsEquipmentForm(
     pagesValidation: any[],
     form: FormGroup<FiltersForm>,
@@ -288,11 +246,6 @@ export class OrientationUtils {
     updatePageValid(pagesValidation[step].valid);
   }
 
-  /**
-   *
-   * @param filters
-   * @param event
-   */
   public manuallySetOfPmr(filters: Filter[], event: { name: string; value: boolean }): void {
     // Handle special PMR access case
     if (event.name === 'pmrAccess') {

src/stories/button.component.ts

@@ -35,7 +35,6 @@ export default class ButtonComponent {
 
   /**
    * Button contents
-   *
    * @required
    */
   @Input()