Add config params for shfmt printer flags

Author: chris-reeves

server/src/__tests__/config.test.ts

@@ -13,7 +13,13 @@ describe('ConfigSchema', () => {
         "logLevel": "info",
         "shellcheckArguments": [],
         "shellcheckPath": "shellcheck",
-        "shfmtPath": "shfmt",
+        "shfmt": {
+          "binaryNextLine": false,
+          "caseIndent": false,
+          "funcNextLine": false,
+          "path": "shfmt",
+          "spaceRedirects": false,
+        },
       }
     `)
   })
@@ -26,7 +32,13 @@ describe('ConfigSchema', () => {
         includeAllWorkspaceSymbols: true,
         shellcheckArguments: ' -e SC2001  -e SC2002 ',
         shellcheckPath: '',
-        shfmtPath: 'myshfmt',
+        shfmt: {
+          binaryNextLine: true,
+          caseIndent: true,
+          funcNextLine: true,
+          path: 'myshfmt',
+          spaceRedirects: true,
+        },
       }),
     ).toMatchInlineSnapshot(`
       {
@@ -43,7 +55,13 @@ describe('ConfigSchema', () => {
           "SC2002",
         ],
         "shellcheckPath": "",
-        "shfmtPath": "myshfmt",
+        "shfmt": {
+          "binaryNextLine": true,
+          "caseIndent": true,
+          "funcNextLine": true,
+          "path": "myshfmt",
+          "spaceRedirects": true,
+        },
       }
     `)
   })
@@ -70,7 +88,13 @@ describe('getConfigFromEnvironmentVariables', () => {
         "logLevel": "info",
         "shellcheckArguments": [],
         "shellcheckPath": "shellcheck",
-        "shfmtPath": "shfmt",
+        "shfmt": {
+          "binaryNextLine": false,
+          "caseIndent": false,
+          "funcNextLine": false,
+          "path": "shfmt",
+          "spaceRedirects": false,
+        },
       }
     `)
   })
@@ -91,7 +115,13 @@ describe('getConfigFromEnvironmentVariables', () => {
         "logLevel": "info",
         "shellcheckArguments": [],
         "shellcheckPath": "",
-        "shfmtPath": "",
+        "shfmt": {
+          "binaryNextLine": false,
+          "caseIndent": false,
+          "funcNextLine": false,
+          "path": "",
+          "spaceRedirects": false,
+        },
       }
     `)
   })
@@ -101,6 +131,7 @@ describe('getConfigFromEnvironmentVariables', () => {
       SHELLCHECK_PATH: '/path/to/shellcheck',
       SHELLCHECK_ARGUMENTS: '-e SC2001',
       SHFMT_PATH: '/path/to/shfmt',
+      SHFMT_CASE_INDENT: 'true',
       EXPLAINSHELL_ENDPOINT: 'localhost:8080',
       GLOB_PATTERN: '*.*',
       BACKGROUND_ANALYSIS_MAX_FILES: '1',
@@ -120,7 +151,13 @@ describe('getConfigFromEnvironmentVariables', () => {
           "SC2001",
         ],
         "shellcheckPath": "/path/to/shellcheck",
-        "shfmtPath": "/path/to/shfmt",
+        "shfmt": {
+          "binaryNextLine": false,
+          "caseIndent": true,
+          "funcNextLine": false,
+          "path": "/path/to/shfmt",
+          "spaceRedirects": false,
+        },
       }
     `)
   })

server/src/config.ts

@@ -41,8 +41,24 @@ export const ConfigSchema = z.object({
   // Controls the executable used for ShellCheck linting information. An empty string will disable linting.
   shellcheckPath: z.string().trim().default('shellcheck'),
 
-  // Controls the executable used for Shfmt formatting. An empty string will disable formatting
-  shfmtPath: z.string().trim().default('shfmt'),
+  shfmt: z
+    .object({
+      // Controls the executable used for Shfmt formatting. An empty string will disable formatting
+      path: z.string().trim().default('shfmt'),
+
+      // Allow boolean operators (like && and ||) to start a line.
+      binaryNextLine: z.boolean().default(false),
+
+      // Indent patterns in case statements.
+      caseIndent: z.boolean().default(false),
+
+      // Place function opening braces on a separate line.
+      funcNextLine: z.boolean().default(false),
+
+      // Follow redirection operators with a space.
+      spaceRedirects: z.boolean().default(false),
+    })
+    .default({}),
 })
 
 export type Config = z.infer<typeof ConfigSchema>
@@ -60,7 +76,13 @@ export function getConfigFromEnvironmentVariables(): {
     logLevel: process.env[LOG_LEVEL_ENV_VAR],
     shellcheckArguments: process.env.SHELLCHECK_ARGUMENTS,
     shellcheckPath: process.env.SHELLCHECK_PATH,
-    shfmtPath: process.env.SHFMT_PATH,
+    shfmt: {
+      path: process.env.SHFMT_PATH,
+      binaryNextLine: toBoolean(process.env.SHFMT_BINARY_NEXT_LINE),
+      caseIndent: toBoolean(process.env.SHFMT_CASE_INDENT),
+      funcNextLine: toBoolean(process.env.SHFMT_FUNC_NEXT_LINE),
+      spaceRedirects: toBoolean(process.env.SHFMT_SPACE_REDIRECTS),
+    },
   }
 
   const environmentVariablesUsed = Object.entries(rawConfig)

server/src/server.ts

@@ -279,9 +279,9 @@ export default class BashServer {
             this.linter = new Linter({ executablePath: shellcheckPath })
           }
 
-          const { shfmtPath } = this.config
+          const shfmtPath = this.config.shfmt?.path
           if (!shfmtPath) {
-            logger.info('Shfmt formatting is disabled as "shfmtPath" was not set')
+            logger.info('Shfmt formatting is disabled as "shfmt.path" was not set')
             this.formatter = undefined
           } else {
             this.formatter = new Formatter({ executablePath: shfmtPath })

vscode-client/__tests__/config.test.ts

@@ -4,6 +4,18 @@ import { LOG_LEVELS } from '../../server/src/util/logger'
 
 const defaultConfig = getDefaultConfiguration()
 
+function flattenObjectKeys(obj: Record<string, any>, prefix = '') {
+  return Object.keys(obj).reduce((flattenedKeys: string[], key) => {
+    const pre = prefix.length ? `${prefix}.` : ''
+    if (typeof obj[key] === 'object' && obj[key] !== null && !Array.isArray(obj[key])) {
+      flattenedKeys.push(...flattenObjectKeys(obj[key], pre + key))
+    } else {
+      flattenedKeys.push(pre + key)
+    }
+    return flattenedKeys
+  }, [])
+}
+
 describe('config', () => {
   const configProperties = packageJson.contributes.configuration.properties
 
@@ -18,7 +30,7 @@ describe('config', () => {
       .map((key) => key.replace(/^bashIde\./, ''))
       .sort()
 
-    const defaultConfigKeys = Object.keys(defaultConfig).sort()
+    const defaultConfigKeys = flattenObjectKeys(defaultConfig).sort()
     expect(configKeys).toEqual(defaultConfigKeys)
   })
 

vscode-client/package.json

@@ -78,10 +78,30 @@
           "default": "",
           "description": "Additional ShellCheck arguments. Note that we already add the following arguments: --shell, --format, --external-sources."
         },
-        "bashIde.shfmtPath": {
+        "bashIde.shfmt.path": {
           "type": "string",
           "default": "shfmt",
           "description": "Controls the executable used for Shfmt formatting. An empty string will disable formatting."
+        },
+        "bashIde.shfmt.binaryNextLine": {
+          "type": "boolean",
+          "default": "false",
+          "description": "Allow boolean operators (like && and ||) to start a line."
+        },
+        "bashIde.shfmt.caseIndent": {
+          "type": "boolean",
+          "default": "false",
+          "description": "Indent patterns in case statements."
+        },
+        "bashIde.shfmt.funcNextLine": {
+          "type": "boolean",
+          "default": "false",
+          "description": "Place function opening braces on a separate line."
+        },
+        "bashIde.shfmt.spaceRedirects": {
+          "type": "boolean",
+          "default": "false",
+          "description": "Follow redirection operators with a space."
         }
       }
     }