https://github.com/yantrab/class-validator-rule

tslint rule for class-validator
https://github.com/yantrab/class-validator-rule

class-validator tslint-rules typescript

Last synced: about 2 months ago
JSON representation

tslint rule for class-validator

• Host: GitHub
• URL: https://github.com/yantrab/class-validator-rule
• Owner: yantrab
• Created: 2019-03-07T05:14:03.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2019-12-26T11:24:48.000Z (over 4 years ago)
• Last Synced: 2024-07-23T21:56:21.813Z (2 months ago)
• Topics: class-validator, tslint-rules, typescript
• Language: TypeScript
• Homepage:
• Size: 19.5 KB
• Stars: 25
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# class-validator-rule

## Strongly typed validation

It is possible to do strongly typed validation with [class-validator](https://github.com/typestack/class-validator).

### Example

This class 

```typescript

enum Color { Red, Green, Blue }

class SomeObject {

    string?: string;

}

class Model {

    color: Color;

    string: string;

    number: number;

    boolean: boolean;

    date: Date;

    stringArray: string[];

    numberArray: number[];

    booleanArray: boolean[];

    dateArray: Date[];

    enumArray: Color[];

    object: SomeObject;

    objectArray: SomeObject[];

}

```

Should decorate like:

```typescript

enum Color { Red, Green, Blue }

class SomeObject {

    @IsOptional()

    @IsString()

    string?: string;

}

class Model {

    @IsEnum(Color)

    color: Color;

    @IsString()

    string: string;

    @IsNumber()

    number: number;

    @IsBoolean()

    boolean: boolean;

    @IsDate()

    date: Date;

    @IsString({ each: true })

    stringArray: string[];

    @IsNumber({},{ each: true })

    numberArray: number[];

    @IsBoolean({ each: true })

    booleanArray: boolean[];

    @IsDate({ each: true })

    dateArray: Date[];

    @IsEnum(Color,{ each: true })

    enumArray: Color[];

    @ValidateNested()

    object: SomeObject;

    @ValidateNested({ each: true })

    objectArray: SomeObject[];

}

```

This rule reminds you to add the correct decorator and can fix your models.

## Get started

### Install rule with dev flag:

```

npm i tslint-class-validator-rule -D

```

### tslint configuration

Add tslint configoration to root of your models folder

```json

{

    "rulesDirectory": ["tslint-class-validator-rule"],

    "rules": {

        "no-property-without-decorator":true

    }

}

```

Fix

```

tslint -p . --fix 

```

### Add middleware (nestjs)

```typescript

 app.useGlobalPipes(new ValidationPipe({ forbidUnknownValues: true }));

 ```

#### TODO

##### - Add imports

##### - file/folder name option, to support '**/*model.ts'