--insert-pragma causing weird commenting issue due to single asterisk comment

[sygint]

Prettier 1.8.2
Playground link

--insert-pragma

Input:

/* ShippingValidation: 
 * Encapsulates the validation on the payment options page in checkout
 */

Output:

/**
 * /* ShippingValidation:
 * Encapsulates the validation on the payment options page in checkout
 *
 * @format
 */

Expected behavior:

/** @format */

/* ShippingValidation:
 * Encapsulates the validation on the payment options page in checkout
 */

or

/**
 * ShippingValidation:
 * Encapsulates the validation on the payment options page in checkout
 *
 * @format
 */

or

/*
 * ShippingValidation:
 * Encapsulates the validation on the payment options page in checkout
 *
 * @format
 */

I'd be fine if it added the proper Doc Block asterisk or if it just kept it a single, either way is fine.
I can TRY to get around to creating a PR for this, but I'm not sure I have the time today.

[sygint]

Looks to be an issue with jest-docblock not realizing it's a malformed doc-block, I'll work on a fix for that.

[lydell]

This is definitely a bug. Not sure what the expected output is though.

[sygint]

@lydell, it's a bug, but the bug is really in jest-docblock, it's desired behavior could be a few things, I think option 1 is the most sensible with the least caveats.

[sygint]

Single line comments do even weirder things...

** Input **

/* ShippingValidation: 
 */

** Output **

/**undefined * /* ShippingValidation:undefined *undefined * @formatundefined */

** Input **

/* ShippingValidation: */

** Output **

/**undefined * /* ShippingValidation:undefined *undefined * @formatundefined */

[sygint]

I think it's all just a minor parsing issue in jest-docblock, I'll look into it later

[aij]

It's also problematic with eslint and flow.

For example, eslint no-undef reports errors after prettier --insert-pragma changes

/* global foo */

to

/**
 * /* global foo
 *
 * @format
 */

Making the global declaration unrecognizable to eslint.

The @flow comments are handled similarly... They at least remain recognizable to flow itself, but (in addition to being ugly) some editor plugins fail to recognize them.

[fisker]

Fixed by #13054