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 (881 forks)batch import
enhancementhelp wanted

Repository metrics

Stars
 (23,759 stars)
PR merge metrics
 (Avg merge 3d 13h) (4 merged PRs in 30d)

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

Research direction
Review the current shell completion scripts in the repository and understand how they are generated. Then design a testing approach that validates the output of the completion script for various commands and arguments, possibly using a shell testing framework like BATS or shunit2.
Tech stack
goshell
Domain
clitesting
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
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 frameworks
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60