Merge pull request #105 from yoheimuta/config_path

Add a config_path flag

README.md

@@ -59,6 +59,7 @@ go get -u -v github.com/yoheimuta/protolint/cmd/protolint
 protolint lint example.proto example2.proto # file mode, specify multiple specific files
 protolint lint .                            # directory mode, search for all .proto files recursively
 protolint .                                 # same as "protolint lint ."
+protolint lint -config_path=path/to/your_protolint.yaml . # use path/to/your_protolint.yaml
 protolint lint -config_dir_path=path/to .   # search path/to for .protolint.yaml
 protolint lint -fix .                       # automatically fix some of the problems reported by some rules
 protolint lint -v .                         # with verbose output to investigate the parsing error
@@ -261,6 +262,7 @@ The built-in reporter options are:
 
 - plain (default)
 - junit
+- json
 - unix
 
 ## Configuring
@@ -297,6 +299,7 @@ Refer to [_example/config/.protolint.yaml](_example/config/.protolint.yaml) for
 
 protolint will search a current working directory for the config file by default.
 And it can search the specified directory with `-config_dir_path` flag.
+It can also search the specified file with `--config_path` flag.
 
 ## Motivation
 

internal/cmd/protocgenprotolint/cmd.go

@@ -90,6 +90,11 @@ func newFlags(
 		switch params[0] {
 		case "":
 			continue
+		case "config_path":
+			if len(params) != 2 {
+				return nil, fmt.Errorf("config_path should be specified")
+			}
+			flags.ConfigDirPath = params[1]
 		case "config_dir_path":
 			if len(params) != 2 {
 				return nil, fmt.Errorf("config_dir_path should be specified")

internal/cmd/subcmds/lint/cmdLint.go

@@ -34,7 +34,7 @@ func NewCmdLint(
 		return nil, err
 	}
 
-	externalConfig, err := config.GetExternalConfig(flags.ConfigDirPath)
+	externalConfig, err := config.GetExternalConfig(flags.ConfigPath, flags.ConfigDirPath)
 	if err != nil {
 		return nil, err
 	}

internal/cmd/subcmds/lint/flags.go

@@ -17,6 +17,7 @@ type Flags struct {
 	*flag.FlagSet
 
 	FilePaths      []string
+	ConfigPath     string
 	ConfigDirPath  string
 	FixMode        bool
 	Reporter       report.Reporter
@@ -36,11 +37,17 @@ func NewFlags(
 	var rf reporterFlag
 	var pf subcmds.PluginFlag
 
+	f.StringVar(
+		&f.ConfigPath,
+		"config_path",
+		"",
+		"path/to/protolint.yaml. Note that if both are set, config_dir_path is ignored.",
+	)
 	f.StringVar(
 		&f.ConfigDirPath,
 		"config_dir_path",
 		"",
-		"path/to/protolint.yaml",
+		"path/to/the_directory_including_protolint.yaml",
 	)
 	f.BoolVar(
 		&f.FixMode,
@@ -51,7 +58,7 @@ func NewFlags(
 	f.Var(
 		&rf,
 		"reporter",
-		`formatter to output results in the specific format. Available reporters are "plain"(default), "junit", and "unix".`,
+		`formatter to output results in the specific format. Available reporters are "plain"(default), "junit", "json", and "unix".`,
 	)
 	f.StringVar(
 		&f.OutputFilePath,

internal/cmd/subcmds/lint/reporterFlag.go

@@ -41,5 +41,5 @@ func GetReporter(value string) (report.Reporter, error) {
 	if r, ok := rs[value]; ok {
 		return r, nil
 	}
-	return nil, fmt.Errorf(`available reporters are "plain", "junit", and "unix"`)
+	return nil, fmt.Errorf(`available reporters are "plain", "junit", "json", and "unix"`)
 }

internal/linter/config/externalConfigProvider.go

@@ -15,9 +15,10 @@ const (
 
 // GetExternalConfig provides the externalConfig.
 func GetExternalConfig(
+	filePath string,
 	dirPath string,
 ) (ExternalConfig, error) {
-	filePath, err := getExternalConfigPath(dirPath)
+	filePath, err := getExternalConfigPath(filePath, dirPath)
 	if err != nil {
 		return ExternalConfig{}, err
 	}
@@ -42,8 +43,12 @@ func GetExternalConfig(
 }
 
 func getExternalConfigPath(
+	filePath string,
 	dirPath string,
 ) (string, error) {
+	if 0 < len(filePath) {
+		return filePath, nil
+	}
 	for _, name := range []string{
 		externalConfigFileName,
 		externalConfigFileName2,

internal/linter/config/externalConfigProvider_test.go

@@ -75,7 +75,7 @@ func TestGetExternalConfig(t *testing.T) {
 	} {
 		test := test
 		t.Run(test.name, func(t *testing.T) {
-			got, err := config.GetExternalConfig(test.inputDirPath)
+			got, err := config.GetExternalConfig("", test.inputDirPath)
 			if test.wantExistErr {
 				if err == nil {
 					t.Errorf("got err nil, but want err")