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.