Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Getting wrong output form input of any username with a trailing underscore #206

Open
c12i opened this issue Apr 16, 2020 · 5 comments
Open
Labels
bug Something isn't working help wanted Extra attention is needed

Comments

@c12i
Copy link

c12i commented Apr 16, 2020

Description
When inputting usernames (Twitter, Github, Linkedin or Patreon) with a trailing underscore (i.e foo_), a backward slash is inserted before the trailing underscore leading to errors loading the badge correctly and having to manually fix it.

To Reproduce
Steps to reproduce the behavior:
Input:

GitHub username (use empty value to skip) foo_

Output

GitHub username (use empty value to skip) foo\_
  1. Run npx readme-md-generator
  2. Skip to username input part
  3. When asked to input Github username, key in foo_
  4. See error

ScreenShot
Screenshot 2020-04-16 at 12 35 54

Desktop:

  • OS: [MacOS Catalina]
  • Version [10.15.3]
@kefranabg kefranabg added bug Something isn't working help wanted Extra attention is needed labels Apr 29, 2020
@jeremiahtenbrink
Copy link

I am getting wrong username values for my username at twitter.
Pretty sure its happening because of the escapeMarkdown function that is being called in cleanSocialNetworkUsername function.

@c12i
Copy link
Author

c12i commented Jun 26, 2020

Yes indeed @jeremiahtenbrink , the error seems to be originating from the markdownEscape library. Removing the _ replacement seems to fix the issue.
Screenshot 2020-06-26 at 10 21 43

@jeremiahtenbrink
Copy link

Interesting. Is that an option we get with that package. I'm not entirely sure why we are escaping markdown text anyway. It's not we are having to worry about other users injecting code into our readme. We aren't parsing users text and turning it into a readme. So why we are trying to escape the text I don't understand. If anyone has more insight and its something I'm missing. Please let me know.

@c12i
Copy link
Author

c12i commented Jun 26, 2020

Perhaps @anku255 could have a good reason for that, see his pr #183

@Edo78
Copy link

Edo78 commented Oct 21, 2020

I think I understood what's happening... Let's me explain but keep in mind that English isn't my first language so bear with me.

My Twitter username is _Edo_ so it must be escaped otherwise in markdown is showed as Edo (without the underscore and in italic).

The problem arise only using HTML because the URL is still escaped for markdown even if it's not parsed as markdown.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

4 participants