package bash

Import Path
	github.com/carapace-sh/carapace/internal/shell/bash (on go.dev)

Dependency Relation
	imports 8 packages, and imported by 3 packages

Involved Source Files

	    action.go
	    patch.go
	  d snippet.go
		Package bash provides bash completion
Package-Level Type Names (only one)

	/* sort by: alphabet | popularity */
	 type RedirectError (struct)
		RedirectError current position is a redirect like `echo test >[TAB]`.

		Methods (only one)
			( RedirectError) Error() string
		Implements (at least one exported)
			 RedirectError : error


Package-Level Functions (total 4)

	 func ActionRawValues(currentWord string, meta common.Meta, values common.RawValues) string
		ActionRawValues formats values for bash.

	 func CompLine() (string, bool)
	 func Patch(args []string) ([]string, error)
		Patch patches args if `COMP_LINE` environment variable is set.
		
		Bash passes redirects to the completion function so these need to be filtered out.
		
			`example action >/tmp/stdout.txt --values 2>/tmp/stderr.txt fi[TAB]`
			["example", "action", ">", "/tmp/stdout.txt", "--values", "2", ">", "/tmp/stderr.txt", "fi"]
			["example", "action", "--values", "fi"]

	 func Snippet(cmd *cobra.Command) string
		Snippet creates the bash completion script.


Package-Level Constants (total 5)

	const COMP_TYPE_LIST_NOT_UNMODIFIED = "64" // ‘@’, to list completions if the word is not unmodified
	const COMP_TYPE_LIST_PARTIAL_WORD = "33" // ‘!’, for listing alternatives on partial word completion,
	const COMP_TYPE_LIST_SUCCESSIVE_TABS = "63" // ‘?’, for listing completions after successive tabs,
	const COMP_TYPE_MENU_COMPLETION = "37" // ‘%’, for menu completion
	const COMP_TYPE_NORMAL = "9" // TAB, for normal completion

The pages are generated with Golds v0.8.2. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @zigo_101 (reachable from the left QR code) to get the latest news of Golds.