Prettier prose-wrap on markdown docs is unhelpful - thoughts?

[HChughtai]

Short Description

When writing longer form docs (e.g. https://github.com/UCL-MIRSG/MIRSG/tree/main/docs), I find it quite annoying that prettier hard wraps the text to its line length limits. This makes prose harder to read as raw markdown as it's split at random points. Personally I don't think the hard line wrapping is necessary here as editors soft wrap well.

We can change this behaviour through the prose-wrap behaviour, which is currently set here:

.github/precommit/mirsg-hooks.yaml

Line 117 in bb89c12

- --prose-wrap=always

However I expect people may have different thoughts. Any strong opinions @UCL-MIRSG/mirsg?

Details

No response

Next Steps/Accepted Response

No response

[paddyroddy]

I personally find it easier to read, i.e. in the terminal. However, I appreciate this is very personal. I'm very happy for it to be changed. I think if changing, I'd vote to never over preserve as I think one of the biggest strengths of these combined hooks as you always know what is going to happen.

[p-j-smith]

It would be nice to have more control over where the line breaks are in markdown prose. I wouldn't be keen on setting --prose-wrap=never as that would put an entire paragraph on a single line and make it more difficult to read the raw markdown.

I would lean towards:

• setting --prose-wrap=preserve, but this has drawbacks as @paddyroddy pointed out
• configuring an override to increase the max line length for markdown files (to 120 characters? 150?)