Galooshi/import-js

Improve CLI documentation

Open

#532 建立於 2019年5月31日

在 GitHub 查看
 (2 留言) (0 反應) (0 負責人)JavaScript (519 star) (70 fork)batch import
help wanted

描述

I see docs here - https://github.com/Galooshi/import-js/#command-line-tool - that shows how to pass arguments to a given command but it doesn't say what the commands do. I've figured out that goto resolves the import statement to the file where its defined but the others remain a mystery. Just curious if we could get more explanation.

貢獻者指南

技術棧
javascript
領域
documentationcli
議題類型
documentation
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-3 hours
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
stale
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
Basic understanding of import js CLI
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
80
研究方向
The issue requests better documentation for CLI commands. The existing docs are at https://github.com/Galooshi/import js/#command line tool. Investigate the source code to list all available commands (e.g., 'goto') and their functionality, then update the README with a description for each. Consider adding examples for common use cases.
Improve CLI documentation · Galooshi/import-js#532 | Good First Issue