kefranabg/readme-md-generator

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

Open

#206 opened on Apr 16, 2020

View on GitHub
 (5 comments) (0 reactions) (0 assignees)JavaScript (10,735 stars) (1,349 forks)batch import
bughelp wanted

Description

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]

Contributor guide

Tech stack
javascriptnodejs
Domain
cli
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Node.jsCLI
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
The bug occurs when a username with a trailing underscore (e.g., 'foo ') is input; it gets transformed to 'foo\ ' due to markdown escaping. Look in the source code for how user input is sanitized or interpolated into badge URLs. Check files related to prompt handling (e.g., prompts/index.js) and the badge generation function. Review issue comments for any previous discussion or attempted fixes.