aspiers/stow

Clarify error message when `--target` directory doesn't exist

Open

#126 aperta il 22 gen 2025

Vedi su GitHub
 (1 commento) (0 reazioni) (0 assegnatari)Perl (51 fork)batch import
UXeasyhelp wanted

Metriche repository

Star
 (1013 star)
Metriche merge PR
 (Nessuna PR mergiata in 30 g)

Descrizione

The current error message if the --target directory doesn't exist looks like this:

stow: --target value '<path>' is not a valid directory

I personally found this wording to be quite confusing, and I actually ended up having to search the source code for the error to find what it actually meant. The phrasing "is not a valid directory" reads to me as "this is a directory, but you're not allowed to use it", not as "the target doesn't exist".

Additionally, having the full help print out in this error case makes it harder to see the error message at all.

I propose the following changes:

  1. Reword the error to be --target value '<path>' doesn't exist or is not a directory
  2. Don't automatically print the help if the --target is invalid

Guida contributor

Direzione di ricerca
Trova il file sorgente in cui è definito il messaggio di errore 'is not a valid directory' e traccia il percorso del codice che stampa l'aiuto. Modifica il messaggio e rimuovi la stampa automatica dell'aiuto.
Tech stack
Nessuno
Dominio
cli
Tipo issue
Bug
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
1
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Meno di 1 ora
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Nuova
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Nessuno
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
80