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