Galooshi/import-js

Improve CLI documentation

Open

#532 opened on May 31, 2019

View on GitHub
 (2 comments) (0 reactions) (0 assignees)JavaScript (519 stars) (70 forks)batch import
help wanted

Description

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.

Contributor guide

Tech stack
javascript
Domain
documentationcli
Issue type
documentation
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.
clear
Prerequisites
Basic understanding of import js CLI
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80
Research direction
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.