Bug#1031634: ITP: gum -- A tool for glamourous shell scripts
On Wed, Feb 22, 2023 at 03:33:15PM -0700, Sam Hartman wrote: > >> A tool for glamorous shell scripts. Leverage the power of > >> Bubbles (https://github.com/charmbracelet/bubbles) and Lip Gloss > >> (https://github.com/charmbracelet/lipgloss) in your scripts and > >> aliases without writing any Go code! . Tutorial . Gum > >> provides highly configurable, ready-to-use utilities to help you > >> write useful shell scripts and dotfiles aliases with just a few > >> lines of code. > > Antonio> This last paragraph above looks like a good enough package > Antonio> description. Save everything else for an upstream README > Antonio> installed on /usr/share/doc/gum/, or some other type of > Antonio> documentation. > > I disagree. > I should not have to chase down links to websites to understand a > description > Please include a phrase or two describing each of bubbles and gloss. I meant only the part that starts with "Gum provides highly-configurable ..." signature.asc Description: PGP signature
Bug#1031634: ITP: gum -- A tool for glamourous shell scripts
* Sam Hartman [2023-02-22 23:33]: [...] > >> A tool for glamorous shell scripts. Leverage the power of > >> Bubbles (https://github.com/charmbracelet/bubbles) and Lip > >> Gloss (https://github.com/charmbracelet/lipgloss) in your > >> scripts and aliases without writing any Go code! [...] > >> Gum provides highly configurable, ready-to-use utilities to > >> help you write useful shell scripts and dotfiles aliases > >> with just a few lines of code. > > Antonio> This last paragraph above looks like a good enough package > Antonio> description. Save everything else for an upstream README > Antonio> installed on /usr/share/doc/gum/, or some other type of > Antonio> documentation. > > I disagree. With what? Antonio said "last paragraph". The links to Bubbles and Lip Gloss are not in the last paragraph. The last paragraph does look alright to me, if a bit vague on what kind of utilities, so a brief description of Bubbles and Lip Gloss does seem useful to add. > I should not have to chase down links to websites to understand a > description No disagreement there. > Please include a phrase or two describing each of bubbles and gloss. No disagreement there -- if they are mentioned in the description. - FC
Bug#1031634: ITP: gum -- A tool for glamourous shell scripts
> "Antonio" == Antonio Terceiro writes: Antonio> On Wed, Feb 22, 2023 at 09:24:29AM -0700, Scarlett Moore wrote: >> >> On 2/21/23 15:03, Ryan Kavanagh wrote: >> > On Sun, Feb 19, 2023 at 09:01:56AM -0700, Scarlett Moore wrote: >> > > Description : A tool for glamourous shell scripts >> > > >> > > A tool for glamorous shell scripts. Leverage the power of >> Bubbles and > > Lip Gloss in your scripts and aliases without >> writing any Go code! > This long description does not provide >> users with enough information to > understand what the package >> does. What are "Bubbles" and "Lip Gloss" in > a shell script? >> What is a "glamourous shell script"? >> > >> > It would be helpful if the package's long description satisfied >> §3.4.2 > of the Debian Policy Manual [0]: >> > >> > The description field needs to make sense to anyone, even >> people who > have no idea about any of the things the package >> deals with. [3] >> > >> > [...] >> > >> > [3] The blurb that comes with a program in its announcements >> and/or > README files is rarely suitable for use in a >> description. It is > usually aimed at people who are already in >> the community where the > package is used. >> > >> > Best wishes, > Ryan >> > >> > [0] >> https://www.debian.org/doc/debian-policy/ch-binary.html#the-extended-description >> > >> >> The package description will be this or close to it: Antonio> That is just too long, please don't. >> A tool for glamorous shell scripts. Leverage the power of >> Bubbles (https://github.com/charmbracelet/bubbles) and Lip Gloss >> (https://github.com/charmbracelet/lipgloss) in your scripts and >> aliases without writing any Go code! . Tutorial . Gum >> provides highly configurable, ready-to-use utilities to help you >> write useful shell scripts and dotfiles aliases with just a few >> lines of code. Antonio> This last paragraph above looks like a good enough package Antonio> description. Save everything else for an upstream README Antonio> installed on /usr/share/doc/gum/, or some other type of Antonio> documentation. I disagree. I should not have to chase down links to websites to understand a description Please include a phrase or two describing each of bubbles and gloss.
Bug#1031634: ITP: gum -- A tool for glamourous shell scripts
On Wed, Feb 22, 2023 at 09:24:29AM -0700, Scarlett Moore wrote: > > On 2/21/23 15:03, Ryan Kavanagh wrote: > > On Sun, Feb 19, 2023 at 09:01:56AM -0700, Scarlett Moore wrote: > > >Description : A tool for glamourous shell scripts > > > > > > A tool for glamorous shell scripts. Leverage the power of Bubbles and > > > Lip Gloss in your scripts and aliases without writing any Go code! > > This long description does not provide users with enough information to > > understand what the package does. What are "Bubbles" and "Lip Gloss" in > > a shell script? What is a "glamourous shell script"? > > > > It would be helpful if the package's long description satisfied §3.4.2 > > of the Debian Policy Manual [0]: > > > > The description field needs to make sense to anyone, even people who > > have no idea about any of the things the package deals with. [3] > > > > [...] > > > > [3] The blurb that comes with a program in its announcements and/or > > README files is rarely suitable for use in a description. It is > > usually aimed at people who are already in the community where the > > package is used. > > > > Best wishes, > > Ryan > > > > [0] > > https://www.debian.org/doc/debian-policy/ch-binary.html#the-extended-description > > > > The package description will be this or close to it: That is just too long, please don't. > A tool for glamorous shell scripts. Leverage the power of Bubbles > (https://github.com/charmbracelet/bubbles) and Lip Gloss > (https://github.com/charmbracelet/lipgloss) in your scripts and aliases > without writing any Go code! > . > Tutorial > . > Gum provides highly configurable, ready-to-use utilities to help you write > useful shell scripts and dotfiles aliases with just a few lines of code. This last paragraph above looks like a good enough package description. Save everything else for an upstream README installed on /usr/share/doc/gum/, or some other type of documentation. https://www.debian.org/doc/debian-policy/ch-binary.html#s-descriptions signature.asc Description: PGP signature
Bug#1031634: ITP: gum -- A tool for glamourous shell scripts
On 2/21/23 15:03, Ryan Kavanagh wrote: On Sun, Feb 19, 2023 at 09:01:56AM -0700, Scarlett Moore wrote: Description : A tool for glamourous shell scripts A tool for glamorous shell scripts. Leverage the power of Bubbles and Lip Gloss in your scripts and aliases without writing any Go code! This long description does not provide users with enough information to understand what the package does. What are "Bubbles" and "Lip Gloss" in a shell script? What is a "glamourous shell script"? It would be helpful if the package's long description satisfied §3.4.2 of the Debian Policy Manual [0]: The description field needs to make sense to anyone, even people who have no idea about any of the things the package deals with. [3] [...] [3] The blurb that comes with a program in its announcements and/or README files is rarely suitable for use in a description. It is usually aimed at people who are already in the community where the package is used. Best wishes, Ryan [0] https://www.debian.org/doc/debian-policy/ch-binary.html#the-extended-description The package description will be this or close to it: A tool for glamorous shell scripts. Leverage the power of Bubbles (https://github.com/charmbracelet/bubbles) and Lip Gloss (https://github.com/charmbracelet/lipgloss) in your scripts and aliases without writing any Go code! . Tutorial . Gum provides highly configurable, ready-to-use utilities to help you write useful shell scripts and dotfiles aliases with just a few lines of code. . Let's build a simple script to help you write Conventional Commits (https://www.conventionalcommits.org/en/v1.0.0/#summary) for your dotfiles. . Start with a #!/bin/sh. . #!/bin/sh . Ask for the commit type with gum choose: . gum choose "fix" "feat" "docs" "style" "refactor" "test" "chore" "revert" . | Tip: this command itself will print to stdout which is not all that | useful. | To make use of the command later on you can save the stdout to a | $VARIABLE or | file.txt. . Prompt for an (optional) scope for the commit: . gum input --placeholder "scope" . Prompt for a commit message: . gum input --placeholder "Summary of this change" . Prompt for a detailed (multi-line) explanation of the changes: . gum write --placeholder "Details of this change (CTRL+D to finish)" . Prompt for a confirmation before committing: . | gum confirm exits with status 0 if confirmed and status 1 if cancelled. . gum confirm "Commit changes?" && git commit -m "$SUMMARY" -m "$DESCRIPTION" . Putting it all together... . #!/bin/sh TYPE=$(gum choose "fix" "feat" "docs" "style" "refactor" "test" "chore" "revert") SCOPE=$(gum input --placeholder "scope") . # Since the scope is optional, wrap it in parentheses if it has a value. test -n "$SCOPE" && SCOPE="($SCOPE)" . # Pre-populate the input with the type(scope): so that the user may change it SUMMARY=$(gum input --value "$TYPE$SCOPE: " --placeholder "Summary of this change") DESCRIPTION=$(gum write --placeholder "Details of this change (CTRL+D to finish)") . # Commit these changes gum confirm "Commit changes?" && git commit -m "$SUMMARY" -m "$DESCRIPTION" . Customization . gum is designed to be embedded in scripts and supports all sorts of use cases. Components are configurable and customizable to fit your theme and use case. . You can customize with --flags. See gum --help for a full view of each command's customization and configuration options. . For example, let's use an input and change the cursor color, prompt color, prompt indicator, placeholder text, width, and pre-populate the value: . gum input --cursor.foreground "#FF0" --prompt.foreground "#0FF" --prompt "* " \ --placeholder "What's up?" --width 80 --value "Not much, hby?" . You can also use ENVIRONMENT_VARIABLES to customize gum by default, this is useful to keep a consistent theme for all your gum commands. . export GUM_INPUT_CURSOR_FOREGROUND="#FF0" export GUM_INPUT_PROMPT_FOREGROUND="#0FF" export GUM_INPUT_PLACEHOLDER="What's up?" export GUM_INPUT_PROMPT="* " export GUM_INPUT_WIDTH=80 . # Uses values configured through environment variables above but can still be # overridden with flags. gum input . Input . Prompt for input with a simple command. . gum input > answer.txt . Prompt for sensitive input with the --password flag. . gum input --password > password.txt . Write . Prompt for some multi-line text. . Note: CTRL+D and esc are used to complete text entry. CTRL+C will cancel. . gum write > story.txt . Filter . Use fuzzy matching to filter a list of values: . echo Strawberry >> flavors.txt echo Banana >> flavors.txt echo Cherry >> flavors.txt cat flavors.txt | gum filter > selection.txt . . You can also select multiple items with the --limit flag, which determines the maximum number of it
Bug#1031634: ITP: gum -- A tool for glamourous shell scripts
On Tue, Feb 21, 2023, 3:12 PM Ryan Kavanagh wrote: > On Sun, Feb 19, 2023 at 09:01:56AM -0700, Scarlett Moore wrote: > > Description : A tool for glamourous shell scripts > > > > A tool for glamorous shell scripts. Leverage the power of Bubbles and > > Lip Gloss in your scripts and aliases without writing any Go code! > > This long description does not provide users with enough information to > understand what the package does. What are "Bubbles" and "Lip Gloss" in > a shell script? What is a "glamourous shell script"? > > It would be helpful if the package's long description satisfied §3.4.2 > of the Debian Policy Manual [0]: > > The description field needs to make sense to anyone, even people who > have no idea about any of the things the package deals with. [3] > > [...] > > [3] The blurb that comes with a program in its announcements and/or > README files is rarely suitable for use in a description. It is > usually aimed at people who are already in the community where the > package is used. > > Best wishes, > Ryan > > [0] > https://www.debian.org/doc/debian-policy/ch-binary.html#the-extended-description > > -- > |)|/ Ryan Kavanagh | 4E46 9519 ED67 7734 268F > |\|\ https://rak.ac | BD95 8F7B F8FC 4A11 C97A > Yes sorry. I will update this description to a much more useful description tomorrow. Thanks, Scarlett
Bug#1031634: ITP: gum -- A tool for glamourous shell scripts
On Sun, Feb 19, 2023 at 09:01:56AM -0700, Scarlett Moore wrote: > Description : A tool for glamourous shell scripts > > A tool for glamorous shell scripts. Leverage the power of Bubbles and > Lip Gloss in your scripts and aliases without writing any Go code! This long description does not provide users with enough information to understand what the package does. What are "Bubbles" and "Lip Gloss" in a shell script? What is a "glamourous shell script"? It would be helpful if the package's long description satisfied §3.4.2 of the Debian Policy Manual [0]: The description field needs to make sense to anyone, even people who have no idea about any of the things the package deals with. [3] [...] [3] The blurb that comes with a program in its announcements and/or README files is rarely suitable for use in a description. It is usually aimed at people who are already in the community where the package is used. Best wishes, Ryan [0] https://www.debian.org/doc/debian-policy/ch-binary.html#the-extended-description -- |)|/ Ryan Kavanagh | 4E46 9519 ED67 7734 268F |\|\ https://rak.ac | BD95 8F7B F8FC 4A11 C97A signature.asc Description: PGP signature
Bug#1031634: ITP: gum -- A tool for glamourous shell scripts
Hello Scarlett, Scarlett Moore dijo [Sun, Feb 19, 2023 at 09:01:56AM -0700]: > Package: wnpp > Severity: wishlist > Owner: Scarlett Moore > X-Debbugs-Cc: debian-de...@lists.debian.org, sgmo...@debian.org > > * Package name: gum > Version : 0.9.0 > Upstream Author : Charmbracelet Inc. > * URL : https://github.com/charmbracelet/gum > * License : MIT > Programming Lang: Golang > Description : A tool for glamourous shell scripts > > A tool for glamorous shell scripts. Leverage the power of Bubbles and > Lip Gloss in your scripts and aliases without writing any Go code! I urge you to use a clearer explanation for the Description field -- The short description is fine,but the long description leaves me scratching my head. Bubbles and Lip Gloss? Never heard of them. Bash supports aliases, why the need to pull in Go? etc. Thanks,
Bug#1031634: ITP: gum -- A tool for glamourous shell scripts
Package: wnpp Severity: wishlist Owner: Scarlett Moore X-Debbugs-Cc: debian-de...@lists.debian.org, sgmo...@debian.org * Package name: gum Version : 0.9.0 Upstream Author : Charmbracelet Inc. * URL : https://github.com/charmbracelet/gum * License : MIT Programming Lang: Golang Description : A tool for glamourous shell scripts A tool for glamorous shell scripts. Leverage the power of Bubbles and Lip Gloss in your scripts and aliases without writing any Go code! I will maintain.
