cmd/shfmt: report correct language read from EditorConfig in errors

We had logic to catch mismatching language errors and report what
language was currently being used for parsing, following the -ln flag.

However, this logic completely ignored EditorConfig,
which can also control this behavior via the shell_variant property.
The logic to determine what language to use for parsing was correct,
but the logic to report a reasonable error to the user was not.

Fixes #1102.

Author: mvdan

cmd/shfmt/main.go

@@ -359,9 +359,9 @@ var ecQuery = editorconfig.Query{
 	RegexpCache: make(map[string]*regexp.Regexp),
 }
 
-func propsOptions(lang syntax.LangVariant, props editorconfig.Section) {
+func propsOptions(lang syntax.LangVariant, props editorconfig.Section) (_ syntax.LangVariant, validLang bool) {
 	// if shell_variant is set to a valid string, it will take precedence
-	lang.Set(props.Get("shell_variant"))
+	langErr := lang.Set(props.Get("shell_variant"))
 	syntax.Variant(lang)(parser)
 
 	size := uint(0)
@@ -380,6 +380,8 @@ func propsOptions(lang syntax.LangVariant, props editorconfig.Section) {
 	syntax.KeepPadding(props.Get("keep_padding") == "true")(printer)
 	// TODO(v4): rename to func_next_line for consistency with flags
 	syntax.FunctionNextLine(props.Get("function_next_line") == "true")(printer)
+
+	return lang, langErr == nil
 }
 
 func formatPath(path string, checkShebang bool) error {
@@ -446,12 +448,13 @@ func editorConfigLangs(l syntax.LangVariant) []string {
 }
 
 func formatBytes(src []byte, path string, fileLang syntax.LangVariant) error {
+	fileLangFromEditorConfig := false
 	if useEditorConfig {
 		props, err := ecQuery.Find(path, editorConfigLangs(fileLang))
 		if err != nil {
 			return err
 		}
-		propsOptions(fileLang, props)
+		fileLang, fileLangFromEditorConfig = propsOptions(fileLang, props)
 	} else {
 		syntax.Variant(fileLang)(parser)
 	}
@@ -466,6 +469,9 @@ func formatBytes(src []byte, path string, fileLang syntax.LangVariant) error {
 		node, err = parser.Parse(bytes.NewReader(src), path)
 		if err != nil {
 			if s, ok := err.(syntax.LangError); ok && lang.val == syntax.LangAuto {
+				if fileLangFromEditorConfig {
+					return fmt.Errorf("%w (parsed as %s via EditorConfig)", s, fileLang)
+				}
 				return fmt.Errorf("%w (parsed as %s via -%s=%s)", s, fileLang, lang.short, lang.val)
 			}
 			return err

cmd/shfmt/testdata/script/editorconfig.txtar

@@ -12,13 +12,11 @@ exec shfmt
 
 stdin stdin-filename-bash
 ! exec shfmt -filename=foo_posix.sh
-# TODO: we didn't parse as bash!
-stderr '^foo_posix.sh:.* arrays are a bash.*parsed as bash via -ln=auto'
+stderr '^foo_posix.sh:.* arrays are a bash.*parsed as posix via EditorConfig'
 
 stdin stdin-filename-bash
 ! exec shfmt -filename=${WORK}/foo_posix.sh
-# TODO: we didn't parse as bash!
-stderr ^${WORK@R}/'foo_posix.sh:.* arrays are a bash.*parsed as bash via -ln=auto'
+stderr ^${WORK@R}/'foo_posix.sh:.* arrays are a bash.*parsed as posix via EditorConfig'
 
 # Using a file path should use EditorConfig, including with the use of flags
 # like -l.