Apply format set in config file

Author: wata727

cmd/cli.go

@@ -64,6 +64,7 @@ func (cli *CLI) Run(args []string) int {
 	cli.formatter = &formatter.Formatter{
 		Stdout: cli.outStream,
 		Stderr: cli.errStream,
+		// NOTE: The format may be set in config file, but the flag will take precedence until it is loaded.
 		Format: opts.Format,
 		Fix:    opts.Fix,
 	}

cmd/inspect.go

@@ -93,6 +93,8 @@ func (cli *CLI) inspectModule(opts Options, dir string, filterFiles []string) (t
 		return issues, changes, fmt.Errorf("Failed to load TFLint config; %w", err)
 	}
 	cli.config.Merge(opts.toConfig())
+	// Apply format set in config file
+	cli.formatter.Format = cli.config.Format
 
 	// Setup loader
 	cli.loader, err = terraform.NewLoader(afero.Afero{Fs: afero.NewOsFs()}, cli.originalWorkingDir)

cmd/inspect_parallel.go

@@ -90,6 +90,8 @@ func (cli *CLI) inspectParallel(opts Options) int {
 		force = *opts.Force
 	}
 
+	// Parallel inspection ignores the format set in the config file
+	// and the --format CLI flag always takes precedence.
 	if err := cli.formatter.PrintParallel(issues, cli.sources); err != nil {
 		return ExitCodeError
 	}

integrationtest/cli/chdir_format/subdir/.tflint.hcl

@@ -0,0 +1,3 @@
+config {
+  format = "json"
+}

integrationtest/cli/cli_test.go

@@ -50,12 +50,27 @@ func TestIntegration(t *testing.T) {
 			stdout:  "",
 		},
 		{
-			name:    "specify format",
+			name:    "--format option",
 			command: "./tflint --format json",
 			dir:     "no_issues",
 			status:  cmd.ExitCodeOK,
 			stdout:  "[]",
 		},
+		{
+			name:    "format config",
+			command: "./tflint",
+			dir:     "format_config",
+			status:  cmd.ExitCodeOK,
+			stdout: `<?xml version="1.0" encoding="UTF-8"?>
+<checkstyle></checkstyle>`,
+		},
+		{
+			name:    "--format + config",
+			command: "./tflint --format json",
+			dir:     "format_config",
+			status:  cmd.ExitCodeOK,
+			stdout:  "[]",
+		},
 		{
 			name:    "`--force` option with no issues",
 			command: "./tflint --force",
@@ -379,6 +394,13 @@ func TestIntegration(t *testing.T) {
 			status:  cmd.ExitCodeIssuesFound,
 			stdout:  fmt.Sprintf("%s (aws_instance_example_type)", color.New(color.Bold).Sprint("instance type is m5.2xlarge")),
 		},
+		{
+			name:    "--chdir and format config",
+			command: "./tflint --chdir=subdir", // Apply config in subdir
+			dir:     "chdir_format",
+			status:  cmd.ExitCodeOK,
+			stdout:  "[]",
+		},
 		{
 			name:    "invalid max workers",
 			command: "./tflint --max-workers=0",

integrationtest/cli/format_config/.tflint.hcl

@@ -0,0 +1,3 @@
+config {
+  format = "checkstyle"
+}