olistic/warriorjs

Add flag to CLI to generate text READMEs

Open

#47 opened on May 3, 2018

View on GitHub
 (11 comments) (0 reactions) (0 assignees)JavaScript (9,168 stars) (528 forks)batch import
good first issuepkg: clistatus: claimedtype: feature

Description

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
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Node.jsCLI developmentJavaScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
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.