fix(check-types): allow changing of Object in typescript mode; me…

…ntioned in #800
gajus · Jan 21, 2022 · 6524c31 · 6524c31
1 parent 873228a
commit 6524c31
Show file tree

Hide file tree

Showing 3 changed files with 42 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -5438,6 +5438,15 @@ function b () {}
  */
 // Settings: {"jsdoc":{"structuredTags":{"aCustomTag":{"type":["otherType","anotherType"]}}}}
 // Message: Invalid JSDoc @aCustomTag "foo" type "Number"; prefer: ["otherType","anotherType"].
+
+/**
+ * @param {Object[]} foo
+ */
+function quux (foo) {
+
+}
+// Settings: {"jsdoc":{"mode":"typescript","preferredTypes":{"Object":"object"}}}
+// Message: Invalid JSDoc @param "foo" type "Object"; prefer: "object".
 ````
 
 The following patterns are not considered problems:

diff --git a/src/rules/checkTypes.js b/src/rules/checkTypes.js
@@ -221,7 +221,7 @@ export default iterateJsdoc(({
         ]);
       } else if (!noDefaults && type === 'JsdocTypeName') {
         for (const strictNativeType of strictNativeTypes) {
-          if (strictNativeType === 'object' && mode === 'typescript') {
+          if (strictNativeType === 'object' && mode === 'typescript' && !preferredTypes?.[nodeName]) {
             continue;
           }
 

diff --git a/test/rules/assertions/checkTypes.js b/test/rules/assertions/checkTypes.js
@@ -2129,6 +2129,38 @@ export default {
         },
       },
     },
+    {
+      code: `
+      /**
+       * @param {Object[]} foo
+       */
+      function quux (foo) {
+
+      }
+      `,
+      errors: [
+        {
+          line: 3,
+          message: 'Invalid JSDoc @param "foo" type "Object"; prefer: "object".',
+        },
+      ],
+      output: `
+      /**
+       * @param {object[]} foo
+       */
+      function quux (foo) {
+
+      }
+      `,
+      settings: {
+        jsdoc: {
+          mode: 'typescript',
+          preferredTypes: {
+            Object: 'object',
+          },
+        },
+      },
+    },
   ],
   valid: [
     {