fix(prettier-plugin-jsdoc): force space between tag name and type

homer0 · Apr 21, 2022 · 3d94fff · 3d94fff
1 parent 824df99
commit 3d94fff
Show file tree

Hide file tree

Showing 3 changed files with 77 additions and 1 deletion.
diff --git a/src/fns/getParsers.js b/src/fns/getParsers.js
@@ -76,7 +76,11 @@ const generateCommentData = (comment) => {
       start: { column },
     },
   } = comment;
-  const [block] = commentParser(`/*${comment.value}*/`, {
+  const commentText = comment.value.replace(
+    /^(\s*\*\s*@[a-z]+){/gim,
+    (_, group) => `${group} {`,
+  );
+  const [block] = commentParser(`/*${commentText}*/`, {
     dotted_names: false,
     spacing: 'preserve',
   });

diff --git a/test/e2e/fixtures/random-03.fixture.js b/test/e2e/fixtures/random-03.fixture.js
@@ -16,6 +16,7 @@ module.exports = {
  * 	hide?: 'narrow' | 'other'
  * 	overlap?: 'next' | 'previous'
  * }} SectionValueProps
+ * @template{InputProps<Value>} [Props=React.ComponentProps<Input>]
  */
 
 //# output
@@ -31,4 +32,5 @@ module.exports = {
  *   hide?: 'narrow' | 'other'
  *   overlap?: 'next' | 'previous'
  * }} SectionValueProps
+ * @template {InputProps<Value>} [Props=React.ComponentProps<Input>]
  */
diff --git a/test/unit/fns/getParsers.test.js b/test/unit/fns/getParsers.test.js
@@ -369,4 +369,74 @@ describe('getParsers', () => {
       ],
     });
   });
+
+  it('should fix a tag without a space between name and type', () => {
+    // Given
+    const commentStr = '*\n * @typedef{string} MyStr\n ';
+    const column = 2;
+    const astBase = {
+      comments: [
+        {
+          type: 'CommentBlock',
+          value: commentStr,
+          loc: {
+            start: {
+              column,
+            },
+          },
+        },
+      ],
+    };
+    const ast = R.clone(astBase);
+    const tagsList = [
+      {
+        tag: 'typedef',
+        type: 'string',
+        name: 'MyStr',
+        description: '',
+      },
+    ];
+    const parsed = [
+      {
+        description: '',
+        tags: tagsList,
+      },
+    ];
+    commentParser.mockImplementationOnce(() => parsed);
+    const formatTagsTypesRest = jest.fn((tags) => tags);
+    formatTagsTypes.mockImplementationOnce(() => formatTagsTypesRest);
+    const formatTagsRest = jest.fn((tags) => tags);
+    formatTags.mockImplementationOnce(() => formatTagsRest);
+    const formatDescriptionRest = jest.fn((tags) => tags);
+    formatDescription.mockImplementationOnce(() => formatDescriptionRest);
+    const prepareTagsRest = jest.fn((tags) => tags);
+    prepareTags.mockImplementationOnce(() => prepareTagsRest);
+    const renderRest = jest.fn(() => ['@typedef {string} MyFormattedStr']);
+    render.mockImplementationOnce(() => renderRest);
+    tsParser.parsers.typescript.parse.mockImplementationOnce(() => ast);
+    const text = 'lorem ipsum';
+    const parsers = ['ts'];
+    const options = {
+      jsdocPluginEnabled: true,
+      printWidth: 80,
+    };
+    let sut = null;
+    // When
+    sut = getParsers();
+    sut.typescript.parse(text, parsers, options);
+    // Then
+    expect(ast).toEqual({
+      comments: [
+        {
+          type: 'CommentBlock',
+          value: '*\n   * @typedef {string} MyFormattedStr\n   ',
+          loc: {
+            start: {
+              column,
+            },
+          },
+        },
+      ],
+    });
+  });
 });