olistic/warriorjs

Add flag to CLI to generate text READMEs

Open

#47 建立於 2018年5月3日

在 GitHub 查看
 (11 留言) (0 反應) (0 負責人)JavaScript (9,168 star) (528 fork)batch import
good first issuepkg: clistatus: claimedtype: feature

描述

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.

貢獻者指南

技術棧
javascriptnodejs
領域
clitooling
議題類型
feature
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-3 hours
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
stale
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
mostly clear
前置要求
Node.jsCLI developmentJavaScript
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
60
研究方向
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.