feat: add jsdoc lint

.eslintrc.js

@@ -11,6 +11,7 @@ module.exports = {
   ],
   extends: [
     '@concepta/eslint-config/nest',
+    'plugin:jsdoc/recommended-typescript',
   ],
   ignorePatterns: [
     'packages/*/dist/**',
@@ -30,7 +31,8 @@ module.exports = {
   rules: {
     'import/no-extraneous-dependencies': 'error',
     '@darraghor/nestjs-typed/param-decorator-name-matches-route-param': 'off',
-    'tsdoc/syntax': 'warn',
+    'jsdoc/tag-lines': ['error', 'any', { startLines: 1 }],
+    'tsdoc/syntax': 'error',
   },
   overrides: [
     {
@@ -40,11 +42,21 @@ module.exports = {
         jsonSyntax: 'JSON',
       },
     },
+    {
+      files: ['*.ts'],
+      rules: {
+        'jsdoc/require-jsdoc': 'off',
+        'jsdoc/require-param': 'off',
+        'jsdoc/require-returns': 'off',
+      },
+    },
     {
       files: ['*.spec.ts', '*.fixture.ts'],
       rules: {
         '@darraghor/nestjs-typed/controllers-should-supply-api-tags': 'off',
         '@darraghor/nestjs-typed/api-method-should-specify-api-response': 'off',
+        'plugin:jsdoc/recommended-typescript': 'off',
+        'jsdoc/tag-lines': 'off',
         'tsdoc/syntax': 'off',
       },
     },

package.json

@@ -29,6 +29,7 @@
     "eslint": "^8.6.0",
     "eslint-config-prettier": "^8.3.0",
     "eslint-plugin-import": "^2.25.4",
+    "eslint-plugin-jsdoc": "^48.5.0",
     "eslint-plugin-node": "^11.1.0",
     "eslint-plugin-prettier": "^4.0.0",
     "eslint-plugin-tsdoc": "^0.3.0",

packages/nestjs-access-control/src/decorators/access-control-create-many.decorator.ts

@@ -3,7 +3,7 @@ import { AccessControlCreateOne } from './access-control-create-one.decorator';
 /**
  * Create many resource grant shortcut.
  *
- * @param string - resource The grant resource.
+ * @param resource - The grant resource.
  */
 export const AccessControlCreateMany = (resource: string) =>
   AccessControlCreateOne(resource);

packages/nestjs-access-control/src/decorators/access-control-create-one.decorator.ts

@@ -5,7 +5,7 @@ import { applyDecorators } from '@nestjs/common';
 /**
  * Create one resource grant shortcut.
  *
- * @param string - resource The grant resource.
+ * @param resource - The grant resource.
  * @returns Decorator function
  */
 export const AccessControlCreateOne = (

packages/nestjs-access-control/src/decorators/access-control-delete-one.decorator.ts

@@ -3,9 +3,9 @@ import { applyDecorators } from '@nestjs/common';
 import { ActionEnum } from '../enums/action.enum';
 
 /**
- * Delete one resource grant shortcut
+ * Delete one resource grant shortcut.
  *
- * @param string - resource The grant resource.
+ * @param resource - The grant resource.
  * @returns Decorator function
  */
 export const AccessControlDeleteOne = (

packages/nestjs-access-control/src/decorators/access-control-read-many.decorator.ts

@@ -5,7 +5,7 @@ import { AccessControlGrant } from './access-control-grant.decorator';
 /**
  * Read many resource grant shortcut.
  *
- * @param string - resource The grant resource.
+ * @param resource - The grant resource.
  * @returns Decorator function
  */
 export const AccessControlReadMany = (

packages/nestjs-access-control/src/decorators/access-control-read-one.decorator.ts

@@ -5,7 +5,7 @@ import { AccessControlGrant } from './access-control-grant.decorator';
 /**
  * Read one resource grant shortcut
  *
- * @param string - resource The grant resource.
+ * @param resource - The grant resource.
  * @returns Decorator function
  */
 export const AccessControlReadOne = (

packages/nestjs-access-control/src/decorators/access-control-recover-one.decorator.ts

@@ -3,7 +3,7 @@ import { AccessControlCreateOne } from './access-control-create-one.decorator';
 /**
  * Recover one resource grant shortcut.
  *
- * @param string - resource The grant resource.
+ * @param resource - The grant resource.
  */
 export const AccessControlRecoverOne = (resource: string) =>
   AccessControlCreateOne(resource);

packages/nestjs-access-control/src/decorators/access-control-replace-one.decorator.ts

@@ -1,9 +1,9 @@
 import { AccessControlUpdateOne } from './access-control-update-one.decorator';
 
 /**
- * Update one resource grant shortcut
+ * Update one resource grant shortcut.
  *
- * @param string - resource The grant resource.
+ * @param resource - The grant resource.
  */
 export const AccessControlReplaceOne = (resource: string) =>
   AccessControlUpdateOne(resource);

packages/nestjs-access-control/src/decorators/access-control-update-one.decorator.ts

@@ -3,9 +3,9 @@ import { ActionEnum } from '../enums/action.enum';
 import { AccessControlGrant } from './access-control-grant.decorator';
 
 /**
- * Update one resource grant shortcut
+ * Update one resource grant shortcut.
  *
- * @param string - resource The grant resource.
+ * @param resource - The grant resource.
  * @returns Decorator function
  */
 export const AccessControlUpdateOne = (

packages/nestjs-auth-local/src/auth-local.strategy.ts

@@ -30,10 +30,8 @@ export class AuthLocalStrategy extends PassportStrategyFactory<Strategy>(
   AUTH_LOCAL_STRATEGY_NAME,
 ) {
   /**
-   *
-   * @param userLookupService - The service used to get the user
    * @param settings - The settings for the local strategy
-   * @param passwordStorageService - The service used to hash and validate passwords
+   * @param validateUserService - The service used validate passwords
    */
   constructor(
     @Inject(AUTH_LOCAL_MODULE_SETTINGS_TOKEN)

packages/nestjs-authentication/src/services/issue-token.service.ts

@@ -26,7 +26,7 @@ export class IssueTokenService implements IssueTokenServiceInterface {
   /**
    * Generate the response payload.
    *
-   * @param identifier - user id or name for `sub` claim
+   * @param id - user id or name for `sub` claim
    */
   async responsePayload(
     id: ReferenceId,

packages/nestjs-cache/src/controllers/cache-crud.controller.ts

@@ -70,7 +70,9 @@ export class CacheCrudController
   /**
    * Constructor.
    *
+   * @param settings - cache settings
    * @param allCrudServices - instances of all crud services
+   * @param cacheService - instance of cache service
    */
   constructor(
     @Inject(CACHE_MODULE_SETTINGS_TOKEN)

packages/nestjs-crud/src/__fixtures__/photo/photo.controller.fixture.ts

@@ -42,14 +42,12 @@ export class PhotoControllerFixture
 {
   /**
    * Constructor.
-   *
    * @param photoService instance of the photo crud service
    */
   constructor(private photoService: PhotoServiceFixture) {}
 
   /**
    * Get many
-   *
    * @param crudRequest the CRUD request object
    */
   @CrudReadAll()
@@ -59,7 +57,6 @@ export class PhotoControllerFixture
 
   /**
    * Get one
-   *
    * @param crudRequest the CRUD request object
    */
   @CrudReadOne()
@@ -69,7 +66,6 @@ export class PhotoControllerFixture
 
   /**
    * Create many
-   *
    * @param crudRequest the CRUD request object
    * @param photoCreateManyDto photo create many dto
    */
@@ -83,7 +79,6 @@ export class PhotoControllerFixture
 
   /**
    * Create one
-   *
    * @param crudRequest the CRUD request object
    * @param photoCreateDto photo create dto
    */
@@ -97,7 +92,6 @@ export class PhotoControllerFixture
 
   /**
    * Update one
-   *
    * @param crudRequest the CRUD request object
    * @param photoUpdateDto photo update dto
    */
@@ -111,7 +105,6 @@ export class PhotoControllerFixture
 
   /**
    * Replace one
-   *
    * @param crudRequest the CRUD request object
    */
   @CrudReplaceOne()
@@ -124,7 +117,6 @@ export class PhotoControllerFixture
 
   /**
    * Delete one
-   *
    * @param crudRequest the CRUD request object
    */
   @CrudDeleteOne()
@@ -134,7 +126,6 @@ export class PhotoControllerFixture
 
   /**
    * Delete one (soft)
-   *
    * @param crudRequest the CRUD request object
    */
   @CrudDeleteOne({ path: 'soft/:id' })
@@ -145,7 +136,6 @@ export class PhotoControllerFixture
 
   /**
    * Recover one
-   *
    * @param crudRequest the CRUD request object
    */
   @CrudRecoverOne()

packages/nestjs-event/src/services/event-dispatch.service.ts

@@ -41,14 +41,14 @@ export class EventDispatchService {
    *
    * @Injectable()
    * class MyClass {
-   *   constructor(private eventDispatchService: EventDispatchService) {}
+   * constructor(private eventDispatchService: EventDispatchService) {}
    *
-   *   didSomething() {
-   *     // event instance
-   *     const myEvent = new MyEvent({id: 1234});
-   *     // dispatch the event
-   *     this.eventDispatchService.sync(myEvent);
-   *   }
+   * didSomething() {
+   * // event instance
+   * const myEvent = new MyEvent({id: 1234});
+   * // dispatch the event
+   * this.eventDispatchService.sync(myEvent);
+   * }
    * }
    * ```
    *
@@ -82,25 +82,25 @@ export class EventDispatchService {
    *
    * @Injectable()
    * class MyClass {
-   *   constructor(private eventDispatchService: EventDispatchService) {}
+   * constructor(private eventDispatchService: EventDispatchService) {}
    *
-   *   // allow any listener to activate object
-   *   async maybeActivate(myPayloadType: MyPayloadType): MyPayloadType {
-   *     // event instance
-   *     const myEvent = new MyEvent({...myPayloadType, active: false});
-   *     // dispatch the event
-   *     const allPayloads: MyPayloadType[] =
-   *       await this.eventDispatchService.async(myEvent);
-   *     // merge it
-   *     allPayloads.forEach((payload) => {
-   *       // did any listener set it to true?
-   *       if (payload.active) {
-   *         myPayloadType.active = true;
-   *       }
-   *     });
-   *     // return possibly modified object
-   *     return myPayloadType;
-   *   }
+   * // allow any listener to activate object
+   * async maybeActivate(myPayloadType: MyPayloadType): MyPayloadType {
+   * // event instance
+   * const myEvent = new MyEvent({...myPayloadType, active: false});
+   * // dispatch the event
+   * const allPayloads: MyPayloadType[] =
+   * await this.eventDispatchService.async(myEvent);
+   * // merge it
+   * allPayloads.forEach((payload) => {
+   * // did any listener set it to true?
+   * if (payload.active) {
+   * myPayloadType.active = true;
+   * }
+   * });
+   * // return possibly modified object
+   * return myPayloadType;
+   * }
    * }
    * ```
    *

packages/nestjs-event/src/services/event-listen.service.ts

@@ -41,21 +41,21 @@ export class EventListenService {
    * import { TargetEvent } from 'target-module';
    *
    * class MyListener extends EventListenerOn<TargetEvent> {
-   *   listen(event: TargetEvent) {
-   *     console.log(event.payload);
-   *   }
+   * listen(event: TargetEvent) {
+   * console.log(event.payload);
+   * }
    * }
    *
    * @Injectable()
    * class MyClass implements OnModuleInit {
-   *   constructor(private eventListenService: EventListenService) {}
+   * constructor(private eventListenService: EventListenService) {}
    *
-   *   onModuleInit() {
-   *     // listener instance
-   *     const listener = new MyListener();
-   *     // register the listener
-   *     this.eventListenService.on(TargetEvent, listener);
-   *   }
+   * onModuleInit() {
+   * // listener instance
+   * const listener = new MyListener();
+   * // register the listener
+   * this.eventListenService.on(TargetEvent, listener);
+   * }
    * }
    * ```
    *

packages/nestjs-logger/src/logger-request.interceptor.ts

@@ -82,7 +82,6 @@ export class LoggerRequestInterceptor implements NestInterceptor<Response> {
    * @param res - Response
    * @param startDate - Start date
    * @param error - Error instance
-   * @returns
    */
   responseError(req: Request, res: Response, startDate: Date, error: Error) {
     // format the message

packages/nestjs-logger/src/utils/message-format.util.ts

@@ -13,7 +13,6 @@ export class MessageFormatUtil {
    * Function to format message from request.
    *
    * @param req - request
-   * @returns
    */
   static formatRequestMessage(req: Request): string {
     const { method, url } = req;
@@ -29,7 +28,6 @@ export class MessageFormatUtil {
    * @param res - response
    * @param startDate - start date
    * @param error - error
-   * @returns
    */
   static formatResponseMessage(
     req: Request,

packages/nestjs-password/src/services/password-creation.service.ts

@@ -113,6 +113,7 @@ export class PasswordCreationService
   /**
    * Check if number of current attempt is allowed based on the amount of attempts left
    * if the number of attempts left is greater then
+   *
    * @returns Number of attempts user has to try
    */
   checkAttempt(numOfAttempts = 0): boolean {
@@ -121,8 +122,8 @@ export class PasswordCreationService
 
   /**
    * Check number of attempts of using password
+   *
    * @param numOfAttempts - number of attempts
-   * @returns
    */
   checkAttemptLeft(numOfAttempts = 0): number {
     // Get number of max attempts allowed