Add support for --language-dialect shfmt option

Language dialect is something that can be set via `.editorconfig`, so
we'll need to respect that when running `shfmt`.

Author: chris-reeves

server/src/__tests__/config.test.ts

@@ -18,6 +18,7 @@ describe('ConfigSchema', () => {
           "caseIndent": false,
           "funcNextLine": false,
           "keepPadding": false,
+          "languageDialect": "auto",
           "path": "shfmt",
           "simplifyCode": false,
           "spaceRedirects": false,
@@ -39,6 +40,7 @@ describe('ConfigSchema', () => {
           caseIndent: true,
           funcNextLine: true,
           keepPadding: true,
+          languageDialect: 'posix',
           path: 'myshfmt',
           simplifyCode: true,
           spaceRedirects: true,
@@ -64,6 +66,7 @@ describe('ConfigSchema', () => {
           "caseIndent": true,
           "funcNextLine": true,
           "keepPadding": true,
+          "languageDialect": "posix",
           "path": "myshfmt",
           "simplifyCode": true,
           "spaceRedirects": true,
@@ -99,6 +102,7 @@ describe('getConfigFromEnvironmentVariables', () => {
           "caseIndent": false,
           "funcNextLine": false,
           "keepPadding": false,
+          "languageDialect": "auto",
           "path": "shfmt",
           "simplifyCode": false,
           "spaceRedirects": false,
@@ -128,6 +132,7 @@ describe('getConfigFromEnvironmentVariables', () => {
           "caseIndent": false,
           "funcNextLine": false,
           "keepPadding": false,
+          "languageDialect": "auto",
           "path": "",
           "simplifyCode": false,
           "spaceRedirects": false,
@@ -166,6 +171,7 @@ describe('getConfigFromEnvironmentVariables', () => {
           "caseIndent": true,
           "funcNextLine": false,
           "keepPadding": false,
+          "languageDialect": "auto",
           "path": "/path/to/shfmt",
           "simplifyCode": false,
           "spaceRedirects": false,

server/src/config.ts

@@ -58,6 +58,9 @@ export const ConfigSchema = z.object({
       // (Deprecated) Keep column alignment padding.
       keepPadding: z.boolean().default(false),
 
+      // Language dialect to use when parsing (bash/posix/mksh/bats).
+      languageDialect: z.string().trim().default('auto'),
+
       // Simplify code before formatting.
       simplifyCode: z.boolean().default(false),
 
@@ -84,6 +87,7 @@ export function getConfigFromEnvironmentVariables(): {
     shellcheckPath: process.env.SHELLCHECK_PATH,
     shfmt: {
       path: process.env.SHFMT_PATH,
+      languageDialect: process.env.SHFMT_LANGUAGE_DIALECT,
       binaryNextLine: toBoolean(process.env.SHFMT_BINARY_NEXT_LINE),
       caseIndent: toBoolean(process.env.SHFMT_CASE_INDENT),
       funcNextLine: toBoolean(process.env.SHFMT_FUNC_NEXT_LINE),

server/src/shfmt/__tests__/index.test.ts

@@ -62,6 +62,17 @@ describe('formatter', () => {
     )
   })
 
+  it('should throw when parsing using the wrong language dialect', async () => {
+    expect(async () => {
+      await getFormattingResult({
+        document: FIXTURE_DOCUMENT.SHFMT,
+        shfmtConfig: { languageDialect: 'posix' },
+      })
+    }).rejects.toThrow(
+      /Shfmt: exited with status 1: .*\/testing\/fixtures\/shfmt.sh:25:14: the "function" builtin exists in bash; tried parsing as posix/,
+    )
+  })
+
   it('should format when shfmt is present', async () => {
     const [result] = await getFormattingResult({ document: FIXTURE_DOCUMENT.SHFMT })
     expect(result).toMatchInlineSnapshot(`

server/src/shfmt/index.ts

@@ -71,6 +71,7 @@ export class Formatter {
     if (shfmtConfig?.keepPadding) args.push('-kp') // --keep-padding
     if (shfmtConfig?.simplifyCode) args.push('-s') // --simplify
     if (shfmtConfig?.spaceRedirects) args.push('-sr') // --space-redirects
+    if (shfmtConfig?.languageDialect) args.push(`-ln=${shfmtConfig.languageDialect}`) // --language-dialect
 
     // If we can determine a local filename, pass that to shfmt to aid language dialect detection
     const filePathMatch = document.uri.match(/^file:\/\/(.*)$/)

vscode-client/package.json

@@ -83,6 +83,11 @@
           "default": "shfmt",
           "description": "Controls the executable used for Shfmt formatting. An empty string will disable formatting."
         },
+        "bashIde.shfmt.languageDialect": {
+          "type": "string",
+          "default": "auto",
+          "description": "Language dialect to use when parsing (bash/posix/mksh/bats)."
+        },
         "bashIde.shfmt.binaryNextLine": {
           "type": "boolean",
           "default": false,