gg_shellquote

README

ShellQuote

ShellQuote provides utilities for joining/splitting strings using sh's word-splitting rules.

Functions:

• Join: quote and join with spaces
• Split: splits a string according to /bin/sh's word-splitting rules.

This package has been forked from the original work of Kevin Ballard: https://github.com/kballard/go-shellquote

Documentation

Index

• Variables
• type ShellQuoteHelper
  • func (instance *ShellQuoteHelper) Join(args ...string) string
  • func (instance *ShellQuoteHelper) Split(input string) (words []string, err error)

Variables

var (
	UnterminatedSingleQuoteError = errors.New("Unterminated single-quoted string")
	UnterminatedDoubleQuoteError = errors.New("Unterminated double-quoted string")
	UnterminatedEscapeError      = errors.New("Unterminated backslash-escape")
)

Types

type ShellQuoteHelper

type ShellQuoteHelper struct {
}

var ShellQuote *ShellQuoteHelper

func (*ShellQuoteHelper) Join

func (instance *ShellQuoteHelper) Join(args ...string) string

Join quotes each argument and joins them with a space. If passed to /bin/sh, the resulting string will be split back into the original arguments.

func (*ShellQuoteHelper) Split

func (instance *ShellQuoteHelper) Split(input string) (words []string, err error)

Split splits a string according to /bin/sh's word-splitting rules. It supports backslash-escapes, single-quotes, and double-quotes. Notably it does not support the $” style of quoting. It also doesn't attempt to perform any other sort of expansion, including brace expansion, shell expansion, or pathname expansion.

If the given input has an unterminated quoted string or ends in a backslash-escape, one of UnterminatedSingleQuoteError, UnterminatedDoubleQuoteError, or UnterminatedEscapeError is returned.