@darraghor/eslint-plugin-nestjs-typed 6.13.0 → 6.14.0

package/dist/rules/apiPropertyMatchesPropertyOptionality/apiPropertyMatchesPropertyOptionality.d.ts

@@ -1,5 +1,11 @@
 import { TSESTree } from "@typescript-eslint/utils";
 export declare const shouldUseRequiredDecorator: (node: TSESTree.PropertyDefinition) => boolean;
 export declare const shouldUseOptionalDecorator: (node: TSESTree.PropertyDefinition) => boolean;
-declare const rule: import("@typescript-eslint/utils/ts-eslint").RuleModule<"shouldUseOptionalDecorator" | "shouldUseRequiredDecorator", [], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
+export declare const hasRedundantRequired: (node: TSESTree.PropertyDefinition) => boolean;
+type Options = [
+    {
+        checkRedundantRequired?: boolean;
+    }
+];
+declare const rule: import("@typescript-eslint/utils/ts-eslint").RuleModule<"shouldUseOptionalDecorator" | "shouldUseRequiredDecorator" | "redundantRequired", Options, unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
 export default rule;

package/dist/rules/apiPropertyMatchesPropertyOptionality/apiPropertyMatchesPropertyOptionality.js

@@ -1,3 +1,4 @@
+import { TSESTree } from "@typescript-eslint/utils";
 import { createRule } from "../../utils/createRule.js";
 import { typedTokenHelpers } from "../../utils/typedTokenHelpers.js";
 export const shouldUseRequiredDecorator = (node) => {
@@ -10,6 +11,24 @@ export const shouldUseOptionalDecorator = (node) => {
     const isOptionalPropertyValue = typedTokenHelpers.isOptionalPropertyValue(node);
     return hasRequiredDecorator && isOptionalPropertyValue;
 };
+export const hasRedundantRequired = (node) => {
+    const apiPropertyDecorators = typedTokenHelpers.getDecoratorsNamed(node, [
+        "ApiProperty",
+    ]);
+    for (const decorator of apiPropertyDecorators) {
+        if (decorator.expression.type === TSESTree.AST_NODE_TYPES.CallExpression) {
+            const firstArgument = decorator.expression.arguments[0];
+            if (firstArgument &&
+                firstArgument.type === TSESTree.AST_NODE_TYPES.ObjectExpression) {
+                const hasRequiredTrue = typedTokenHelpers.getPropertyValueEqualsExpected(firstArgument, "required", true);
+                if (hasRequiredTrue) {
+                    return true;
+                }
+            }
+        }
+    }
+    return false;
+};
 const rule = createRule({
     name: "api-property-matches-property-optionality",
     meta: {
@@ -19,13 +38,31 @@ const rule = createRule({
         messages: {
             shouldUseOptionalDecorator: `Property marked as optional should use @ApiPropertyOptional decorator`,
             shouldUseRequiredDecorator: `Property marked as required should use @ApiProperty decorator`,
+            redundantRequired: `Redundant 'required: true' in @ApiProperty. Properties are required by default.`,
         },
-        schema: [],
+        schema: [
+            {
+                type: "object",
+                additionalProperties: false,
+                properties: {
+                    checkRedundantRequired: {
+                        description: "Check for redundant 'required: true' in @ApiProperty (default: true)",
+                        type: "boolean",
+                    },
+                },
+            },
+        ],
         hasSuggestions: false,
         type: "suggestion",
     },
-    defaultOptions: [],
+    defaultOptions: [
+        {
+            checkRedundantRequired: true,
+        },
+    ],
     create(context) {
+        const options = context.options[0] || {};
+        const shouldCheckRedundantRequired = options.checkRedundantRequired ?? true;
         return {
             PropertyDefinition(node) {
                 if (shouldUseOptionalDecorator(node)) {
@@ -40,9 +77,16 @@ const rule = createRule({
                         messageId: "shouldUseRequiredDecorator",
                     });
                 }
+                if (shouldCheckRedundantRequired &&
+                    hasRedundantRequired(node)) {
+                    context.report({
+                        node: node,
+                        messageId: "redundantRequired",
+                    });
+                }
             },
         };
     },
 });
 export default rule;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYXBpUHJvcGVydHlNYXRjaGVzUHJvcGVydHlPcHRpb25hbGl0eS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uL3NyYy9ydWxlcy9hcGlQcm9wZXJ0eU1hdGNoZXNQcm9wZXJ0eU9wdGlvbmFsaXR5L2FwaVByb3BlcnR5TWF0Y2hlc1Byb3BlcnR5T3B0aW9uYWxpdHkudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQ0EsT0FBTyxFQUFDLFVBQVUsRUFBQyxNQUFNLDJCQUEyQixDQUFDO0FBQ3JELE9BQU8sRUFBQyxpQkFBaUIsRUFBQyxNQUFNLGtDQUFrQyxDQUFDO0FBRW5FLE1BQU0sQ0FBQyxNQUFNLDBCQUEwQixHQUFHLENBQ3RDLElBQWlDLEVBQzFCLEVBQUU7SUFDVCxNQUFNLG9CQUFvQixHQUFHLGlCQUFpQixDQUFDLHNCQUFzQixDQUNqRSxJQUFJLEVBQ0osQ0FBQyxxQkFBcUIsQ0FBQyxDQUMxQixDQUFDO0lBRUYsTUFBTSx1QkFBdUIsR0FDekIsaUJBQWlCLENBQUMsdUJBQXVCLENBQUMsSUFBSSxDQUFDLENBQUM7SUFFcEQsT0FBTyxvQkFBb0IsSUFBSSxDQUFDLHVCQUF1QixDQUFDO0FBQzVELENBQUMsQ0FBQztBQUVGLE1BQU0sQ0FBQyxNQUFNLDBCQUEwQixHQUFHLENBQ3RDLElBQWlDLEVBQzFCLEVBQUU7SUFDVCxNQUFNLG9CQUFvQixHQUFHLGlCQUFpQixDQUFDLHNCQUFzQixDQUNqRSxJQUFJLEVBQ0osQ0FBQyxhQUFhLENBQUMsQ0FDbEIsQ0FBQztJQUVGLE1BQU0sdUJBQXVCLEdBQ3pCLGlCQUFpQixDQUFDLHVCQUF1QixDQUFDLElBQUksQ0FBQyxDQUFDO0lBRXBELE9BQU8sb0JBQW9CLElBQUksdUJBQXVCLENBQUM7QUFDM0QsQ0FBQyxDQUFDO0FBRUYsTUFBTSxJQUFJLEdBQUcsVUFBVSxDQUdyQjtJQUNFLElBQUksRUFBRSwyQ0FBMkM7SUFDakQsSUFBSSxFQUFFO1FBQ0YsSUFBSSxFQUFFO1lBQ0YsV0FBVyxFQUNQLHdEQUF3RDtTQUMvRDtRQUNELFFBQVEsRUFBRTtZQUNOLDBCQUEwQixFQUFFLHVFQUF1RTtZQUNuRywwQkFBMEIsRUFBRSwrREFBK0Q7U0FDOUY7UUFDRCxNQUFNLEVBQUUsRUFBRTtRQUNWLGNBQWMsRUFBRSxLQUFLO1FBQ3JCLElBQUksRUFBRSxZQUFZO0tBQ3JCO0lBQ0QsY0FBYyxFQUFFLEVBQUU7SUFFbEIsTUFBTSxDQUFDLE9BQU87UUFDVixPQUFPO1lBQ0gsa0JBQWtCLENBQUMsSUFBaUM7Z0JBQ2hELElBQUksMEJBQTBCLENBQUMsSUFBSSxDQUFDLEVBQUUsQ0FBQztvQkFDbkMsT0FBTyxDQUFDLE1BQU0sQ0FBQzt3QkFDWCxJQUFJLEVBQUUsSUFBSTt3QkFDVixTQUFTLEVBQUUsNEJBQTRCO3FCQUMxQyxDQUFDLENBQUM7Z0JBQ1AsQ0FBQztnQkFDRCxJQUFJLDBCQUEwQixDQUFDLElBQUksQ0FBQyxFQUFFLENBQUM7b0JBQ25DLE9BQU8sQ0FBQyxNQUFNLENBQUM7d0JBQ1gsSUFBSSxFQUFFLElBQUk7d0JBQ1YsU0FBUyxFQUFFLDRCQUE0QjtxQkFDMUMsQ0FBQyxDQUFDO2dCQUNQLENBQUM7WUFDTCxDQUFDO1NBQ0osQ0FBQztJQUNOLENBQUM7Q0FDSixDQUFDLENBQUM7QUFFSCxlQUFlLElBQUksQ0FBQyJ9
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYXBpUHJvcGVydHlNYXRjaGVzUHJvcGVydHlPcHRpb25hbGl0eS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uL3NyYy9ydWxlcy9hcGlQcm9wZXJ0eU1hdGNoZXNQcm9wZXJ0eU9wdGlvbmFsaXR5L2FwaVByb3BlcnR5TWF0Y2hlc1Byb3BlcnR5T3B0aW9uYWxpdHkudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxFQUFDLFFBQVEsRUFBQyxNQUFNLDBCQUEwQixDQUFDO0FBQ2xELE9BQU8sRUFBQyxVQUFVLEVBQUMsTUFBTSwyQkFBMkIsQ0FBQztBQUNyRCxPQUFPLEVBQUMsaUJBQWlCLEVBQUMsTUFBTSxrQ0FBa0MsQ0FBQztBQUVuRSxNQUFNLENBQUMsTUFBTSwwQkFBMEIsR0FBRyxDQUN0QyxJQUFpQyxFQUMxQixFQUFFO0lBQ1QsTUFBTSxvQkFBb0IsR0FBRyxpQkFBaUIsQ0FBQyxzQkFBc0IsQ0FDakUsSUFBSSxFQUNKLENBQUMscUJBQXFCLENBQUMsQ0FDMUIsQ0FBQztJQUVGLE1BQU0sdUJBQXVCLEdBQ3pCLGlCQUFpQixDQUFDLHVCQUF1QixDQUFDLElBQUksQ0FBQyxDQUFDO0lBRXBELE9BQU8sb0JBQW9CLElBQUksQ0FBQyx1QkFBdUIsQ0FBQztBQUM1RCxDQUFDLENBQUM7QUFFRixNQUFNLENBQUMsTUFBTSwwQkFBMEIsR0FBRyxDQUN0QyxJQUFpQyxFQUMxQixFQUFFO0lBQ1QsTUFBTSxvQkFBb0IsR0FBRyxpQkFBaUIsQ0FBQyxzQkFBc0IsQ0FDakUsSUFBSSxFQUNKLENBQUMsYUFBYSxDQUFDLENBQ2xCLENBQUM7SUFFRixNQUFNLHVCQUF1QixHQUN6QixpQkFBaUIsQ0FBQyx1QkFBdUIsQ0FBQyxJQUFJLENBQUMsQ0FBQztJQUVwRCxPQUFPLG9CQUFvQixJQUFJLHVCQUF1QixDQUFDO0FBQzNELENBQUMsQ0FBQztBQUVGLE1BQU0sQ0FBQyxNQUFNLG9CQUFvQixHQUFHLENBQ2hDLElBQWlDLEVBQzFCLEVBQUU7SUFDVCxNQUFNLHFCQUFxQixHQUFHLGlCQUFpQixDQUFDLGtCQUFrQixDQUFDLElBQUksRUFBRTtRQUNyRSxhQUFhO0tBQ2hCLENBQUMsQ0FBQztJQUVILEtBQUssTUFBTSxTQUFTLElBQUkscUJBQXFCLEVBQUUsQ0FBQztRQUM1QyxJQUNJLFNBQVMsQ0FBQyxVQUFVLENBQUMsSUFBSSxLQUFLLFFBQVEsQ0FBQyxjQUFjLENBQUMsY0FBYyxFQUN0RSxDQUFDO1lBQ0MsTUFBTSxhQUFhLEdBQUcsU0FBUyxDQUFDLFVBQVUsQ0FBQyxTQUFTLENBQUMsQ0FBQyxDQUFDLENBQUM7WUFFeEQsSUFDSSxhQUFhO2dCQUNiLGFBQWEsQ0FBQyxJQUFJLEtBQUssUUFBUSxDQUFDLGNBQWMsQ0FBQyxnQkFBZ0IsRUFDakUsQ0FBQztnQkFDQyxNQUFNLGVBQWUsR0FDakIsaUJBQWlCLENBQUMsOEJBQThCLENBQzVDLGFBQWEsRUFDYixVQUFVLEVBQ1YsSUFBSSxDQUNQLENBQUM7Z0JBRU4sSUFBSSxlQUFlLEVBQUUsQ0FBQztvQkFDbEIsT0FBTyxJQUFJLENBQUM7Z0JBQ2hCLENBQUM7WUFDTCxDQUFDO1FBQ0wsQ0FBQztJQUNMLENBQUM7SUFFRCxPQUFPLEtBQUssQ0FBQztBQUNqQixDQUFDLENBQUM7QUFRRixNQUFNLElBQUksR0FBRyxVQUFVLENBS3JCO0lBQ0UsSUFBSSxFQUFFLDJDQUEyQztJQUNqRCxJQUFJLEVBQUU7UUFDRixJQUFJLEVBQUU7WUFDRixXQUFXLEVBQ1Asd0RBQXdEO1NBQy9EO1FBQ0QsUUFBUSxFQUFFO1lBQ04sMEJBQTBCLEVBQUUsdUVBQXVFO1lBQ25HLDBCQUEwQixFQUFFLCtEQUErRDtZQUMzRixpQkFBaUIsRUFBRSxpRkFBaUY7U0FDdkc7UUFDRCxNQUFNLEVBQUU7WUFDSjtnQkFDSSxJQUFJLEVBQUUsUUFBUTtnQkFDZCxvQkFBb0IsRUFBRSxLQUFLO2dCQUMzQixVQUFVLEVBQUU7b0JBQ1Isc0JBQXNCLEVBQUU7d0JBQ3BCLFdBQVcsRUFDUCxzRUFBc0U7d0JBQzFFLElBQUksRUFBRSxTQUFTO3FCQUNsQjtpQkFDSjthQUNKO1NBQ0o7UUFDRCxjQUFjLEVBQUUsS0FBSztRQUNyQixJQUFJLEVBQUUsWUFBWTtLQUNyQjtJQUNELGNBQWMsRUFBRTtRQUNaO1lBQ0ksc0JBQXNCLEVBQUUsSUFBSTtTQUMvQjtLQUNKO0lBRUQsTUFBTSxDQUFDLE9BQU87UUFDVixNQUFNLE9BQU8sR0FBRyxPQUFPLENBQUMsT0FBTyxDQUFDLENBQUMsQ0FBQyxJQUFJLEVBQUUsQ0FBQztRQUN6QyxNQUFNLDRCQUE0QixHQUM5QixPQUFPLENBQUMsc0JBQXNCLElBQUksSUFBSSxDQUFDO1FBRTNDLE9BQU87WUFDSCxrQkFBa0IsQ0FBQyxJQUFpQztnQkFDaEQsSUFBSSwwQkFBMEIsQ0FBQyxJQUFJLENBQUMsRUFBRSxDQUFDO29CQUNuQyxPQUFPLENBQUMsTUFBTSxDQUFDO3dCQUNYLElBQUksRUFBRSxJQUFJO3dCQUNWLFNBQVMsRUFBRSw0QkFBNEI7cUJBQzFDLENBQUMsQ0FBQztnQkFDUCxDQUFDO2dCQUNELElBQUksMEJBQTBCLENBQUMsSUFBSSxDQUFDLEVBQUUsQ0FBQztvQkFDbkMsT0FBTyxDQUFDLE1BQU0sQ0FBQzt3QkFDWCxJQUFJLEVBQUUsSUFBSTt3QkFDVixTQUFTLEVBQUUsNEJBQTRCO3FCQUMxQyxDQUFDLENBQUM7Z0JBQ1AsQ0FBQztnQkFDRCxJQUNJLDRCQUE0QjtvQkFDNUIsb0JBQW9CLENBQUMsSUFBSSxDQUFDLEVBQzVCLENBQUM7b0JBQ0MsT0FBTyxDQUFDLE1BQU0sQ0FBQzt3QkFDWCxJQUFJLEVBQUUsSUFBSTt3QkFDVixTQUFTLEVBQUUsbUJBQW1CO3FCQUNqQyxDQUFDLENBQUM7Z0JBQ1AsQ0FBQztZQUNMLENBQUM7U0FDSixDQUFDO0lBQ04sQ0FBQztDQUNKLENBQUMsQ0FBQztBQUVILGVBQWUsSUFBSSxDQUFDIn0=

package/dist/rules/index.d.ts

@@ -1,6 +1,8 @@
 declare const allRules: {
     "all-properties-have-explicit-defined": import("@typescript-eslint/utils/ts-eslint").RuleModule<"missing-is-defined-decorator" | "missing-is-optional-decorator" | "conflicting-defined-decorators-defined-optional" | "conflicting-defined-decorators-optional-validate-if" | "conflicting-defined-decorators-all", [], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
-    "api-property-matches-property-optionality": import("@typescript-eslint/utils/ts-eslint").RuleModule<"shouldUseOptionalDecorator" | "shouldUseRequiredDecorator", [], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
+    "api-property-matches-property-optionality": import("@typescript-eslint/utils/ts-eslint").RuleModule<"shouldUseOptionalDecorator" | "shouldUseRequiredDecorator" | "redundantRequired", [{
+        checkRedundantRequired?: boolean;
+    }], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
     "injectable-should-be-provided": import("@typescript-eslint/utils/ts-eslint").RuleModule<"injectableInModule" | "controllersInModule", [{
         src: string[];
         filterFromPaths: string[];

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@darraghor/eslint-plugin-nestjs-typed",
-    "version": "6.13.0",
+    "version": "6.14.0",
     "description": "Eslint rules for nestjs projects",
     "scripts": {
         "clean": "rm -Rf ./dist/",