Awesome

eslint-plugin-authing-nestjs

<div align=center> <img width="300" src="https://files.authing.co/authing-console/authing-logo-new-20210924.svg" alt="authing"> </div> <div align="center"> <a href="https://badge.fury.io/js/eslint-plugin-authing-nestjs"> <img src="https://badge.fury.io/js/eslint-plugin-authing-nestjs.svg" alt="npm version" height="18" /> </a> <a href="https://github.com/Authing/eslint-plugin-authing-nestjs/actions/workflows/ci.yml" target="_blank"> <img src="https://github.com/Authing/eslint-plugin-authing-nestjs/actions/workflows/ci.yml/badge.svg?branch=master" alt="github ci" /> </a> <a href="https://github.com/Authing/eslint-plugin-authing-nestjs/actions/workflows/test.yml"> <img src="https://img.shields.io/badge/test-passing-brightgreen" alt="testing" /> </a> <a href="https://npmcharts.com/compare/eslint-plugin-authing-nestjs" target="_blank"> <img src="https://img.shields.io/npm/dm/eslint-plugin-authing-nestjs" alt="download" /> </a> <a href="https://github.com/Authing/eslint-plugin-authing-nestjs/pulls" target="_blank"> <img src="https://img.shields.io/badge/PRs-welcome-orange" alt="welcome pr" /> </a> <a href="https://opensource.org/licenses/MIT" target="_blank"> <img src="https://img.shields.io/badge/license-MIT-brightgreen" alt="license" /> </a> <a href="https://forum.authing.cn/" target="_blank"> <img src="https://img.shields.io/badge/chat-forum-blue" alt="forum" /> </a> <a href="https://nodejs.org/en/" target="_blank"> <img src="https://img.shields.io/badge/node-%3E=12-green.svg" alt="nodejs"> </a> </div> <br/> <div> <span>eslint-plugin-authing-nestjs is an MIT-licensed open source project for</span> <a target="_blank" href="https://github.com/nestjs/nest"> nestjs </a> <span>framework</span> </div> <br/>

Install

npm install --save-dev eslint-plugin-authing-nestjs

yarn add eslint-plugin-authing-nestjs -D

Usage

Configure it in your configuration file:

Add to plugins section:
Add to extends or rules section:

module.exports = {
  plugins: ['authing-nestjs'],
  extends: [
    'plugin:authing-nestjs/recommended'
  ],
  // *** Usage: refer to unit test documents for specific rules ***
  rules: {
    // It is forbidden to use parameters in the @Body, eg: @Body("name")
    'authing-nestjs/forbid_body_parameters': 'warn', // default 'error'

    // It is forbidden to read body from Req, eg: req.body
    'authing-nestjs/forbid_read_body_from_req': 'warn',

    // The @Body type annotation in the function must be a class, eg: @Body() dto: ClassDto
    'authing-nestjs/use_class_as_type_in_method_of_controller': 'warn',

    // Each DTO field must have a class validator
    // There must be at least 2 class validators for a DTO with IsOptional
    // For nested DTO，Type and ValidateNested must appear at the same time
    'authing-nestjs/use_class_validator_to_dto': 'warn',
    
    // ... more
  }
}

Configure rules

Changelog

Detailed changes for each release are documented in the release notes.

Contribution

Fork it
Create your feature branch (git checkout -b my-new-feature)
Commit your changes (git commit -am 'Add some feature')
Push to the branch (git push -u origin my-new-feature)
Create new Pull Request

Help

Join us on forum: #authing-chat

License

MIT