Galooshi/import-js

Improve CLI documentation

Open

#532 ouverte le 31 mai 2019

Voir sur GitHub
 (2 commentaires) (0 réactions) (0 assignés)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.

Guide contributeur

Stack technique
javascript
Domaine
documentationcli
Type d'issue
documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 hours
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
stale
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
clear
Prérequis
Basic understanding of import js CLI
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
80
Direction de recherche
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.