fix: tag removal for 0-line tags (if other tags present, only blank o…

…ut the tag; otherwise, remove to end of block); fixes #1040
gajus · Apr 24, 2023 · e99f4e8 · e99f4e8
1 parent 152e8c2
commit e99f4e8
Show file tree

Hide file tree

Showing 3 changed files with 115 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -5013,6 +5013,27 @@ function Test() {
 }
 // Settings: {"jsdoc":{"tagNamePreference":{"returns":"return"}}}
 // Message: Invalid JSDoc tag (preference). Replace "constructor" JSDoc tag with "class".
+
+/** @typedef {Object} MyObject
+ * @property {string} id - my id
+ */
+// "jsdoc/check-tag-names": ["error"|"warn", {"typed":true}]
+// Message: '@typedef' is redundant when using a type system.
+
+/**
+ * @property {string} id - my id
+ */
+// "jsdoc/check-tag-names": ["error"|"warn", {"typed":true}]
+// Message: '@property' is redundant when using a type system.
+
+/** @typedef {Object} MyObject */
+// "jsdoc/check-tag-names": ["error"|"warn", {"typed":true}]
+// Message: '@typedef' is redundant when using a type system.
+
+/** @typedef {Object} MyObject
+ */
+// "jsdoc/check-tag-names": ["error"|"warn", {"typed":true}]
+// Message: '@typedef' is redundant when using a type system.
 ````
 
 The following patterns are not considered problems:

diff --git a/src/iterateJsdoc.js b/src/iterateJsdoc.js
@@ -407,11 +407,15 @@ const getUtils = (
         } = jsdoc.source[spliceIdx].tokens;
 
         /* istanbul ignore if -- Currently want to clear entirely if removing tags */
-        if (!removeEmptyBlock && (end || delimiter === '/**')) {
+        if (
+          spliceIdx === 0 && jsdoc.tags.length >= 2 ||
+          !removeEmptyBlock && (end || delimiter === '/**')
+        ) {
           const {
             tokens,
           } = jsdoc.source[spliceIdx];
           for (const item of [
+            'postDelimiter',
             'tag',
             'postTag',
             'type',
@@ -423,10 +427,10 @@ const getUtils = (
             tokens[item] = '';
           }
         } else {
-          jsdoc.source.splice(spliceIdx, spliceCount - tagSourceOffset);
+          jsdoc.source.splice(spliceIdx, spliceCount - tagSourceOffset + (spliceIdx ? 0 : jsdoc.source.length));
+          tagSource.splice(tagIdx + tagSourceOffset, spliceCount - tagSourceOffset + (spliceIdx ? 0 : jsdoc.source.length));
         }
 
-        tagSource.splice(tagIdx + tagSourceOffset, spliceCount - tagSourceOffset);
         lastIndex = sourceIndex;
 
         return true;

diff --git a/test/rules/assertions/checkTagNames.js b/test/rules/assertions/checkTagNames.js
@@ -925,6 +925,93 @@ export default {
         },
       },
     },
+    {
+      code: `
+      /** @typedef {Object} MyObject
+       * @property {string} id - my id
+       */
+      `,
+      errors: [
+        {
+          line: 2,
+          message: '\'@typedef\' is redundant when using a type system.',
+        },
+        {
+          line: 3,
+          message: '\'@property\' is redundant when using a type system.',
+        },
+      ],
+      options: [
+        {
+          typed: true,
+        },
+      ],
+      output: `
+      /**
+       * @property {string} id - my id
+       */
+      `,
+    },
+    {
+      code: `
+      /**
+       * @property {string} id - my id
+       */
+      `,
+      errors: [
+        {
+          line: 3,
+          message: '\'@property\' is redundant when using a type system.',
+        },
+      ],
+      options: [
+        {
+          typed: true,
+        },
+      ],
+      output: `
+      /**
+       * id - my id
+       */
+      `,
+    },
+    {
+      code: `
+      /** @typedef {Object} MyObject */
+      `,
+      errors: [
+        {
+          line: 2,
+          message: '\'@typedef\' is redundant when using a type system.',
+        },
+      ],
+      options: [
+        {
+          typed: true,
+        },
+      ],
+      output: `
+      `,
+    },
+    {
+      code: `
+      /** @typedef {Object} MyObject
+       */
+      `,
+      errors: [
+        {
+          line: 2,
+          message: '\'@typedef\' is redundant when using a type system.',
+        },
+      ],
+      options: [
+        {
+          typed: true,
+        },
+      ],
+      output: `
+      `,
+    },
   ],
   valid: [
     {