Add support for home directory expansion for -c/--config flag

theckman · theckman · commit e7b8fb99996a · 2018-11-14T01:52:31.000-08:00
This change introduces the ability to use the tilde (`~`) character in your `-c/--config` flag value to expand your home directory. If invoking this via the command line with `--config ~/.golangci-lint.yaml`, the user's shell expands the `~` to the home directory. However, if something is invoking the program for you (like an editor) it may not do the expansion. Fixes #289 Signed-off-by: Tim Heckman <t@heckman.io>
diff --git a/go.mod b/go.mod
@@ -45,6 +45,7 @@ require (
 	github.com/magiconair/properties v1.7.6 // indirect
 	github.com/mattn/go-colorable v0.0.9
 	github.com/mattn/go-isatty v0.0.3 // indirect
+	github.com/mitchellh/go-homedir v1.0.0
 	github.com/mitchellh/go-ps v0.0.0-20170309133038-4fdf99ab2936
 	github.com/mitchellh/mapstructure v0.0.0-20180220230111-00c29f56e238 // indirect
 	github.com/nbutton23/zxcvbn-go v0.0.0-20171102151520-eafdab6b0663 // indirect
diff --git a/go.sum b/go.sum
@@ -95,6 +95,8 @@ github.com/mattn/go-colorable v0.0.9 h1:UVL0vNpWh04HeJXV0KLcaT7r06gOH2l4OW6ddYRU
 github.com/mattn/go-colorable v0.0.9/go.mod h1:9vuHe8Xs5qXnSaW/c/ABM9alt+Vo+STaOChaDxuIBZU=
 github.com/mattn/go-isatty v0.0.3 h1:ns/ykhmWi7G9O+8a448SecJU3nSMBXJfqQkl0upE1jI=
 github.com/mattn/go-isatty v0.0.3/go.mod h1:M+lRXTBqGeGNdLjl/ufCoiOlB5xdOkqRJdNxMWT7Zi4=
+github.com/mitchellh/go-homedir v1.0.0 h1:vKb8ShqSby24Yrqr/yDYkuFz8d0WUjys40rvnGC8aR0=
+github.com/mitchellh/go-homedir v1.0.0/go.mod h1:SfyaCUpYCn1Vlf4IUYiD9fPX4A5wJrkLzIz1N1q0pr0=
 github.com/mitchellh/go-ps v0.0.0-20170309133038-4fdf99ab2936 h1:kw1v0NlnN+GZcU8Ma8CLF2Zzgjfx95gs3/GN3vYAPpo=
 github.com/mitchellh/go-ps v0.0.0-20170309133038-4fdf99ab2936/go.mod h1:r1VsdOzOPt1ZSrGZWFoNhsAedKnEd6r9Np1+5blZCWk=
 github.com/mitchellh/mapstructure v0.0.0-20180220230111-00c29f56e238 h1:+MZW2uvHgN8kYvksEN3f7eFL2wpzk0GxmlFsMybWc7E=
diff --git a/pkg/config/reader.go b/pkg/config/reader.go
@@ -11,6 +11,8 @@ import (
 
 	"github.com/golangci/golangci-lint/pkg/fsutils"
 	"github.com/golangci/golangci-lint/pkg/logutils"
+
+	"github.com/mitchellh/go-homedir"
 )
 
 type FileReader struct {
@@ -183,5 +185,10 @@ func (r *FileReader) parseConfigOption() (string, error) {
 		return "", errConfigDisabled
 	}
 
+	configFile, err := homedir.Expand(configFile)
+	if err != nil {
+		return "", fmt.Errorf("failed to expand configuration path")
+	}
+
 	return configFile, nil
 }

-Original file line number
+Diff line change
 	github.com/magiconair/properties v1.7.6 // indirect
 	github.com/mattn/go-colorable v0.0.9
 	github.com/mattn/go-isatty v0.0.3 // indirect
 +	github.com/mitchellh/go-homedir v1.0.0
 	github.com/mitchellh/go-ps v0.0.0-20170309133038-4fdf99ab2936
 	github.com/mitchellh/mapstructure v0.0.0-20180220230111-00c29f56e238 // indirect
 	github.com/nbutton23/zxcvbn-go v0.0.0-20171102151520-eafdab6b0663 // indirect
Original file line number	Diff line number	Diff line change
`@@ -11,6 +11,8 @@ import (`
`11`	`11`
`12`	`12`	`"github.com/golangci/golangci-lint/pkg/fsutils"`
`13`	`13`	`"github.com/golangci/golangci-lint/pkg/logutils"`
	`14`	`+`
	`15`	`+ "github.com/mitchellh/go-homedir"`
`14`	`16`	`)`
`15`	`17`
`16`	`18`	`type FileReader struct {`
`@@ -183,5 +185,10 @@ func (r *FileReader) parseConfigOption() (string, error) {`
`183`	`185`	`return "", errConfigDisabled`
`184`	`186`	`}`
`185`	`187`
	`188`	`+ configFile, err := homedir.Expand(configFile)`
	`189`	`+ if err != nil {`
	`190`	`+ return "", fmt.Errorf("failed to expand configuration path")`
	`191`	`+ }`
	`192`	`+`
`186`	`193`	`return configFile, nil`
`187`	`194`	`}`