bubblecomplete

Bubblecomplete

Bubblecomplete is a command suggestion and autocompletion component for Bubble Tea applications.

Usage

See the example for a full working implementation.

The command structure expects the following:

command [subcommands] [flags] [positionalArguments]

• A command can have multiple subcommands or positional arguments, and flags

  Git can have multiple sub commands such as git commit, git stash and git status

• A command can have subcommands or positional arguments, but not both.

  i.e. the subcommand stash in git stash has more subcommands like git stash pop, git stash apply, etc. but the subcommand push in git push has positional arguments like git push origin main

• Any command or subcommand can have flags.

  Git can have a flag such as --version or a subcommand such as git commit -m "message"

• Any command or subcommand can have both positional arguments and flags.

  Cat expects the positional argument for the file and then flags cat file.txt -n

• The order of positional arguments is important

  cp file.txt destination is different from cp destination file.txt

Setup

Create a slice of bubblecomplete.Command structs to represent the available commands, with bubblecomplete.PositionalArgument structs for any required arguments and bubblecomplete.Flag structs for any flags that can be passed.

var commands = []*bubblecomplete.Command{
	{
		Command:     "cp",
		Description: "Copy files and directories",
		PositionalArguments: []*bubblecomplete.PositionalArgument{
			{
				Name:        "file",
				Description: "File to copy",
				Type:        bubblecomplete.FileDirArgument,
				Required:    true,
			},
			{
				Name:        "destination",
				Description: "Destination to copy the file to",
				Type:        bubblecomplete.DirArgument,
				Required:    true,
			},
		},
		Flags: []*bubblecomplete.Flag{
			{
				ShortFlag:   "-r",
				Description: "Copy directories recursively",
				Type:        bubblecomplete.BoolArgument,
			},
		},
	},
}

Commands

Positional Arguments

Flags

Argument Types

Create a bubblecomplete.Model struct with the commands and set any options you want to set, and assign it to your bubbletea program model.

type model struct {
	bubblecomplete bubblecomplete.Model
}

func createModel() tea.Model {
	bc := bubblecomplete.New(commands, 100)
  bc.HistoryLimit = 50

  m := model{
    bubblecomplete: ac,
  }

	return m
}

func (m model) View() string {
  return m.bubblecomplete.View()
}

Options

Roadmap

• Autocomplete for filepaths
  • Underlined white if part of a valid path
  • Green if full valid path
  • Red if invalid path
• Option to have flags disable other flags if they're mutually exclusive
• Improved documentation comments for public functions and structs
• Wider range of tests for more critical functions, for improved maintainability
• Option to not show the descriptions of the commands, flags etc
• More exposed color options for the completion list, scrolling etc

FAQ

Colors

Bubblecomplete (and Bubble Tea applications in general) work best with a terminal that supports 24-bit color. If you're using a terminal that doesn't support 24-bit color, you may see some odd colors. If you're using a terminal that supports 24-bit color, ensure that it's enabled in your terminal emulator, tmux config (if you're using tmux) etc and that your $TERM environment variable is set to a value that supports 24-bit color (such as xterm-256color) and your $COLORTERM environment variable is set to truecolor.