kefranabg/readme-md-generator

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

Open

#206 opened on 2020年4月16日

GitHub で見る
 (5 comments) (0 reactions) (0 assignees)JavaScript (10,735 stars) (1,349 forks)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
Issue 種別
bug
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
under 1 hour
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
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.