olistic/warriorjs

Add flag to CLI to generate text READMEs

Open

#47 geöffnet am 3. Mai 2018

Auf GitHub ansehen
 (11 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)JavaScript (9.168 Stars) (528 Forks)batch import
good first issuepkg: clistatus: claimedtype: feature

Beschreibung

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.

Contributor Guide

Tech Stack
javascriptnodejs
Domain
clitooling
Issue Type
feature
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 hours
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
stale
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
mostly clear
Voraussetzungen
Node.jsCLI developmentJavaScript
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
60
Research-Richtung
The CLI likely uses a command line argument parser like yargs or commander. Look into the `bin/` or `src/cli` folder for the entry point. The flag ` no markdown` should be added to the options, and when present, write `README.txt` instead of `README.md`. Check the current README generation logic to see where the file extension is set. The existing comments may provide guidance on maintainer preferences.