chore: keep TS typed prop sorting check behind an option

jsx-eslint · Aug 15, 2023 · 5955ae9 · 5955ae9
1 parent 1519630
commit 5955ae9
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 0 deletions.
diff --git a/lib/rules/sort-prop-types.js b/lib/rules/sort-prop-types.js
@@ -52,6 +52,9 @@ module.exports = {
         sortShapeProp: {
           type: 'boolean',
         },
+        allowTypescript: {
+          type: 'boolean',
+        },
       },
       additionalProperties: false,
     }],
@@ -64,6 +67,7 @@ module.exports = {
     const ignoreCase = configuration.ignoreCase || false;
     const noSortAlphabetically = configuration.noSortAlphabetically || false;
     const sortShapeProp = configuration.sortShapeProp || false;
+    const allowTypescript = configuration.allowTypescript || false;
 
     const typeAnnotations = new Map();
 
@@ -218,6 +222,9 @@ module.exports = {
     }
 
     function handleFunctionComponent(node) {
+      if (!allowTypescript) {
+        return;
+      }
       const firstArg = node.params[0].typeAnnotation && node.params[0].typeAnnotation.typeAnnotation;
       if (firstArg && firstArg.type === 'TSTypeReference') {
         const propType = typeAnnotations.get(firstArg.typeName.name)

diff --git a/tests/lib/rules/sort-prop-types.js b/tests/lib/rules/sort-prop-types.js
@@ -480,6 +480,19 @@ ruleTester.run('sort-prop-types', rule, {
         });
       `,
       options: [{ callbacksLast: true, noSortAlphabetically: true }],
+    },
+    {
+      code: `
+        type Props = {
+          zzz: string;
+          aaa: string;
+        }
+        function Foo(props: Props) {
+          return null;
+        }
+      `,
+      features: ['ts', 'no-babel'],
+      options: [{ allowTypescript: false }],
     }
   )),
   invalid: parsers.all([].concat(
@@ -2271,6 +2284,7 @@ ruleTester.run('sort-prop-types', rule, {
         }
       `,
       features: ['ts', 'no-babel'],
+      options: [{ allowTypescript: true }],
       errors: [
         {
           messageId: 'propsNotSorted',
@@ -2300,6 +2314,7 @@ ruleTester.run('sort-prop-types', rule, {
         }
       `,
       features: ['ts', 'no-babel'],
+      options: [{ allowTypescript: true }],
       errors: [
         {
           messageId: 'propsNotSorted',
@@ -2327,6 +2342,7 @@ ruleTester.run('sort-prop-types', rule, {
         }
       `,
       features: ['ts', 'no-babel'],
+      options: [{ allowTypescript: true }],
       errors: [
         {
           messageId: 'propsNotSorted',