Merge pull request #1171 from chris-reeves/shfmt-editorconfig-support

Add .editorconfig support for shfmt

Author: skovhus

README.md

@@ -195,6 +195,15 @@ there is no `shfmt`-specific configuration variable for this. If your editor is
 two-space indents then that's what it will use. If you're using tabs for indentation then `shfmt`
 will use that.
 
+The `shfmt` integration also supports configuration via `.editorconfig`. If any `shfmt`-specific
+configuration properties are found in `.editorconfig` then the config in `.editorconfig` will be
+used and the language server config will be ignored. This follows `shfmt`'s approach of using either
+`.editorconfig` or command line flags, but not both. Note that only `shfmt`-specific configuration
+properties are read from `.editorconfig` - indentation preferences are still provided by the editor,
+so to format using the indentation specified in `.editorconfig` make sure your editor is also
+configured to read `.editorconfig`. It is possible to disable `.editorconfig` support and always use
+the language server config by setting the "Ignore Editorconfig" configuration variable.
+
 ## Logging
 
 The minimum logging level for the server can be adjusted using the `BASH_IDE_LOG_LEVEL` environment variable

pnpm-lock.yaml

@@ -1,5 +1,9 @@
 # Bash Language Server
 
+## 5.4.0
+
+- Add .editorconfig support for shfmt https://github.com/bash-lsp/bash-language-server/pull/1171
+
 ## 5.3.4
 
 - Add additonal shfmt formatting config options https://github.com/bash-lsp/bash-language-server/pull/1168

server/CHANGELOG.md

@@ -3,7 +3,7 @@
   "description": "A language server for Bash",
   "author": "Mads Hartmann",
   "license": "MIT",
-  "version": "5.3.4",
+  "version": "5.4.0",
   "main": "./out/server.js",
   "typings": "./out/server.d.ts",
   "bin": {
@@ -17,6 +17,7 @@
     "node": ">=16"
   },
   "dependencies": {
+    "editorconfig": "2.0.0",
     "fast-glob": "3.3.2",
     "fuzzy-search": "3.2.1",
     "node-fetch": "2.7.0",

server/package.json

@@ -17,7 +17,9 @@ describe('ConfigSchema', () => {
           "binaryNextLine": false,
           "caseIndent": false,
           "funcNextLine": false,
+          "ignoreEditorconfig": false,
           "keepPadding": false,
+          "languageDialect": "auto",
           "path": "shfmt",
           "simplifyCode": false,
           "spaceRedirects": false,
@@ -38,7 +40,9 @@ describe('ConfigSchema', () => {
           binaryNextLine: true,
           caseIndent: true,
           funcNextLine: true,
+          ignoreEditorconfig: true,
           keepPadding: true,
+          languageDialect: 'posix',
           path: 'myshfmt',
           simplifyCode: true,
           spaceRedirects: true,
@@ -63,7 +67,9 @@ describe('ConfigSchema', () => {
           "binaryNextLine": true,
           "caseIndent": true,
           "funcNextLine": true,
+          "ignoreEditorconfig": true,
           "keepPadding": true,
+          "languageDialect": "posix",
           "path": "myshfmt",
           "simplifyCode": true,
           "spaceRedirects": true,
@@ -98,7 +104,9 @@ describe('getConfigFromEnvironmentVariables', () => {
           "binaryNextLine": false,
           "caseIndent": false,
           "funcNextLine": false,
+          "ignoreEditorconfig": false,
           "keepPadding": false,
+          "languageDialect": "auto",
           "path": "shfmt",
           "simplifyCode": false,
           "spaceRedirects": false,
@@ -127,7 +135,9 @@ describe('getConfigFromEnvironmentVariables', () => {
           "binaryNextLine": false,
           "caseIndent": false,
           "funcNextLine": false,
+          "ignoreEditorconfig": false,
           "keepPadding": false,
+          "languageDialect": "auto",
           "path": "",
           "simplifyCode": false,
           "spaceRedirects": false,
@@ -165,7 +175,9 @@ describe('getConfigFromEnvironmentVariables', () => {
           "binaryNextLine": false,
           "caseIndent": true,
           "funcNextLine": false,
+          "ignoreEditorconfig": false,
           "keepPadding": false,
+          "languageDialect": "auto",
           "path": "/path/to/shfmt",
           "simplifyCode": false,
           "spaceRedirects": false,

server/src/__tests__/config.test.ts

@@ -46,6 +46,12 @@ export const ConfigSchema = z.object({
       // Controls the executable used for Shfmt formatting. An empty string will disable formatting
       path: z.string().trim().default('shfmt'),
 
+      // Ignore shfmt config options in .editorconfig (always use language server config)
+      ignoreEditorconfig: z.boolean().default(false),
+
+      // Language dialect to use when parsing (bash/posix/mksh/bats).
+      languageDialect: z.enum(['auto', 'bash', 'posix', 'mksh', 'bats']).default('auto'),
+
       // Allow boolean operators (like && and ||) to start a line.
       binaryNextLine: z.boolean().default(false),
 
@@ -84,6 +90,8 @@ export function getConfigFromEnvironmentVariables(): {
     shellcheckPath: process.env.SHELLCHECK_PATH,
     shfmt: {
       path: process.env.SHFMT_PATH,
+      ignoreEditorconfig: toBoolean(process.env.SHFMT_IGNORE_EDITORCONFIG),
+      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),