slick

README

slick: a CI-ready shell language syntax checker

EXAMPLES

$ slick -n examples; echo "$?"
2017/09/14 17:46:09 examples/apples.bash:2:8: arrays are a bash feature
2017/09/14 17:46:09 examples/hello.sh:2:6: reached EOF without closing quote '
1

$ slick -help
  -help
        Show usage information
  -n    Validate syntax
  -version
        Show version information

ABOUT

slick provides an alternative to sh -n, which is problematic for a number of minor reasons:

• sh is hardly ever a bare bones POSIX sh interpreter on most UNIX systems, but usually soft linked to bash, ksh, ash, or even stranger things. So anyone genuinely interested in vetting their #!/bin/sh scripts for compliance risks getting false negative scans for scripts that actually contain bashisms, kshisms, and so on. By contrast, slick guarantees pure POSIX parsing, so that scripts are scanned consistently regardless of the particular environment configuration.
• sh is difficult to obtain in Windows. Cygwin-like environments are themselves difficult to setup. Should a unix, Linux, Windows, or other system desire syntax checking, slick is easy to obtain by gox ports, or through the wonderfully cross-platform Go toolchain.

DOWNLOAD

https://github.com/mcandre/slick/releases

RUNTIME REQUIREMENTS

(None)

BUILDTIME REQUIREMENTS

• Go 1.9+
• Docker
• Mage (e.g., go get github.com/magefile/mage)
• goimports (e.g. go get golang.org/x/tools/cmd/goimports)
• golint (e.g. go get github.com/golang/lint/golint)
• errcheck (e.g. go get github.com/kisielk/errcheck)
• nakedret (e.g. go get github.com/alexkohler/nakedret)
• goxcart (e.g., github.com/mcandre/goxcart/...)
• zipc (e.g. go get github.com/mcandre/zipc/...)

INSTALL FROM REMOTE GIT REPOSITORY

$ go get github.com/mcandre/slick/...

(Yes, include the ellipsis as well, it's the magic Go syntax for downloading, building, and installing all components of a package, including any libraries and command line tools.)

INSTALL FROM LOCAL GIT REPOSITORY

$ mkdir -p "$GOPATH/src/github.com/mcandre"
$ git clone https://github.com/mcandre/slick.git "$GOPATH/src/github.com/mcandre/slick"
$ cd "$GOPATH/src/github.com/mcandre/slick"
$ git submodule update --init --recursive
$ go install ./...

TEST

$ mage test

PORT

$ mage port

LINT

$ mage lint

CREDITS

• mvdan/sh for POSIX sh parsing

Documentation

Index

• Variables

Variables

var Version = "0.0.2"

Version is semver.