feat: smarter path default for vknabel/vscode-apple-swift-format#17

vknabel · Dec 12, 2022 · 8e38f76 · 8e38f76
1 parent 4812ab7
commit 8e38f76
Show file tree

Hide file tree

Showing 5 changed files with 50 additions and 22 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,7 @@
-# Unreleased
+# 1.6.0
 
 - docs: clarified `swiftformat.options` #17
+- Added: `swiftformat.path` can now be an array of strings and defaults to `[/usr/bin/env, swiftformat]` #17
 
 # 1.5.1
 

diff --git a/README.md b/README.md
@@ -42,14 +42,14 @@ let package = Package(
 
 ## Configuration
 
-| Config                                    | Type       | Default                      | Description                                                                                |
-| ----------------------------------------- | ---------- | ---------------------------- | ------------------------------------------------------------------------------------------ |
-| `swiftformat.enable`                      | `Bool`     | `true`                       | Whether SwiftFormat should actually do something.                                          |
-| `swiftformat.onlyEnableOnSwiftPMProjects` | `Bool`     | `false`                      | Requires and uses a SwiftFormat as SwiftPM dependency.                                     |
-| `swiftformat.onlyEnableWithConfig`        | `Bool`     | `false`                      | Only format if config present.                                                             |
-| `swiftformat.path`                        | `String`   | `/usr/local/bin/swiftformat` | The location of the globally installed SwiftFormat.                                        |
-| `swiftformat.options`                     | `[String]` | `[]`                         | Additional [options for SwiftFormat](https://github.com/nicklockwood/SwiftFormat#options). |
-| `swiftformat.configSearchPaths`           | `[String]` | `[".swiftformat"]`           | Possible paths for SwiftFormat config.                                                     |
+| Config                                    | Type                | Default                       | Description                                                                                |
+| ----------------------------------------- | ------------------- | ----------------------------- | ------------------------------------------------------------------------------------------ |
+| `swiftformat.enable`                      | `Bool`              | `true`                        | Whether SwiftFormat should actually do something.                                          |
+| `swiftformat.onlyEnableOnSwiftPMProjects` | `Bool`              | `false`                       | Requires and uses a SwiftFormat as SwiftPM dependency.                                     |
+| `swiftformat.onlyEnableWithConfig`        | `Bool`              | `false`                       | Only format if config present.                                                             |
+| `swiftformat.path`                        | `[String] | String` | `[/usr/bin/env, swiftformat]` | The location of the globally installed SwiftFormat.                                        |
+| `swiftformat.options`                     | `[String]`          | `[]`                          | Additional [options for SwiftFormat](https://github.com/nicklockwood/SwiftFormat#options). |
+| `swiftformat.configSearchPaths`           | `[String]`          | `[".swiftformat"]`            | Possible paths for SwiftFormat config.                                                     |
 
 ## Contributors
 

diff --git a/package.json b/package.json
@@ -6,7 +6,7 @@
     "type": "git",
     "url": "https://github.com/vknabel/vscode-swiftformat"
   },
-  "version": "1.5.1",
+  "version": "1.6.0",
   "license": "MIT",
   "author": {
     "name": "Valentin Knabel",
@@ -69,10 +69,29 @@
           "description": "Only use SwiftFormat when a config exists."
         },
         "swiftformat.path": {
-          "type": "string",
-          "default": "/usr/local/bin/swiftformat",
           "description": "The location of your globally installed SwiftFormat.",
-          "scope": "machine"
+          "scope": "machine",
+          "default": [
+            "/usr/bin/env",
+            "swiftformat"
+          ],
+          "oneOf": [
+            {
+              "type": "string",
+              "default": "/usr/local/bin/swiftformat"
+            },
+            {
+              "type": "array",
+              "minItems": 1,
+              "default": [
+                "/usr/bin/env",
+                "swiftformat"
+              ],
+              "items": {
+                "type": "string"
+              }
+            }
+          ]
         },
         "swiftformat.options": {
           "type": "array",

diff --git a/src/Current.ts b/src/Current.ts
@@ -17,7 +17,7 @@ export interface Current {
     isEnabled(): boolean;
     onlyEnableOnSwiftPMProjects(): boolean;
     onlyEnableWithConfig(): boolean;
-    swiftFormatPath(document: vscode.TextDocument): string | null;
+    swiftFormatPath(document: vscode.TextDocument): string[] | null;
     resetSwiftFormatPath(): void;
     configureSwiftFormatPath(): void;
     formatOptions(): string[];
@@ -87,7 +87,7 @@ export function prodEnvironment(): Current {
           const fullPath = join(workspace.uri.fsPath, path);
 
           if (existsSync(fullPath)) {
-            return absolutePath(fullPath);
+            return [absolutePath(fullPath)];
           }
         }
         if (
@@ -117,12 +117,19 @@ export function prodEnvironment(): Current {
   };
 }
 
-const fallbackGlobalSwiftFormatPath = () =>
-  absolutePath(
-    vscode.workspace
-      .getConfiguration()
-      .get("swiftformat.path", "/usr/local/bin/swiftformat")
-  );
+const fallbackGlobalSwiftFormatPath = (): string[] => {
+  const defaultPath = ["/usr/bin/env", "swiftformat"];
+  const path = vscode.workspace
+    .getConfiguration()
+    .get("swiftformat.path", defaultPath);
+  if (typeof path === "string") {
+    return [absolutePath(path)];
+  } else if (Array.isArray(path) && path.length > 0) {
+    return [absolutePath(path[0]), ...path.slice(1)];
+  } else {
+    return defaultPath;
+  }
+};
 
 const Current = prodEnvironment();
 export default Current as Current;
diff --git a/src/SwiftFormatEditProvider.ts b/src/SwiftFormatEditProvider.ts
@@ -63,8 +63,9 @@ function format(request: {
               : "tabs"
           ];
     const newContents = childProcess.execFileSync(
-      swiftFormatPath,
+      swiftFormatPath[0],
       [
+        ...swiftFormatPath.slice(1),
         "stdin",
         "--stdinpath",
         request.document.fileName,