feat(eslint-plugin-vtex): support ObjectPattern for consistent-props-…

…types
vtex · Apr 29, 2024 · a34a5d3 · a34a5d3
1 parent d3bf294
commit a34a5d3
Show file tree

Hide file tree

Showing 3 changed files with 44 additions and 1 deletion.
diff --git a/packages/eslint-plugin-vtex/CHANGELOG.md b/packages/eslint-plugin-vtex/CHANGELOG.md
@@ -10,6 +10,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Fixed
 - Changes entrypoint to dist/index.js
+- Support to ObjectPattern on the component props for `vtex/consistent-props-type`
 
 ## [2.2.1] - 2022-05-30
 ### Added

diff --git a/packages/eslint-plugin-vtex/src/rules/__tests__/consistent-props-type.test.ts b/packages/eslint-plugin-vtex/src/rules/__tests__/consistent-props-type.test.ts
@@ -94,6 +94,48 @@ ruleTester.run('consistent-props-type', consistentPropsType, {
       ],
     },
 
+    {
+      code: `
+        function Divider({ inline }: { inline: boolean }) {
+          return <hr />
+        }
+      `,
+      errors: [
+        {
+          messageId: 'invalidInlinePropsType',
+          data: { expectedPropsTypeName: 'DividerProps' },
+        },
+      ],
+    },
+
+    {
+      code: `
+        function Divider({ inline, ...props }: { inline: boolean }) {
+          return <hr />
+        }
+      `,
+      errors: [
+        {
+          messageId: 'invalidInlinePropsType',
+          data: { expectedPropsTypeName: 'DividerProps' },
+        },
+      ],
+    },
+
+    {
+      code: `
+        function Divider({ ...props }: { inline: boolean }) {
+          return <hr />
+        }
+      `,
+      errors: [
+        {
+          messageId: 'invalidInlinePropsType',
+          data: { expectedPropsTypeName: 'DividerProps' },
+        },
+      ],
+    },
+
     {
       code: `
         const Divider = (props: { inline: boolean } & { intersection: true }) => {

diff --git a/packages/eslint-plugin-vtex/src/rules/consistent-props-type.ts b/packages/eslint-plugin-vtex/src/rules/consistent-props-type.ts
@@ -35,7 +35,7 @@ export const consistentPropsType = createRule({
 
   create(context) {
     return {
-      ':function > Identifier > TSTypeAnnotation'(
+      ':function > :matches(Identifier, ObjectPattern) > TSTypeAnnotation'(
         node: TSESTree.TSTypeAnnotation
       ) {
         if (isInsideAnotherFunction(context)) return