fix(prettier-plugin-jsdoc): stop assuming there's a trailing star

homer0 · Oct 22, 2020 · d56e1f9 · d56e1f9
1 parent f36904e
commit d56e1f9
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 9 deletions.
diff --git a/src/fns/createParser.js b/src/fns/createParser.js
@@ -257,11 +257,12 @@ const prepareCommentTags = R.curry((options, info) => R.compose(
 const getRenderer = (options) => {
   const renderer = render(options);
   return (column, block) => {
-    const prefix = `${' '.repeat(column)} * `;
+    const padding = ' '.repeat(column + 1);
+    const prefix = `${padding}* `;
     const lines = renderer(column, block)
     .map((line) => `${prefix}${line}`)
     .join('\n');
-    return `*\n${lines}\n${prefix}`.trimEnd();
+    return `*\n${lines}\n${padding}`;
   };
 };
 
@@ -273,18 +274,22 @@ const getRenderer = (options) => {
  * @returns {PrettierParseFn}
  */
 const createParser = (originalParser) => (text, parsers, options) => {
-  const { comments } = originalParser(text, parsers, options);
+  const ast = originalParser(text, parsers, options);
   const formatter = R.compose(
     prepareCommentTags(options),
     formatCommentTags(options),
     formatCommentBlock(options),
   );
   const renderer = getRenderer(options);
 
-  processComments(comments, formatter, (info) => {
-    const { comment, column, block } = info;
-    comment.value = renderer(column, block);
-  });
+  if (ast.comments && ast.comments.length) {
+    processComments(ast.comments, formatter, (info) => {
+      const { comment, column, block } = info;
+      comment.value = renderer(column, block);
+    });
+  }
+
+  return ast;
 };
 
 module.exports.createParser = createParser;
diff --git a/test/unit/fns/createParser.test.js b/test/unit/fns/createParser.test.js
@@ -39,7 +39,7 @@ describe('createParser', () => {
 
   it('should render a comment', () => {
     // Given
-    const commentStr = '*\n * @typedef {string} MyStr\n *';
+    const commentStr = '*\n * @typedef {string} MyStr\n ';
     const column = 2;
     const astBase = {
       comments: [{
@@ -87,7 +87,7 @@ describe('createParser', () => {
     expect(ast).toEqual({
       comments: [{
         type: 'CommentBlock',
-        value: '*\n   * @typedef {string} MyFormattedStr\n   *',
+        value: '*\n   * @typedef {string} MyFormattedStr\n   ',
         loc: {
           start: {
             column,