From e81ce2c830b631518b2df3dbea1ef3e3214ff57e Mon Sep 17 00:00:00 2001 From: "Stanislav N. aka pztrn" Date: Sun, 22 Dec 2019 01:29:18 +0500 Subject: [PATCH] Linting. --- README.md | 26 ++++++++++---------------- example/main.go | 2 +- flagger.go | 4 +--- go.mod | 3 +-- go.sum | 2 ++ 5 files changed, 15 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index 9b44c24..184bb95 100644 --- a/README.md +++ b/README.md @@ -1,31 +1,31 @@ -[![GoDoc](https://godoc.org/go.dev.pztrn.name/flagger?status.svg)](https://godoc.org/go.dev.pztrn.name/flagger) [![Drone (self-hosted)](https://img.shields.io/drone/build/libraries/flagger?server=https%3A%2F%2Fci.dev.pztrn.name)](https://ci.dev.pztrn.name/libraries/flagger/) [![Discord](https://img.shields.io/discord/632359730089689128)](https://discord.gg/qHN6KsD) ![Keybase XLM](https://img.shields.io/keybase/xlm/pztrn) [![Go Report Card](https://goreportcard.com/badge/go.dev.pztrn.name/flagger)](https://goreportcard.com/report/go.dev.pztrn.name/flagger) - # Flagger +[![GoDoc](https://godoc.org/go.dev.pztrn.name/flagger?status.svg)](https://godoc.org/go.dev.pztrn.name/flagger) [![Drone (self-hosted)](https://img.shields.io/drone/build/libraries/flagger?server=https%3A%2F%2Fci.dev.pztrn.name)](https://ci.dev.pztrn.name/libraries/flagger/) [![Discord](https://img.shields.io/discord/632359730089689128)](https://discord.gg/qHN6KsD) ![Keybase XLM](https://img.shields.io/keybase/xlm/pztrn) [![Go Report Card](https://goreportcard.com/badge/go.dev.pztrn.name/flagger)](https://goreportcard.com/report/go.dev.pztrn.name/flagger) + Flagger is an arbitrary CLI flags parser, like argparse in Python. Flagger is able to parse boolean, integer and string flags. -# Installation +## Installation -``` +```bash go get -u -v go.dev.pztrn.name/flagger ``` -# Usage +## Usage Flagger requires logging interface to be passed on initialization. See ``loggerinterface.go`` for required logging functions. It is able to run with standart log package, in that case initialize flagger like: -``` +```go flgr = flagger.New("My Super Program", flagger.LoggerInterface(log.New(os.Stdout, "testing logger: ", log.Lshortfile))) flgr.Initialize() ``` Adding a flag is easy, just fill ``Flag`` structure and pass to ``AddFlag()`` call: -``` +```go flag_bool := Flag{ Name: "boolflag", Description: "Boolean flag", @@ -41,23 +41,17 @@ if err != nil { After adding all neccessary flags you should issue ``Parse()`` call to get them parsed: -``` +```go flgr.Parse() ``` After parsed they can be obtained everywhere you want, like: -``` +```go val, err := flgr.GetBoolValue("boolflag") if err != nil { ... } ``` -For more examples take a look at ``flagger_test.go`` file or [at GoDoc](https://godoc.org/gitlab.com/pztrn/flagger). - -# Get help - -If you want to report a bug - feel free to report it via Gitlab's issues system. Note that everything that isn't a bug report or feature request will be closed without any futher comments. - -If you want to request some help (without warranties), propose a feature request or discuss flagger in any way - please use our mailing lists at flagger@googlegroups.com. To be able to send messages there you should subscribe by sending email to ``flagger+subscribe@googlegroups.com``, subject and mail body can be random. \ No newline at end of file +For more examples take a look at ``flagger_test.go`` file or [at GoDoc](https://godoc.org/go.dev.pztrn.name/flagger). diff --git a/example/main.go b/example/main.go index dd00950..d3216cd 100644 --- a/example/main.go +++ b/example/main.go @@ -9,7 +9,7 @@ var f *flagger.Flagger func main() { f = flagger.New("testprogram", nil) f.Initialize() - f.AddFlag(&flagger.Flag{ + _ = f.AddFlag(&flagger.Flag{ Name: "testflag", Description: "Just a test flag", Type: "bool", diff --git a/flagger.go b/flagger.go index 24c71fe..49234ca 100644 --- a/flagger.go +++ b/flagger.go @@ -28,7 +28,6 @@ import ( "errors" "flag" "os" - "sync" ) // Flagger implements (kinda) extended CLI parameters parser. As it @@ -39,8 +38,7 @@ import ( // parse or get. type Flagger struct { // Flags that was added by user. - flags map[string]*Flag - flagsMutex sync.Mutex + flags map[string]*Flag // Flags that will be passed to flag module. flagsBool map[string]*bool diff --git a/go.mod b/go.mod index 96fadfa..0a1e07f 100644 --- a/go.mod +++ b/go.mod @@ -3,7 +3,6 @@ module go.dev.pztrn.name/flagger go 1.13 require ( - github.com/davecgh/go-spew v1.1.1 // indirect - github.com/pmezard/go-difflib v1.0.0 // indirect github.com/stretchr/testify v1.2.2 + gitlab.com/pztrn/flagger v0.0.0-20191015160147-a9ca273d8b73 ) diff --git a/go.sum b/go.sum index e03ee77..b7a9475 100644 --- a/go.sum +++ b/go.sum @@ -4,3 +4,5 @@ github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZb github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= github.com/stretchr/testify v1.2.2 h1:bSDNvY7ZPG5RlJ8otE/7V6gMiyenm9RtJ7IUVIAoJ1w= github.com/stretchr/testify v1.2.2/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs= +gitlab.com/pztrn/flagger v0.0.0-20191015160147-a9ca273d8b73 h1:3wo+sJrNguob5mLnQQmH2/Rh2oCuEhIplgWpAMutFzY= +gitlab.com/pztrn/flagger v0.0.0-20191015160147-a9ca273d8b73/go.mod h1:I+FxZN2hnd4iELlBFizaDD4QJy92x6Ky4+76U7L3gBQ=