kefranabg/readme-md-generator

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

Open

#206 建立於 2020年4月16日

在 GitHub 查看
 (5 留言) (0 反應) (0 負責人)JavaScript (10,735 star) (1,349 fork)batch import
bughelp wanted

描述

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]

貢獻者指南

技術棧
javascriptnodejs
領域
cli
議題類型
bug
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
under 1 hour
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
stale
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
Node.jsCLI
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
70
研究方向
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.