kefranabg/readme-md-generator

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

Open

#206 aperta il 16 apr 2020

Vedi su GitHub
 (5 commenti) (0 reazioni) (0 assegnatari)JavaScript (1349 fork)batch import
bughelp wanted

Metriche repository

Star
 (10.735 star)
Metriche merge PR
 (Nessuna PR mergiata in 30 g)

Descrizione

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]

Guida contributor

Direzione di ricerca
Il bug si verifica quando viene inserito un nome utente con un trattino basso finale (es. 'foo '); questo viene trasformato in 'foo\ ' a causa dell'escape del markdown. Cerca nel codice sorgente come l'input dell'utente viene sanificato o interpolato negli URL dei badge. Controlla i file relativi alla gestione dei prompt (es. prompts/index.js) e la funzione di generazione dei badge. Rivedi i commenti dell'issue per eventuali discussioni precedenti o tentativi di correzione.
Tech stack
javascriptnodejs
Dominio
cli
Tipo issue
Bug
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
JavaScript
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
80