fix(prettier-plugin-jsdoc): avoid formatting examples into sentences

homer0 · Oct 27, 2020 · 4f3d162 · 4f3d162
1 parent 0f58b54
commit 4f3d162
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 2 deletions.
diff --git a/src/fns/prepareTagDescription.js b/src/fns/prepareTagDescription.js
@@ -1,5 +1,5 @@
 const R = require('ramda');
-const { ensureSentence, hasValidProperty } = require('./utils');
+const { ensureSentence, hasValidProperty, isTag } = require('./utils');
 
 /**
  * @typedef {import('../types').CommentTag} CommentTag
@@ -12,7 +12,7 @@ const { ensureSentence, hasValidProperty } = require('./utils');
  * @returns {CommentTag}
  */
 const prepareTagDescription = (tag) => R.when(
-  hasValidProperty('description'),
+  R.allPass([hasValidProperty('description'), R.complement(isTag(['example', 'examples']))]),
   R.compose(
     R.assoc('description', R.__, tag),
     ensureSentence,

diff --git a/test/unit/fns/prepareTagDescription.test.js b/test/unit/fns/prepareTagDescription.test.js
@@ -34,6 +34,17 @@ describe('prepareTagDescription', () => {
         description: '  Something else.  ',
       },
     },
+    {
+      it: 'should ignore an @example tag',
+      input: {
+        tag: 'example',
+        description: '  something else  ',
+      },
+      output: {
+        tag: 'example',
+        description: '  something else  ',
+      },
+    },
   ];
 
   it.each(cases)('should correctly format the case %#', (caseInfo) => {