feat: rename the whitelisted property rule and add documentation

Renamed  "no-whitelisted-properties" to be "all-properties-are-whitelisted"

Author: darraghoriordan

README.md

@@ -28,6 +28,7 @@ Preventing bugs
 -   param-decorator-name-matches-route-param
 -   validate-nested-of-array-should-set-each
 -   validated-non-primitive-property-needs-type-decorator
+-   all-properties-are-whitelisted
 
 Security
 
@@ -114,6 +115,45 @@ Disable a single rule with the full name e.g. in your eslint configuration...
 
 ## Rule Details
 
+### Rule: all-properties-are-whitelisted
+
+You should forbid non-whitelisted properties in your DTOs.
+
+If you have a DTO that has one property with a class-validator decorator, it's very unlikely that the same DTO will have any properties without a decorator - i.e. ALL DTO properties should be validated or explicitly whitelisted with `@Allow()`.
+
+This rule will flag any properties that are not whitelisted as expected because it's probably a mistake.
+
+This PASSES - all properties are decorated
+
+```ts
+export class CreateOrganisationDto {
+    @ApiProperty({type: Person, isArray: true})
+    @ValidateNested({each: true})
+    members!: MyClass[];
+
+    @ApiProperty()
+    @Allow()
+    otherProperty!: MyClass;
+
+    @ApiProperty()
+    @IsString()
+    someStringProperty!: string;
+}
+```
+
+This FAILS - one property here is missing a validation decorator. This is likely a mistake.
+
+```ts
+export class CreateOrganisationDto {
+    @ApiProperty({type: Person, isArray: true})
+    @ValidateNested({each: true})
+    members!: MyClass[];
+
+    @ApiProperty()
+    otherProperty!: MyClass;
+}
+```
+
 ### Rule: validate-nested-of-array-should-set-each
 
 If you use the `@ValidateNested` decorator you should specify the `{each: true}` option if the property is an array.

src/configs/recommended.ts

@@ -27,5 +27,6 @@ export = {
             "error",
         "@darraghor/nestjs-typed/validate-nested-of-array-should-set-each":
             "error",
+        "@darraghor/nestjs-typed/all-properties-are-whitelisted": "error",
     },
 };

src/rules/noWhitelistedProperties/noWhitelistedProperties.spec.ts renamed to src/rules/allPropertiesAreWhitelisted/allPropertiesAreWhitelisted.spec.ts

@@ -1,11 +1,11 @@
 import {RuleTester} from "@typescript-eslint/experimental-utils/dist/eslint-utils";
-import rule from "./noWhitelistedProperties";
+import rule from "./allPropertiesAreWhitelisted";
 
 const ruleTester = new RuleTester({
     parser: "@typescript-eslint/parser",
 });
 
-ruleTester.run("no-whitelisted-properties", rule, {
+ruleTester.run("all-properties-are-whitelisted", rule, {
     valid: [
         {
             code: `

src/rules/noWhitelistedProperties/noWhitelistedProperties.ts renamed to src/rules/allPropertiesAreWhitelisted/allPropertiesAreWhitelisted.ts

@@ -8,16 +8,16 @@ const CLASS_VALIDATOR_DECORATOR_NAMES = new Set(
 );
 
 const rule = createRule({
-    name: "no-whitelisted-properties",
+    name: "all-properties-are-whitelisted",
     meta: {
         docs: {
-            description: "Enforce no properties are whitelisted",
+            description: "Enforce all properties are whitelisted",
             recommended: "error",
             requiresTypeChecking: false,
         },
         messages: {
             "missing-property-decorator":
-                "Property has no class-validator decorator (use @Allow so it would not be whitelisted)",
+                "Property has no class-validator decorator (use @Allow() if you don't need a validation)",
         },
         type: "problem",
         schema: {},

src/rules/index.ts

@@ -9,7 +9,7 @@ import shouldSpecifyForbidUnknownValues from "./shouldSpecifyForbidUnknownValues
 import parameterDecoratorNameMatchesRouteParam from "./paramDecoratorNameMatchesRouteParam/paramDecoratorNameMatchesRouteParam";
 import validateNonPrimitiveNeedsDecorators from "./validate-non-primitves-needs-type-decorator/validateNonPrimitiveNeedsDecorators";
 import validateNestedOfArrayShouldSetEach from "./validateNestedOfArrayShouldSetEach/validateNestedOfArrayShouldSetEach";
-import noWhitelistedProperties from "./noWhitelistedProperties/noWhitelistedProperties";
+import allPropertiesAreWhitelisted from "./allPropertiesAreWhitelisted/allPropertiesAreWhitelisted";
 
 const allRules = {
     "api-property-matches-property-optionality":
@@ -30,7 +30,7 @@ const allRules = {
         validateNonPrimitiveNeedsDecorators,
     "validate-nested-of-array-should-set-each":
         validateNestedOfArrayShouldSetEach,
-    "no-whitelisted-properties": noWhitelistedProperties,
+    "all-properties-are-whitelisted": allPropertiesAreWhitelisted,
 };
 
 export default allRules;