@vcita/eslint-config-nestjs

Node Package - eslint-config-nestjs

Overview

This package contains the eslint configuration for vCita's Node.js services implemented by NestJS framework. This package is to be maintained using the Package Maintainers guidelines.

Installation and usage

• Install the package as a dev dependency:

  npm install --save-dev @vcita/eslint-config-nestjs
  

• Install the package's peer dependencies, which can be seen by running the following command:

  npm info @vcita/eslint-config-nestjs peerDependencies
  

• Create a .eslintrc.js file in the root of your project with the following content:

  module.exports = {
      extends: [
          '@vcita/eslint-config-nestjs',
      ],
  };
  

  or add '@vcita/eslint-config-nestjs' to the 'extends' array in your existing .eslintrc.js file.

Included rules

The following ESLint rule sets are included:

• TypeScript ESLint recommended rule set: @typescript-eslint/recommended
• Airbnb base rule set: airbnb-base
• Airbnb TypeScript enhancement: airbnb-typescript/base
• Prettier rule set: prettier/recommended

Additional rules are included:

• Line length limitation rules
• Disabling of default export rule
• Rule disallowing the usage of Cron, Interval and Timeout method decorators