Clear prettier error with prettier-ignore comment

[julieg18]

• stops prettier from incorrectly formatting line in docs/command-ref/repro (Restyle status: misc updates #3313)

[julieg18]

If we don't add a comment, prettier adds a > at the end of line 55.

[yathomasi]

Looks good to me.

This unique issue seems to happen when the bracketed link falls on line wrap. So, I don't see a way to fix this on a prettier config.
Changing proseWrap would affect other.

[shcheklein]

Hmm. Restyle is using prettier also. pre-commit and Restyle must be consistent. If they are not- that'a a bug to my mind. Or am I missing something?

We've never so far had to add prettier-ignore as far as I remember.

[jorgeorpinel]

pre-commit and Restyle must be consistent

They are. Prettier on the pre-commit hook tries to do the same. I had to git commit -n in #3327 (comment).

[jorgeorpinel]

This unique issue seems to happen when the bracketed link falls on line wrap

Is that somehow valid or should we maybe report the issue to https://github.com/prettier/prettier ?

[jorgeorpinel]

We've never so far had to add prettier-ignore as far as I remember.

p.s. we only have one more around a YAML block in https://raw.githubusercontent.com/iterative/dvc.org/master/content/docs/user-guide/project-structure/pipelines-files.md

[shcheklein]

They are.

Then I might be missing the problem. Could you give me some context? If they are consistent we should never see Retyled PRs if pre-commit got applied, right?

[jorgeorpinel]

Correct. Full context:

1. Prettier wands to add a > symbol at the end of the line in an edge case situation, which seems like a bug.
2. To avoid that I forcibly skipped the hook locally (in 4f8f889), but Restyled created its PR since Prettier failed upstream.
3. I Ignored the Restyled PR and merged the original (which closed the Restyled one), thinking we wouldn't have to worry about it after that PR.
4. Because the GH checks actually check formatting for the whole code base now (since format: lint all files #2624), merging that line actually caused every PR after to create Restyled ones.
5. This PR tells Prettier to ignore the line to avoid 4.

[shcheklein]

Thanks, Jorge. Okay, I see they are aligned and both of them have the same bug. Have we raised the bug in the prettier repo to track? Also, can we put a comment with a link to this discussion somewhere nearby the ignore pragma?

[julieg18]

Thanks, Jorge. Okay, I see they are aligned and both of them have the same bug. Have we raised the bug in the prettier repo to track? Also, can we put a comment with a link to this discussion somewhere nearby the ignore pragma?

Looks like there is already an issue opened! There is also a pr opened for it already as well :)

[jorgeorpinel]

Great. I subscribed to the issue for now.

[casperdcl]

The PR's been open since Sept 2020 (prettier/prettier#9125) so prob not being merged soon.