asdf-vm/asdf

Write automated tests for shell completions

Open

#2,042 opened on Mar 25, 2025

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Go (23,759 stars) (881 forks)batch import
enhancementhelp wanted

Description

Is your feature request related to a problem? Please describe

We often receive reports of broken shell completions, and I've accidentally shipped bad changes to shell completions a couple times.

Describe the proposed solution

I would like automated tests for our shell completions scripts as described here: https://github.com/asdf-vm/asdf/pull/1933#issuecomment-2650748621

Describe similar asdf features and why they are not sufficient

Describe other workarounds you've considered

Contributor guide

Tech stack
shell
Domain
testing
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
shell scriptingtesting basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80
Research direction
Refer to the comment in PR #1933 (https://github.com/asdf vm/asdf/pull/1933#issuecomment 2650748621) for a suggested approach to writing automated tests for shell completions. Investigate how to set up a test runner and write test cases for the shell completion scripts in the repository. Consider using existing testing utilities in the project and ensure compatibility with different shells.