aspiers/stow

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

Open

#126 aberto em 22 de jan. de 2025

Ver no GitHub
 (1 comment) (0 reactions) (0 assignees)Perl (51 forks)batch import
UXeasyhelp wanted

Métricas do repositório

Stars
 (1.013 stars)
Métricas de merge de PR
 (Nenhuma PRs mesclada em 30d)

Description

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

Guia do colaborador

Direção de pesquisa
Localize o arquivo fonte onde a mensagem de erro 'is not a valid directory' está definida e rastreie o caminho do código que imprime a ajuda. Modifique a mensagem e remova a impressão automática da ajuda.
Pilha de tecnologia
None
Domain
cli
Tipo Issue
Bug
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
1
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Menos de 1 hora
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Recente
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
None
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
80