olistic/warriorjs

Add flag to CLI to generate text READMEs

Open

#47 aperta il 3 mag 2018

Vedi su GitHub
 (11 commenti) (0 reazioni) (0 assegnatari)JavaScript (528 fork)batch import
good first issuepkg: clistatus: claimedtype: feature

Metriche repository

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

Descrizione

Level READMEs in markdown format could be great if you're using some kind of markdown processor to read them. If you're not planning on doing so, having the markdown syntax laying around creates noise. Running warriorjs --no-markdown should take care of that, and output to README.txt instead of README.md.

Guida contributor

Direzione di ricerca
La CLI probabilmente utilizza un parser di argomenti da riga di comando come yargs o commander. Cerca il punto di ingresso nella cartella `bin/` o `src/cli`. L'opzione ` no markdown` dovrebbe essere aggiunta e, quando presente, scrivere `README.txt` invece di `README.md`. Controlla la logica attuale di generazione del README per vedere dove viene impostata l'estensione del file. I commenti esistenti potrebbero fornire indicazioni sulle preferenze dei manutentori.
Tech stack
javascriptnodejs
Dominio
cli
Tipo issue
Funzionalità
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Mezza giornata
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
GitNode.js
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
70