Treat single-star comments as JSDoc

[j-f1]

Fixes #5194. Are the other changes to the snapshots reasonable?

• I’ve added tests to confirm my change works.
• I’ve read the contributing guidelines.

[j-f1]

Alternate heuristic: either a /** ... */ single-line comment, or every line except the first and last starts with a *, the first is either empty or *, and the last is empty.

[lydell]

I know you marked this as WIP, but I like it already :)

[lydell]

@j-f1 How do you feel about this one?

[j-f1]

Sorry, I haven’t had a chance to refactor the heuristic yet @lydell. I’ll take a look at that this afternoon/evening (EDT).

[lydell]

Is this an intended change?

Prettier 1.14.3
Playground link

--parser babylon

Input:

  /** one
   * two
   */

Output:

/** one
 * two
 */

Prettier pr-5206
Playground link

--parser babylon

Input:

  /** one
   * two
   */

Output:

/** one
   * two
   */

[j-f1]

Sort of. Should I allow arbitrary text on the first line in both /** and /* comments, or just /* ones?

[lydell]

First line: Anything goes, I’d say. I can’t see a reason to restrict the first line in any way?

[lydell]

Perhaps the function should be called something like isIndentableBlockComment rather than isJSDocComment…

[lydell]

Could you add these tests?

  /** first line
   * second line
   * third line */

  /* first line
   * second line
   * third line */

[lydell]

Btw, would this work?

function isIndentableBlockComment(comment) {
  // If the comment has multiple lines and every line starts with a star
  // we can fix the indentation of each line. The stars in the `/*` and
  // `*/` delimiters are not included in the comment value, so add them
  // back first.
  const lines = `*${comment.value}*`.split("\n");
  return lines.length > 1 && lines.every(line => line.trim()[0] === "*");
}

EDIT: Updated code.

[lydell]

@j-f1 I took the liberty to update your branch with my suggestions myself. What do you think?

[j-f1]

LGTM. Good to merge? (cc @duailibe too)