GitHub adds \r when applying code suggestions

[armandas]

🏷️ Discussion Type

Bug

Body

Every now and then, when I apply suggestions from PR review, github inserts carriage return characters at line ends. This makes the suggestion feature useless and annoying to deal with. Is there any way this can be fixed or worked around?

[github-actions[bot]]

💬 Your Product Feedback Has Been Submitted 🎉

Thank you for taking the time to share your insights with us! Your feedback is invaluable as we build a better GitHub experience for all our users.

Here's what you can expect moving forward ⏩

• Your input will be carefully reviewed and cataloged by members of our product teams. 
  • Due to the high volume of submissions, we may not always be able to provide individual responses.
  • Rest assured, your feedback will help chart our course for product improvements.
• Other users may engage with your post, sharing their own perspectives or experiences. 
• GitHub staff may reach out for further clarification or insight. 
  • We may 'Answer' your discussion if there is a current solution, workaround, or roadmap/changelog post related to the feedback.

Where to look to see what's shipping 👀

• Read the Changelog for real-time updates on the latest GitHub features, enhancements, and calls for feedback.
• Explore our Product Roadmap, which details upcoming major releases and initiatives.

What you can do in the meantime 💻

• Upvote and comment on other user feedback Discussions that resonate with you.
• Add more information at any point! Useful details include: use cases, relevant labels, desired outcomes, and any accompanying screenshots.

As a member of the GitHub community, your participation is essential. While we can't promise that every suggestion will be implemented, we want to emphasize that your feedback is instrumental in guiding our decisions and priorities.

Thank you once again for your contribution to making GitHub even better! We're grateful for your ongoing support and collaboration in shaping the future of our platform. ⭐

[mminot-yseop]

“Fun” fact: We learned the hard way today that this is not merely cosmetic. This can break Bash scripts. 😅

This runs fine:

if [[ … ]]
then
    :
fi

But then if I write:

if [[ … ]]__HERE__
then
    :
fi

… and use this to get a \r instead of the __HERE__ mark:

sed 's/__HERE__/\r/'

… the script (despite not looking much different than usual to the unwary eye) suddenly yields:

sh2.sh: line 1: conditional binary operator expected
'h2.sh: line 1: syntax error near `]]
'h2.sh: line 1: `if [[ … ]]

Please fix this. 🥲

[mminot-yseop]

Quick update:

• Still happening.
• Seems to happen on nearly all my suggestions rather than just occasionally.
• Happens with suggestions written on Firefox and Chrome.
• Sometimes it yields CRLF so dos2unix fixes it, but sometimes it’s just a stray CR or something. Not sure what’s happening. Using sed to fix globally (or a combo of dos2unix and mac2unix rather than just one) is advised.
• I often don’t even dare to provide suggestions because of this, now, so it lowers my whole team’s productivity by forcing people to write manually stuff that I could have suggested directly.

FYI I’m on Xubuntu and using the “old” diff view (…/files, not …/changes). Dunno what matters or not regarding this issue. I’m surprised this seems to gather little to no attention, as if only a couple of people were affected. 🤔