hellseher / go-shellquote

Go utilities for performing shell-like word splitting/joining

go-shellquote

This is a clone of the no longer maintaind project go-shellquote, name is kept the same, but import path is altered.

The main purpose is to have features like:

• go.mod
• release or versioned tags
• CI with lint and test
• local lint and test in containers

See:

• kballard#10
• kballard#13
• kballard#5

PACKAGE

package shellquote
    import "github.com/Hellseher/go-shellquote"

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

VARIABLES

var (
    ErrUnterminatedSingleQuote = errors.New("Unterminated single-quoted string")
    ErrUnterminatedDoubleQuote = errors.New("Unterminated double-quoted string")
    ErrUnterminatedEscape      = errors.New("Unterminated backslash-escape")
)

FUNCTIONS

func 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 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 ErrUnterminatedSingleQuote,
    ErrUnterminatedDoubleQuote, or ErrUnterminatedEscape is returned.

go-shellquote's Issues

Go releases require git tags in the format `vX.Y.Z`

Hi!

I was just looking for a modularized version of the shellquote library. How serendipitous that I found your repo so soon after you published it!

I noticed you published a release, tag 0.1.0. However, Go modules require tags to be published in the format v0.0.0 (note the v prefix). If you want to publish the module in a way that is consumable by Go tooling, you should consider tagging with a syntactically valid tag.

Thanks for publishing!