feat(prettier-plugin-jsdoc): add function to trim tags properties

src/fns/formatTags.js

@@ -2,14 +2,15 @@ const R = require('ramda');
 const { formatAccessTag } = require('./formatAccessTag');
 const { replaceTagsSynonyms } = require('./replaceTagsSynonyms');
 const { sortTags } = require('./sortTags');
+const { trimTagsProperties } = require('./trimTagsProperties');
 
 /**
  * @typedef {import('../types').CommentTag} CommentTag
  * @typedef {import('../types').PJPTagsOptions} PJPTagsOptions
  */
 
 /**
- * Formats the tags' names and applies sorting, if enabled, to a list of tags.
+ * Formats the tags' names, trims the values, and applies sorting, if enabled, to a list of tags.
  *
  * @callback FormatTagsFn
  * @param {CommentTag[]}   tags     The list to format.
@@ -21,7 +22,10 @@ const { sortTags } = require('./sortTags');
  * @type {FormatTagsFn}
  */
 const formatTags = R.curry((tags, options) => {
-  const fns = [formatAccessTag(R.__, options)];
+  const fns = [
+    trimTagsProperties,
+    formatAccessTag(R.__, options),
+  ];
 
   if (options.jsdocReplaceTagsSynonyms) {
     fns.push(replaceTagsSynonyms);

src/fns/trimTagsProperties.js

@@ -0,0 +1,23 @@
+/**
+ * @typedef {import('../types').CommentTag} CommentTag
+ */
+
+/**
+ * Takes a list of tags and trims the values of the properties the plugins uses (type, name and
+ * description).
+ *
+ * @param {CommentTag[]} tags The list of tags to format.
+ * @returns {CommentTag[]}
+ */
+const trimTagsProperties = (tags) => {
+  const knownProperties = ['type', 'name', 'description'];
+  return tags.map((tag) => Object.entries(tag).reduce(
+    (acc, [key, value]) => ({
+      ...acc,
+      [key]: knownProperties.includes(key) ? value.trim() : value,
+    }),
+    {},
+  ));
+};
+
+module.exports.trimTagsProperties = trimTagsProperties;

test/unit/fns/formatTags.test.js

@@ -3,6 +3,7 @@ jest.unmock('../../../src/fns/utils');
 jest.unmock('../../../src/fns/formatAccessTag');
 jest.unmock('../../../src/fns/replaceTagsSynonyms');
 jest.unmock('../../../src/fns/sortTags');
+jest.unmock('../../../src/fns/trimTagsProperties');
 
 const { formatTags } = require('../../../src/fns/formatTags');
 

test/unit/fns/trimTagProperties.test.js

@@ -0,0 +1,32 @@
+jest.unmock('../../../src/fns/trimTagsProperties');
+
+const { trimTagsProperties } = require('../../../src/fns/trimTagsProperties');
+
+describe('trimTagsProperties', () => {
+  it('should correctly trim the properties of a tags list', () => {
+    // Given
+    const input = [
+      {
+        tag: 'param',
+        type: ' string',
+        name: 'myParam   ',
+        description: '  my description  ',
+        unknown: '  this will be ignored ',
+      },
+    ];
+    const output = [
+      {
+        tag: 'param',
+        type: 'string',
+        name: 'myParam',
+        description: 'my description',
+        unknown: '  this will be ignored ',
+      },
+    ];
+    let result = null;
+    // When
+    result = trimTagsProperties(input);
+    // Then
+    expect(result).toEqual(output);
+  });
+});