Galooshi/import-js

Improve CLI documentation

Open

#532 opened on May 31, 2019

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

Repository metrics

Stars
 (519 stars)
PR merge metrics
 (No merged PRs in 30d)

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

Research direction
Examine the CLI command implementations in the source code, identify what each command (e.g., `goto`, `rewrite`, etc.) does, and update the documentation to explain their purpose and usage.
Tech stack
javascript
Domain
cli
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90