{"id":13660562,"url":"https://github.com/yantrab/class-validator-rule","last_synced_at":"2025-04-24T19:31:16.053Z","repository":{"id":41081520,"uuid":"174276233","full_name":"yantrab/class-validator-rule","owner":"yantrab","description":"tslint rule for class-validator","archived":false,"fork":false,"pushed_at":"2019-12-26T11:24:48.000Z","size":20,"stargazers_count":26,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-03-18T15:26:46.465Z","etag":null,"topics":["class-validator","tslint-rules","typescript"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/yantrab.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-03-07T05:14:03.000Z","updated_at":"2024-11-02T00:49:03.000Z","dependencies_parsed_at":"2022-08-30T23:40:10.329Z","dependency_job_id":null,"html_url":"https://github.com/yantrab/class-validator-rule","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yantrab%2Fclass-validator-rule","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yantrab%2Fclass-validator-rule/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yantrab%2Fclass-validator-rule/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yantrab%2Fclass-validator-rule/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/yantrab","download_url":"https://codeload.github.com/yantrab/class-validator-rule/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250141426,"owners_count":21381599,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["class-validator","tslint-rules","typescript"],"created_at":"2024-08-02T05:01:23.008Z","updated_at":"2025-04-24T19:31:12.891Z","avatar_url":"https://github.com/yantrab.png","language":"TypeScript","readme":"# class-validator-rule\n## Strongly typed validation\nIt is possible to do strongly typed validation with [class-validator](https://github.com/typestack/class-validator).\n\n### Example\nThis class \n```typescript\nenum Color { Red, Green, Blue }\nclass SomeObject {\n    string?: string;\n}\nclass Model {\n    color: Color;\n    string: string;\n    number: number;\n    boolean: boolean;\n    date: Date;\n\n    stringArray: string[];\n    numberArray: number[];\n    booleanArray: boolean[];\n    dateArray: Date[];\n    enumArray: Color[];\n\n    object: SomeObject;\n    objectArray: SomeObject[];\n}\n```\nShould decorate like:\n```typescript\nenum Color { Red, Green, Blue }\nclass SomeObject {\n    @IsOptional()\n    @IsString()\n    string?: string;\n}\nclass Model {\n    @IsEnum(Color)\n    color: Color;\n    @IsString()\n    string: string;\n    @IsNumber()\n    number: number;\n    @IsBoolean()\n    boolean: boolean;\n    @IsDate()\n    date: Date;\n\n    @IsString({ each: true })\n    stringArray: string[];\n    @IsNumber({},{ each: true })\n    numberArray: number[];\n    @IsBoolean({ each: true })\n    booleanArray: boolean[];\n    @IsDate({ each: true })\n    dateArray: Date[];\n    @IsEnum(Color,{ each: true })\n    enumArray: Color[];\n\n    @ValidateNested()\n    object: SomeObject;\n    @ValidateNested({ each: true })\n    objectArray: SomeObject[];\n}\n```\nThis rule reminds you to add the correct decorator and can fix your models.\n\n## Get started\n### Install rule with dev flag:\n```\nnpm i tslint-class-validator-rule -D\n```\n\n### tslint configuration\nAdd tslint configoration to root of your models folder\n```json\n{\n    \"rulesDirectory\": [\"tslint-class-validator-rule\"],\n    \"rules\": {\n        \"no-property-without-decorator\":true\n    }\n}\n```\nFix\n```\ntslint -p . --fix \n```\n\n### Add middleware (nestjs)\n```typescript\n app.useGlobalPipes(new ValidationPipe({ forbidUnknownValues: true }));\n ```\n#### TODO\n##### - Add imports\n##### - file/folder name option, to support '**/*model.ts'\n\n","funding_links":[],"categories":["TypeScript"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyantrab%2Fclass-validator-rule","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fyantrab%2Fclass-validator-rule","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyantrab%2Fclass-validator-rule/lists"}