Add tests for reading shfmt config options from .editorconfig

Author: chris-reeves

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

@@ -596,7 +596,7 @@ describe('formatter', () => {
     `)
   })
 
-  it('should omit filename from the shfmt comment when it cannot be determined', async () => {
+  it('should omit filename from the shfmt command when it cannot be determined', async () => {
     // There's no easy way to see what filename has been passed to shfmt without inspecting the
     // contents of the logs. As a workaround, we set a non-file:// URI on a dodgy document to
     // trigger an exception and inspect the error message.
@@ -613,4 +613,152 @@ describe('formatter', () => {
       /Shfmt: exited with status 1: <standard input>:10:1: > must be followed by a word/,
     )
   })
+
+  describe('getShfmtArguments()', () => {
+    const lspShfmtConfig = {
+      binaryNextLine: true,
+      funcNextLine: true,
+      simplifyCode: true,
+    }
+    const lspShfmtArgs = ['-bn', '-fn', '-s']
+    const formatOptions = { tabSize: 2, insertSpaces: true }
+
+    const formatter = new Formatter({
+      executablePath: 'shfmt',
+    })
+
+    describe('when the document URI is not a filepath', () => {
+      let shfmtArgs: string[]
+      const filepath = `${FIXTURE_FOLDER}/shfmt.sh`
+
+      beforeAll(async () => {
+        // @ts-expect-error Testing a private method
+        shfmtArgs = await formatter.getShfmtArguments(
+          `test://${filepath}`,
+          formatOptions,
+          lspShfmtConfig,
+        )
+      })
+
+      it('should use language server config', async () => {
+        expect(shfmtArgs).toEqual(expect.arrayContaining(lspShfmtArgs))
+        expect(shfmtArgs.length).toEqual(4) // indentation
+      })
+
+      it('should use indentation config from the editor', () => {
+        expect(shfmtArgs).toContain('-i=2')
+      })
+
+      it('should not include the filename argument', async () => {
+        expect(shfmtArgs).not.toContain(`--filename=${filepath}`)
+      })
+    })
+
+    describe('when no .editorconfig exists', () => {
+      let shfmtArgs: string[]
+      const filepath = `${FIXTURE_FOLDER}/shfmt.sh`
+
+      beforeAll(async () => {
+        // @ts-expect-error Testing a private method
+        shfmtArgs = await formatter.getShfmtArguments(
+          `file://${filepath}`,
+          formatOptions,
+          lspShfmtConfig,
+        )
+      })
+
+      it('should use language server config', () => {
+        expect(shfmtArgs).toEqual(expect.arrayContaining(lspShfmtArgs))
+        expect(shfmtArgs.length).toEqual(5) // indentation + filename
+      })
+
+      it('should use indentation config from the editor', () => {
+        expect(shfmtArgs).toContain('-i=2')
+      })
+
+      it('should include the filename argument', () => {
+        expect(shfmtArgs).toContain(`--filename=${filepath}`)
+      })
+    })
+
+    describe('when an .editorconfig exists without shfmt options', () => {
+      let shfmtArgs: string[]
+      const filepath = `${FIXTURE_FOLDER}/shfmt-editorconfig/no-shfmt-properties/foo.sh`
+
+      beforeAll(async () => {
+        // @ts-expect-error Testing a private method
+        shfmtArgs = await formatter.getShfmtArguments(
+          `file://${filepath}`,
+          formatOptions,
+          lspShfmtConfig,
+        )
+      })
+
+      it('should use language server config', () => {
+        expect(shfmtArgs).toEqual(expect.arrayContaining(lspShfmtArgs))
+        expect(shfmtArgs.length).toEqual(5) // indentation + filename
+      })
+
+      it('should use indentation config from the editor', () => {
+        expect(shfmtArgs).toContain('-i=2')
+      })
+
+      it('should include the filename argument', () => {
+        expect(shfmtArgs).toContain(`--filename=${filepath}`)
+      })
+    })
+
+    describe('when an .editorconfig exists and contains only false shfmt options', () => {
+      let shfmtArgs: string[]
+      const filepath = `${FIXTURE_FOLDER}/shfmt-editorconfig/shfmt-properties-false/foo.sh`
+
+      beforeAll(async () => {
+        // @ts-expect-error Testing a private method
+        shfmtArgs = await formatter.getShfmtArguments(
+          `file://${filepath}`,
+          formatOptions,
+          lspShfmtConfig,
+        )
+      })
+
+      it('should use .editorconfig config (even though no options are enabled)', () => {
+        expect(shfmtArgs.length).toEqual(2) // indentation + filename
+      })
+
+      it('should use indentation config from the editor', () => {
+        expect(shfmtArgs).toContain('-i=2')
+      })
+
+      it('should include the filename argument', () => {
+        expect(shfmtArgs).toContain(`--filename=${filepath}`)
+      })
+    })
+
+    describe('when an .editorconfig exists and contains one or more shfmt options', () => {
+      let shfmtArgs: string[]
+      const filepath = `${FIXTURE_FOLDER}/shfmt-editorconfig/shfmt-properties/foo.sh`
+
+      beforeAll(async () => {
+        // @ts-expect-error Testing a private method
+        shfmtArgs = await formatter.getShfmtArguments(
+          `file://${filepath}`,
+          formatOptions,
+          lspShfmtConfig,
+        )
+      })
+
+      it('should use .editorconfig config', () => {
+        expect(shfmtArgs).toEqual(expect.arrayContaining(['-ci', '-sr', "-ln='mksh'"]))
+        expect(shfmtArgs.length).toEqual(5) // indentation + filename
+      })
+
+      it('should use indentation config from the editor', () => {
+        expect(shfmtArgs).toContain('-i=2')
+      })
+
+      it('should include the filename argument', () => {
+        expect(shfmtArgs).toContain(`--filename=${filepath}`)
+      })
+    })
+  })
 })

testing/fixtures/shfmt-editorconfig/no-shfmt-properties/.editorconfig

@@ -0,0 +1,3 @@
+[*]
+indent_style = space
+indent_size = 3

testing/fixtures/shfmt-editorconfig/shfmt-properties-false/.editorconfig

@@ -0,0 +1,6 @@
+[*]
+indent_style = space
+indent_size = 3
+
+switch_case_indent = false
+space_redirects = false

testing/fixtures/shfmt-editorconfig/shfmt-properties/.editorconfig

@@ -0,0 +1,7 @@
+[*]
+indent_style = space
+indent_size = 3
+
+switch_case_indent = true
+space_redirects = true
+shell_variant = 'mksh'