Skip to content

refactor: rename args -> parameters, resolve -> configure - #442

Open
awphi wants to merge 3 commits into
mainfrom
args-to-parameters
Open

refactor: rename args -> parameters, resolve -> configure#442
awphi wants to merge 3 commits into
mainfrom
args-to-parameters

Conversation

@awphi

@awphi awphi commented Sep 4, 2026

Copy link
Copy Markdown
Contributor

Changes

Attempts to have a stronger opinion about naming in the paramaterisation bit of the codebase as it's quite muddy atm (e.g. many uses of the term 'resolved', lots of references to 'args'/'arguments' which we don't use anymore):

  • Renamed the internal package from arguments to parameter. The singular gives its exports more natural names i.e. "parameter provider", "parameter values"
  • Replaced argument terminology with Definition, Values, and parameter-focused errors. This ditches one use of the term 'resolved'. Values is a simplification that avoids the conversion from map->array->map we had before.
  • Kept “args” only for CLI arguments and Docker build.args.
  • Renamed the overall workflow to project.Configure, ditching one usage of the word 'resolve'/'resolved'
  • Replaced ambiguous “resolved” checks in the strict provider chain with hasValue et al. Ditches the final use of 'resolved'

Big PR I know but it's almost pure renaming and split up by commit fairly well imo. Please push back if you start reviewing and disagree!

Checklist

  • 🤖 This change is covered by tests as required.
  • 🤹 All required manual testing has been performed.
  • 📖 All documentation updates are complete.

@awphi
awphi requested a review from a team as a code owner September 4, 2026 16:25
Signed-off-by: awphi <26072111+awphi@users.noreply.github.com>
Signed-off-by: awphi <26072111+awphi@users.noreply.github.com>
Signed-off-by: awphi <26072111+awphi@users.noreply.github.com>
@awphi
awphi force-pushed the args-to-parameters branch from 72762f8 to b716089 Compare September 4, 2026 16:26
return &CLIProvider{input: parsed}, nil
}

func (p *CLIProvider) Provide(args []Arg) ([]ResolvedArg, error) {

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure if we should rename the package. We should definitely update the signatures though.

Providers are responsible for turning params into args:

func (p *CLIProvider) Provide(params []Param) ([]Arg, error) {

Frankly, I'd rather the package was still arguments, not parameters. I.e.: named after what it provides, not what it takes as an argument.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants