UNPKG

eslint-plugin-type-graphql

Version:

Linter for TypeGraphQL decorators

github.com/borremosch/eslint-plugin-type-graphql

borremosch/eslint-plugin-type-graphql

53 lines (38 loc) • 2.03 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
[![npm version](https://badge.fury.io/js/eslint-plugin-type-graphql.svg)](https://badge.fury.io/js/eslint-plugin-type-graphql) ![build](https://github.com/borremosch/eslint-plugin-type-graphql/workflows/Node.js%20CI/badge.svg) [![codecov](https://codecov.io/gh/borremosch/eslint-plugin-type-graphql/branch/main/graph/badge.svg)](https://codecov.io/gh/borremosch/eslint-plugin-type-graphql) [![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier) ![language](https://img.shields.io/github/languages/top/borremosch/eslint-plugin-type-graphql) # eslint-plugin-type-graphql TypeGraphQL linting rules for ESLint ## Installation Install prerequisites: ```bash npm i -D eslint @typescript-eslint/parser ``` Install eslint-plugin-type-graphql: ```bash npm i -D eslint-plugin-type-graphql ``` ## Recommended configuration Create an ESLint configuration and add the plugin rules like so: ```json { "plugins": ["type-graphql"], "extends": [ "plugin:@typescript-eslint/recommended", "plugin:@typescript-eslint/recommended-requiring-type-checking", "plugin:type-graphql/recommended" ], "parser": "@typescript-eslint/parser" } ``` ## Provided rules - [invalid-decorated-type](docs/rules/invalid-decorated-type.md): Find errors in types that are decorated - [invalid-decorator-type](docs/rules/invalid-decorator-type.md): Find errors in decorators - [invalid-nullable-input-type](docs/rules/invalid-nullable-input-type.md): Prevent errors on nullable input types - [invalid-nullable-output-type](docs/rules/invalid-nullable-output-type.md): Prevent errors on nullable output types - [missing-decorator-type](docs/rules/missing-decorator-type.md): Find missing type functions in decorators - [wrong-decorator-signature](docs/rules/wrong-decorator-signature.md): Find mismatches between decorators and decorated types ## License This plugin is licensed under the [Apache 2.0 license](https://opensource.org/licenses/Apache-2.0).