Respect editor config for tab size when formatting

If the editor config is set to insert spaces instead of tabs, shfmt will
respect that choice (including the number of spaces to insert).

Author: chris-reeves

server/src/server.ts

@@ -833,7 +833,7 @@ export default class BashServer {
           return null
         }
 
-        return await this.formatter.format(document)
+        return await this.formatter.format(document, params.options)
       } catch (err) {
         logger.error(`Error while formatting: ${err}`)
       }

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

@@ -1,3 +1,4 @@
+import { FormattingOptions } from 'vscode-languageserver/node'
 import { TextDocument } from 'vscode-languageserver-textdocument'
 
 import { FIXTURE_DOCUMENT, FIXTURE_FOLDER } from '../../../../testing/fixtures'
@@ -17,14 +18,16 @@ function textToDoc(txt: string) {
 async function getFormattingResult({
   document,
   executablePath = 'shfmt',
+  formatOptions,
 }: {
   document: TextDocument
   executablePath?: string
+  formatOptions?: FormattingOptions
 }): Promise<[Awaited<ReturnType<Formatter['format']>>, Formatter]> {
   const formatter = new Formatter({
     executablePath,
   })
-  const result = await formatter.format(document)
+  const result = await formatter.format(document, formatOptions)
   return [result, formatter]
 }
 
@@ -90,4 +93,94 @@ describe('formatter', () => {
       ]
     `)
   })
+
+  it('should format using tabs when insertSpaces is false', async () => {
+    const [result] = await getFormattingResult({
+      document: FIXTURE_DOCUMENT.SHFMT,
+      formatOptions: { tabSize: 4, insertSpaces: false },
+    })
+    expect(result).toMatchInlineSnapshot(`
+      [
+        {
+          "newText": "#!/bin/bash
+      set -ueo pipefail
+
+      if [ -z "$arg" ]; then
+      	echo indent
+      fi
+
+      echo binary &&
+      	echo next line
+
+      case "$arg" in
+      a)
+      	echo case indent
+      	;;
+      esac
+
+      echo space redirects >/dev/null
+
+      function next() {
+      	echo line
+      }
+      ",
+          "range": {
+            "end": {
+              "character": 2147483647,
+              "line": 2147483647,
+            },
+            "start": {
+              "character": 0,
+              "line": 0,
+            },
+          },
+        },
+      ]
+    `)
+  })
+
+  it('should format using spaces when insertSpaces is true', async () => {
+    const [result] = await getFormattingResult({
+      document: FIXTURE_DOCUMENT.SHFMT,
+      formatOptions: { tabSize: 3, insertSpaces: true },
+    })
+    expect(result).toMatchInlineSnapshot(`
+      [
+        {
+          "newText": "#!/bin/bash
+      set -ueo pipefail
+
+      if [ -z "$arg" ]; then
+         echo indent
+      fi
+
+      echo binary &&
+         echo next line
+
+      case "$arg" in
+      a)
+         echo case indent
+         ;;
+      esac
+
+      echo space redirects >/dev/null
+
+      function next() {
+         echo line
+      }
+      ",
+          "range": {
+            "end": {
+              "character": 2147483647,
+              "line": 2147483647,
+            },
+            "start": {
+              "character": 0,
+              "line": 0,
+            },
+          },
+        },
+      ]
+    `)
+  })
 })

server/src/shfmt/index.ts

@@ -24,18 +24,24 @@ export class Formatter {
     return this._canFormat
   }
 
-  public async format(document: TextDocument): Promise<TextEdit[]> {
+  public async format(
+    document: TextDocument,
+    formatOptions?: LSP.FormattingOptions | null,
+  ): Promise<TextEdit[]> {
     if (!this._canFormat) {
       return []
     }
 
-    return this.executeFormat(document)
+    return this.executeFormat(document, formatOptions)
   }
 
-  private async executeFormat(document: TextDocument): Promise<TextEdit[]> {
+  private async executeFormat(
+    document: TextDocument,
+    formatOptions?: LSP.FormattingOptions | null,
+  ): Promise<TextEdit[]> {
     const documentText = document.getText()
 
-    const result = await this.runShfmt(documentText)
+    const result = await this.runShfmt(documentText, formatOptions)
 
     if (!this._canFormat) {
       return []
@@ -52,8 +58,12 @@ export class Formatter {
     ]
   }
 
-  private async runShfmt(documentText: string): Promise<string> {
-    const args: string[] = []
+  private async runShfmt(
+    documentText: string,
+    formatOptions?: LSP.FormattingOptions | null,
+  ): Promise<string> {
+    const indentation: number = formatOptions?.insertSpaces ? formatOptions.tabSize : 0
+    const args: string[] = [`--indent=${indentation}`]
 
     logger.debug(`Shfmt: running "${this.executablePath} ${args.join(' ')}"`)