fix: windows support

Author: vknabel

CHANGELOG.md

@@ -1,3 +1,7 @@
+# 1.6.7
+
+- fix: windows support
+
 # 1.6.6
 
 - fix: regression in nested swift projects #29

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] | 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.                                                     |
+| 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`            | `swiftformat`                                                                              | The location of the globally installed SwiftFormat (resolved with the current path if only a filename). |
+| `swiftformat.options`                     | `[String]` | `[]`               | Additional [options for SwiftFormat](https://github.com/nicklockwood/SwiftFormat#options). |
+| `swiftformat.configSearchPaths`           | `[String]` | `[".swiftformat"]` | Possible paths for SwiftFormat config.                                                     |
 
 ## Contributors
 

package.json

@@ -6,7 +6,7 @@
     "type": "git",
     "url": "https://github.com/vknabel/vscode-swiftformat"
   },
-  "version": "1.6.6",
+  "version": "1.6.7",
   "license": "MIT",
   "author": {
     "name": "Valentin Knabel",

src/Current.ts

@@ -31,6 +31,7 @@ import { absolutePath } from "./AbsolutePath";
 import { existsSync } from "fs";
 import * as paths from "path";
 import * as glob from "glob";
+import * as os from "os";
 
 export function prodEnvironment(): Current {
   return {
@@ -120,17 +121,23 @@ export function prodEnvironment(): Current {
 }
 
 const fallbackGlobalSwiftFormatPath = (): string[] => {
-  const defaultPath = ["/usr/bin/env", "swiftformat"];
-  const path = vscode.workspace
+  var path = vscode.workspace
     .getConfiguration()
-    .get("swiftformat.path", defaultPath);
+    .get<string[] | string | null>("swiftformat.path", null);
+
   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;
+    return [path];
+  }
+  if (!Array.isArray(path) || path.length === 0) {
+    path = [os.platform() === "win32" ? "swiftformat.exe" : "swiftformat"];
   }
+
+  if (os.platform() !== "win32" && !path[0].includes("/")) {
+    // Only a binary name, not a path. Search for it in the path (on Windows this is implicit).
+    path = ["/usr/bin/env", ...path];
+  }
+
+  return path;
 };
 
 const Current = prodEnvironment();

src/SwiftFormatEditProvider.ts

@@ -1,20 +1,21 @@
 import * as vscode from "vscode";
-import * as childProcess from "child_process";
 import Current from "./Current";
 import { handleFormatError } from "./UserInteraction";
 import { existsSync } from "fs";
 import { resolve } from "path";
+import { execShellSync } from "./execShell";
 
 const wholeDocumentRange = new vscode.Range(
   0,
   0,
   Number.MAX_SAFE_INTEGER,
-  Number.MAX_SAFE_INTEGER
+  Number.MAX_SAFE_INTEGER,
 );
 
-function userDefinedFormatOptionsForDocument(
-  document: vscode.TextDocument
-): { options: string[]; hasConfig: boolean } {
+function userDefinedFormatOptionsForDocument(document: vscode.TextDocument): {
+  options: string[];
+  hasConfig: boolean;
+} {
   const formatOptions = Current.config.formatOptions();
   if (formatOptions.indexOf("--config") != -1)
     return { options: formatOptions, hasConfig: true };
@@ -25,7 +26,7 @@ function userDefinedFormatOptionsForDocument(
     "./";
   const searchPaths = Current.config
     .formatConfigSearchPaths()
-    .map(current => resolve(rootPath, current));
+    .map((current) => resolve(rootPath, current));
   const existingConfig = searchPaths.find(existsSync);
   const options =
     existingConfig != null
@@ -48,7 +49,7 @@ function format(request: {
     const input = request.document.getText(request.range);
     if (input.trim() === "") return [];
     const userDefinedParams = userDefinedFormatOptionsForDocument(
-      request.document
+      request.document,
     );
     if (!userDefinedParams.hasConfig && Current.config.onlyEnableWithConfig()) {
       return [];
@@ -60,7 +61,7 @@ function format(request: {
             "--indent",
             request.formatting.insertSpaces
               ? `${request.formatting.tabSize}`
-              : "tabs"
+              : "tabs",
           ];
 
     // Make the path explicitly absolute when on Windows. If we don't do this,
@@ -71,7 +72,7 @@ function format(request: {
       fileName = "/" + fileName;
     }
 
-    const newContents = childProcess.execFileSync(
+    const newContents = execShellSync(
       swiftFormatPath[0],
       [
         ...swiftFormatPath.slice(1),
@@ -80,19 +81,19 @@ function format(request: {
         fileName,
         ...userDefinedParams.options,
         ...(request.parameters || []),
-        ...formattingParameters
+        ...formattingParameters,
       ],
       {
         encoding: "utf8",
-        input
-      }
+        input,
+      },
     );
     return newContents !== request.document.getText(request.range)
       ? [
           vscode.TextEdit.replace(
             request.document.validateRange(request.range || wholeDocumentRange),
-            newContents
-          )
+            newContents,
+          ),
         ]
       : [];
   } catch (error) {
@@ -104,22 +105,23 @@ function format(request: {
 export class SwiftFormatEditProvider
   implements
     vscode.DocumentRangeFormattingEditProvider,
-    vscode.DocumentFormattingEditProvider {
+    vscode.DocumentFormattingEditProvider
+{
   provideDocumentRangeFormattingEdits(
     document: vscode.TextDocument,
     range: vscode.Range,
-    formatting: vscode.FormattingOptions
+    formatting: vscode.FormattingOptions,
   ) {
     return format({
       document,
       parameters: ["--fragment", "true"],
       range,
-      formatting
+      formatting,
     });
   }
   provideDocumentFormattingEdits(
     document: vscode.TextDocument,
-    formatting: vscode.FormattingOptions
+    formatting: vscode.FormattingOptions,
   ) {
     return format({ document, formatting });
   }

src/UserInteraction.ts

@@ -4,21 +4,27 @@ import Current from "./Current";
 enum FormatErrorInteraction {
   configure = "Configure",
   reset = "Reset",
-  howTo = "How?"
+  howTo = "How?",
 }
 
 enum UnknownErrorInteraction {
-  reportIssue = "Report issue"
+  reportIssue = "Report issue",
 }
 
 export async function handleFormatError(
   error: any,
-  document: vscode.TextDocument
+  document: vscode.TextDocument,
 ) {
   function matches(...codeOrStatus: Array<number | string>) {
-    return codeOrStatus.some(c => c === error.code || c === error.status);
+    return codeOrStatus.some((c) => {
+      if (typeof error.stderr === "string" && error.stderr.includes(c)) {
+        return true;
+      }
+      return c === error.code || c === error.status;
+    });
   }
-  if (matches("ENOBUFS", "EPIPE")) {
+
+  if (matches("Domain=NSCocoaErrorDomain Code=260", "ENOBUFS", "EPIPE")) {
     return;
   } else if (matches("ENOENT", "EACCES", 127)) {
     const selection = await Current.editor.showErrorMessage(
@@ -27,7 +33,7 @@ export async function handleFormatError(
         ?.join(" ")}.\nEnsure it is installed and in your PATH.`,
       FormatErrorInteraction.reset,
       FormatErrorInteraction.configure,
-      FormatErrorInteraction.howTo
+      FormatErrorInteraction.howTo,
     );
     switch (selection) {
       case FormatErrorInteraction.reset:
@@ -38,18 +44,18 @@ export async function handleFormatError(
         break;
       case FormatErrorInteraction.howTo:
         await Current.editor.openURL(
-          "https://github.com/nicklockwood/SwiftFormat#command-line-tool"
+          "https://github.com/nicklockwood/SwiftFormat#command-line-tool",
         );
         break;
     }
   } else if (matches(70)) {
     await Current.editor.showErrorMessage(
-      `SwiftFormat failed. ${error.stderr || ""}`
+      `SwiftFormat failed. ${error.stderr || ""}`,
     );
   } else {
     const unknownErrorSelection = await Current.editor.showErrorMessage(
       `An unknown error occurred. ${error.message || ""}`,
-      UnknownErrorInteraction.reportIssue
+      UnknownErrorInteraction.reportIssue,
     );
     if (unknownErrorSelection === UnknownErrorInteraction.reportIssue) {
       await Current.editor.reportIssueForError(error);

src/execShell.ts

@@ -0,0 +1,26 @@
+import {
+  execFileSync,
+  ExecFileSyncOptionsWithStringEncoding,
+  spawnSync,
+} from "child_process";
+import * as os from "os";
+
+export function execShellSync(
+  file: string,
+  args: ReadonlyArray<string>,
+  options: ExecFileSyncOptionsWithStringEncoding,
+): string {
+  if (os.platform() === "win32") {
+    const result = spawnSync(file, args ?? [], {
+      ...options,
+      encoding: "utf8",
+      shell: true,
+    });
+    if (result.error) {
+      throw result.error;
+    }
+    return result.stdout;
+  } else {
+    return execFileSync(file, args, options);
+  }
+}

src/extension.ts

@@ -15,16 +15,16 @@ export function activate(context: vscode.ExtensionContext) {
   buildSwiftformatIfNeeded().then(() => {
     const swiftSelector: vscode.DocumentSelector = {
       scheme: "file",
-      language: "swift"
+      language: "swift",
     };
     const editProvider = new SwiftFormatEditProvider();
     vscode.languages.registerDocumentRangeFormattingEditProvider(
       swiftSelector,
-      editProvider
+      editProvider,
     );
     vscode.languages.registerDocumentFormattingEditProvider(
       swiftSelector,
-      editProvider
+      editProvider,
     );
   });
 }
@@ -33,27 +33,27 @@ async function buildSwiftformatIfNeeded() {
   const manifests = await vscode.workspace.findFiles(
     "**/Package.swift",
     "**/.build/**",
-    2
+    2,
   );
   if (manifests.length == 0) {
     return;
   }
-  const buildOperations = manifests.map(manifest => {
+  const buildOperations = manifests.map((manifest) => {
     const manifestPath = manifest.fsPath;
     const manifestDir = path.dirname(manifestPath);
     return promisify(exec)("swift run -c release swiftformat --version", {
-      cwd: manifestDir
+      cwd: manifestDir,
     });
   });
   try {
     await vscode.window.withProgress(
       {
         location: vscode.ProgressLocation.Window,
-        title: "Preparing swiftformat"
+        title: "Preparing swiftformat",
       },
       async () => {
         await Promise.all(buildOperations);
-      }
+      },
     );
   } catch (error) {
     console.log(error);