Add description and homepage fields to packages in aqua.yaml

[dudicoco]

Feature Overview

When running aqua g and selecting a package the output could include the description and homepage fields from the package registry.yaml.

This is similar to what brew bundle dump --describe does:

# Official Amazon AWS command-line interface
brew "awscli"
# GitHub command-line tool
brew "gh"
# Distributed revision control system
brew "git"

Why is the feature needed?

It would be helpful to have additional information about the packages within the aqua.yaml config file and a clickable link to their homepages.

Does the feature include Breaking Changes?

Not to my knowledge.

Example Code

The new fields could be added by default, if a new flag is needed then perhaps --description.

$ aqua g --description cli/cli

- name: cli/[email protected]
  description: GitHub’s official command line tool
  homepage: https://github.com/cli/cli

Reference

No response

[suzuki-shunsuke]

Thank you for your proposal. I'm working on this.

• feat: add -detail option to "generate" command #2062

[suzuki-shunsuke]

The prerelease version v2.9.0-2 is out.
https://github.com/aquaproj/aqua/releases/tag/v2.9.0-2

@dudicoco Would you try this when you have time?

$ aqua update-aqua v2.9.0-2

$ aqua g -detail cli/cli
- name: cli/[email protected]
  description: GitHub’s official command line tool
  link: https://github.com/cli/cli

[dudicoco]

Thanks @suzuki-shunsuke, looks great!

[suzuki-shunsuke]

Thank you!
aqua v2.9.0 is out!
https://github.com/aquaproj/aqua/releases/tag/v2.9.0

---

With -detail (-d) option, aqua outputs additional information such as description and link.

$ aqua g -detail cli/cli
- name: cli/[email protected]
  description: GitHub’s official command line tool
  link: https://github.com/cli/cli

The environment variable AQUA_GENERATE_WITH_DETAIL is also available.

export AQUA_GENERATE_WITH_DETAIL=true

[suzuki-shunsuke]

Update the document.
aquaproj/aquaproj.github.io#445