Merge pull request #1 from SVilgelm/the-code

The Code

Author: SVilgelm

.github/Brewfile

@@ -1,5 +1,4 @@
 tap "golangci/tap"
-tap "vektra/tap"
 tap "kyoh86/tap"
 tap "sonatype-nexus-community/nancy-tap"
 tap "sv-tools/apps"
@@ -13,7 +12,5 @@ brew "kyoh86/tap/richgo"
 brew "sonatype-nexus-community/nancy-tap/nancy"
 # bumptag is a tool to increment a version and to create a git tag with an annotation.
 brew "sv-tools/apps/bumptag"
-# A mock code autogenerator for Go
-brew "vektra/tap/mockery"
 # Deliver Go binaries as fast and easily as possible
 brew "goreleaser/tap/goreleaser"

.github/Dockerfile

@@ -1,9 +1,9 @@
-project_name: go-repo-template
+project_name: conf-reader-flags
 
 release:
   github:
     owner: sv-tools
-    name: go-repo-template
+    name: conf-reader-flags
 
 builds:
   - skip: true

.github/goreleaser-cli.yml

@@ -11,7 +11,7 @@ on:
     - cron: "0 0 * * 0"
 
 env:
-  GO: 1.16
+  GO: 1.17
 
 jobs:
   CodeQL:

.github/goreleaser-lib.yml

@@ -8,7 +8,7 @@ on:
       - "v[0-9]+.[0-9]+.[0-9]+"
 
 env:
-  GO: 1.16
+  GO: 1.17
 
 jobs:
   bump-version:
@@ -45,62 +45,6 @@ jobs:
           token: "${{ secrets.GITHUB_TOKEN }}"
           title: Next
 
-  release-cli:
-    if: github.event_name == 'push'
-    runs-on: ubuntu-latest
-    env:
-      DOCKER_CLI_EXPERIMENTAL: "enabled"
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v2
-
-      - name: Install Go
-        uses: actions/setup-go@v2
-        with:
-          go-version: ${{ env.GO }}
-
-      - name: Prepare gpg
-        run: |
-          gpgconf --kill gpg-agent
-          gpg --quiet --batch --yes --decrypt --passphrase="${{ secrets.GPG_PASSPHRASE }}" --output .github/sv-tools-bot.asc .github/sv-tools-bot.asc.gpg
-          gpg --batch --yes --import .github/sv-tools-bot.asc
-          rm .github/sv-tools-bot.asc
-
-      - name: Allow arm Docker builds # https://github.com/linuxkit/linuxkit/tree/master/pkg/binfmt
-        run: sudo docker run --privileged linuxkit/binfmt:v0.8
-
-      - name: Docker Login
-        uses: docker/login-action@v1
-        with:
-          registry: ghcr.io
-          username: sv-tools-bot
-          password: ${{ secrets.BOT_TOKEN }}
-
-      - name: Docker Login
-        uses: docker/login-action@v1
-        with:
-          username: svtools
-          password: ${{ secrets.DOCKER_HUB_TOKEN }}
-
-      - name: Snapcraft Login
-        env:
-          SNAPCRAFT_LOGIN: ${{ secrets.SNAPCRAFT_LOGIN }}
-        run: |
-          sudo apt-get -yq --no-install-suggests --no-install-recommends install snapcraft
-          snapcraft login --with <(echo "$SNAPCRAFT_LOGIN")
-
-      - name: Run GoReleaser
-        uses: goreleaser/goreleaser-action@v2
-        with:
-          version: latest
-          args: release --rm-dist --config .github/goreleaser-cli.yml
-        env:
-          GITHUB_TOKEN: ${{ secrets.BOT_TOKEN }}
-
-      - name: Clear
-        if: always()
-        run: rm -f ${HOME}/.docker/config.json
-
   release-lib:
     if: github.event_name == 'push'
     runs-on: ubuntu-latest

.github/workflows/checks.yaml

@@ -45,7 +45,7 @@ linters-settings:
     disable:
       - shadow
   gci:
-    local-prefixes: github.com/sv-tools/go-repo-template
+    local-prefixes: github.com/sv-tools/conf-reader-flags
   gocognit:
     min-complexity: 15
   gocyclo:

.github/workflows/release.yaml

@@ -1,42 +1,11 @@
-# go-repo-template
+# conf-reader-flags
 
-[![Code Analysis](https://github.com/sv-tools/go-repo-template/actions/workflows/checks.yaml/badge.svg)](https://github.com/sv-tools/go-repo-template/actions/workflows/checks.yaml)
-[![Go Reference](https://pkg.go.dev/badge/github.com/sv-tools/go-repo-template.svg)](https://pkg.go.dev/github.com/sv-tools/go-repo-template)
-[![codecov](https://codecov.io/gh/sv-tools/go-repo-template/branch/main/graph/badge.svg?token=0XVOTDR1CW)](https://codecov.io/gh/sv-tools/go-repo-template)
-[![GitHub tag (latest SemVer)](https://img.shields.io/github/v/tag/sv-tools/go-repo-template?style=flat)](https://github.com/sv-tools/go-repo-template/releases)
-
-The template for new go repositories
-
-## Features
-
-1. `Makefile` to run some basic validations:
-   1. `golangci-lint`
-   2. `nancy`
-   3. unit and benchmarks tests
-   4. installing all needed tools on macOS using `brew`
-   5. cleaning up the `go.sum` file by removing it and re-creating by `go mod tidy`
-2. MIT License by default
-3. Github Action workflows:
-   1. testing all pull requests by running same tools and checking code coverage using `codecov` action
-   2. making a new release, triggered by closed milestone
-      1. creates a new tag using `bumptag` tool
-      2. creates new `Next` milestone
-      3. runs `goreleaser` to build a new release
-
-## Usage
-
-1. Create a repository using this repo as template
-2. Replace in all files `go-repo-template` to the project's name
-3. In case of:
-   1. library
-       1. Remove `.github/Dockerfile`, `.github/goreleaser-cli.yml` files
-       2. Remove `release-cli` section in the `.github/workflows/release.yaml` file
-   2. command line tool (cli)
-      1. Remove `.github/goreleaser-lib.yml` file
-      2. Remove `release-lib` section in the `.github/workflows/release.yaml` file
-4. Modify `README.md` by removing this text
-5. Feel free to modify any other files
+[![Code Analysis](https://github.com/sv-tools/conf-reader-flags/actions/workflows/checks.yaml/badge.svg)](https://github.com/sv-tools/conf-reader-flags/actions/workflows/checks.yaml)
+[![Go Reference](https://pkg.go.dev/badge/github.com/sv-tools/conf-reader-flags.svg)](https://pkg.go.dev/github.com/sv-tools/conf-reader-flags)
+[![codecov](https://codecov.io/gh/sv-tools/conf-reader-flags/branch/main/graph/badge.svg?token=0XVOTDR1CW)](https://codecov.io/gh/sv-tools/conf-reader-flags)
+[![GitHub tag (latest SemVer)](https://img.shields.io/github/v/tag/sv-tools/conf-reader-flags?style=flat)](https://github.com/sv-tools/conf-reader-flags/releases)
 
+The [conf](https://github.com/sv-tools/conf) reader for Command Line Flags.
 
 ## License
 

.golangci.yml

@@ -1,3 +1,16 @@
-module github.com/sv-tools/go-repo-template
+module github.com/sv-tools/conf-reader-flags
 
-go 1.16
+go 1.17
+
+require (
+	github.com/spf13/pflag v1.0.5
+	github.com/stretchr/testify v1.7.0
+	github.com/sv-tools/conf v1.2.0
+)
+
+require (
+	github.com/davecgh/go-spew v1.1.1 // indirect
+	github.com/pmezard/go-difflib v1.0.0 // indirect
+	github.com/spf13/cast v1.4.1 // indirect
+	gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c // indirect
+)

README.md

@@ -0,0 +1,19 @@
+github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
+github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
+github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
+github.com/spf13/cast v1.4.1 h1:s0hze+J0196ZfEMTs80N7UlFt0BDuQ7Q+JDnHiMWKdA=
+github.com/spf13/cast v1.4.1/go.mod h1:Qx5cxh0v+4UWYiBimWS+eyWzqEqokIECu5etghLkUJE=
+github.com/spf13/pflag v1.0.5 h1:iy+VFUOCP1a+8yFto/drg2CJ5u0yRoB7fZw3DKv/JXA=
+github.com/spf13/pflag v1.0.5/go.mod h1:McXfInJRrz4CZXVZOBLb0bTZqETkiAhM9Iw0y3An2Bg=
+github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
+github.com/stretchr/testify v1.2.2/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs=
+github.com/stretchr/testify v1.7.0 h1:nwc3DEeHmmLAfoZucVR881uASk0Mfjw8xYJ99tb5CcY=
+github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
+github.com/sv-tools/conf v1.2.0 h1:wnY7DVMopQxY8tI8dEYI9KV24f+32iPvAcmOZtHmMdQ=
+github.com/sv-tools/conf v1.2.0/go.mod h1:JXH0HRFlTwyvLPr0IbD3CNHdp9oiQujuj+iIuYdRkmQ=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
+gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c h1:dUUwHk2QECo/6vqA44rthZ8ie2QXMNeKRTHCNY2nXvo=
+gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

go.mod

@@ -0,0 +1,43 @@
+package confflags
+
+import (
+	"context"
+
+	"github.com/spf13/pflag"
+	"github.com/sv-tools/conf"
+)
+
+type flagReader struct {
+	mapFlagKey map[string]string
+	flagSet    *pflag.FlagSet
+	prefix     string
+}
+
+func (r *flagReader) Prefix() string {
+	return r.prefix
+}
+
+func (r *flagReader) Read(ctx context.Context) (interface{}, error) {
+	res := map[string]string{}
+	for name, key := range r.mapFlagKey {
+		if fl := r.flagSet.Lookup(name); fl != nil {
+			res[key] = fl.Value.String()
+		}
+	}
+
+	return res, ctx.Err()
+}
+
+// New creates the Env reader
+//   `mapFlagKey` is a map of the names of the flag and the configuration keys
+//   `prefix` is a default prefix that will be added to all configuration keys
+func New(mapFlagKey map[string]string, prefix string, flagSet *pflag.FlagSet) conf.Reader {
+	if flagSet == nil {
+		flagSet = pflag.CommandLine
+	}
+	return &flagReader{
+		mapFlagKey: mapFlagKey,
+		prefix:     prefix,
+		flagSet:    flagSet,
+	}
+}