style: Don't convert single \n to <br>

[leonardehrenfried]

As described in #3155 we (OpenTripPlanner) tend to have quite long, multi-paragraph descriptions of our fields.

In Markdown a single \n is ignored and only two \n should lead to a new paragraph being started.

markdown-it makes this fairly easy to achieve, which is why this PR is tiny.

Before

After

I've also taken the liberty to update the dev instructions.

Many thanks for this wonderful tool!

[changeset-bot[bot]]

🦋 Changeset detected

Latest commit: 470290cef8a4cbabd70a2429f7c2a2b38b2822d4

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 2 packages

Name	Type
graphiql	Patch
@graphiql/react	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[linux-foundation-easycla[bot]]

The committers listed above are authorized under a signed CLA.

• :white_check_mark: login: leonardehrenfried / name: Leonard Ehrenfried (687b28e0298cbc41563b34f4b6f653d45e267e21, a6e9612db76b89ee3ffc9e8cb83ca66306a722a2, ce09e53ed59e4909b5cb0db4ad58e2a5fa7c7d52)
• :white_check_mark: login: dimaMachina / name: Dimitri POSTOLOV (470290cef8a4cbabd70a2429f7c2a2b38b2822d4, b4c38d05457e58fec738691647dc74f961e2fed8, a81beacfc9e361899d5c2d1b78ee06d620d256e6)

[codecov[bot]]

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 67.27%. Comparing base (f2a6b39) to head (470290c). Report is 1 commits behind head on graphiql-v4.

Additional details and impacted files

@@             Coverage Diff              @@
##           graphiql-v4    #3414   +/-   ##
============================================
  Coverage        67.27%   67.27%           
============================================
  Files              120      120           
  Lines             7004     7004           
  Branches          2261     2266    +5     
============================================
  Hits              4712     4712           
  Misses            2275     2275           
  Partials            17       17           

Files	Coverage Δ
packages/graphiql-react/src/markdown.ts	100.00% <ø> (ø)

[acao]

@leonardehrenfried thank you for this, this is exactly how it should behave, I agree. I recall there was disagreement some years back and again with the redesign about this, I will look up some issues/discussions/? when I have more time. @thomasheyenbrock or @jonathanawesome what do you think?

one last thing, can you add a changeset as per the changset bot comment? then it'll be ready to go!

(we used to use conventional commits with lerna but contributors had issues, switched to changesets but I miss conventional commits often. i'm looking into ways to perhaps combine them, so many ways to go about it!)

[leonardehrenfried]

@acao I've added a changeset. I hope I'm bumping the right packages.

[acao]

awesome, thanks @leonardehrenfried ! I think we would make this a minor release for @graphiql/react as well

[leonardehrenfried]

Changeset was updated.

[leonardehrenfried]

Could I perhaps have another review for this?

[acao]

hey thanks for this! i'll come back to this later today or tomorrow and release it with some other new features for this @graphiql/react minor release

[leonardehrenfried]

Lovely thanks!

[leonardehrenfried]

Could I perhaps have another review for this, please?

[leonardehrenfried]

@acao Isn't this good to merge?

[acao]

sorry I hope to have more time for this in the coming months. my current commitments are for my day job and for a grant to work on the GraphQL LSP server that I'm wrapping up

[leonardehrenfried]

I totally understand. Thanks for maintaining GraphiQL!

[acao]

i think the only thing still stumping me is whether this constitutes a breaking change for some use cases, and whether there is some kind of markdown it config that solves the issue this intended to solve? maybe it was a workaround for the previous markdown library, was it marked? I need to look at the original history from, say, tag 0.7.y era or earlier to determine what the original purpose was

[dimaMachina]

I agree with @acao that this should not affect the current stable version of GraphiQL, let's fix change rendering it in GraphiQL v4