https://github.com/unlight/eslint-plugin-nestjs

POC. ESLint rules for nestjs framework
https://github.com/unlight/eslint-plugin-nestjs

eslint-plugin nestjs

Last synced: 6 days ago
JSON representation

POC. ESLint rules for nestjs framework

• Host: GitHub
• URL: https://github.com/unlight/eslint-plugin-nestjs
• Owner: unlight
• License: mit
• Created: 2017-12-28T23:32:34.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2021-12-09T19:14:56.000Z (almost 3 years ago)
• Last Synced: 2024-09-18T10:45:50.125Z (about 2 months ago)
• Topics: eslint-plugin, nestjs
• Language: TypeScript
• Homepage:
• Size: 28.3 KB
• Stars: 39
• Watchers: 2
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-nestjs - Eslint Plugin Nestjs - 用于 nestjs 框架的 ESLint 规则 (资源 / 组件和库)

README

        
# eslint-plugin-nestjs

ESLint rules for [nestjs](https://github.com/nestjs/nest) framework.

This project is POC and is not under development. But it will be, if I will get nestjs project on my job.

## INSTALL

```

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

```

## USAGE

Configure it in [your configuration file](https://eslint.org/docs/user-guide/configuring):  

1. Add to `plugins` section:

```

nestjs

```

2. Add to `extends` section (optional):

```

plugin:nestjs/recommended

```

3. [Configure rules](https://eslint.org/docs/user-guide/configuring#configuring-rules)

## RULES

* [nestjs/parse-int-pipe](src/parse-int-pipe/parse-int-pipe.md) — Usage of transform pipe `ParseIntPipe` for `@Param()` decorator

* [nestjs/deprecated-api-modules](src/deprecated-api-modules/deprecated-api-modules.md) — Usage of the deprecated api (import modules)

* [nestjs/use-dependency-injection](src/use-dependency-injection/use-dependency-injection.md) — Dependencies must be provided through a class constructor

* [nestjs/use-validation-pipe](src/use-validation-pipe/use-validation-pipe.md) — Usage of `ValidationPipe` for `@Body` decorated parameters

## SIMILAR PROJECTS

- https://github.com/darraghoriordan/eslint-plugin-nestjs-typed

## TODO

* rule: inject @Res() but not using send or json

* rule: if class decorated it must be exported

* cqrs: commands which only trigger 1 command handler (for write), but events can multiple

* cqrs: command should return void

## USEFUL LINKS

* https://astexplorer.net/

## CHANGELOG

See [CHANGELOG.md](CHANGELOG.md)