KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#typescript #ai-agents #cli #claude-code #codex #developer-tools #ai #dsh-plugin #ai-agent #mcp #deepseek-harness #windows

vscode-swiftformat

★ 45 Open GitHub ↗

SwiftFormat for VS Code

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# SwiftFormat for VS Code

Prettify your Swift code automatically via [SwiftFormat](https://github.com/nicklockwood/SwiftFormat). You can
use SwiftFormat installed globally or via the Swift Package Manager.

> There are two formatters for Swift code. Use this extension if you wish to use [nicklockwood/SwiftFormat](https://github.com/nicklockwood/SwiftFormat).
> Use [apple-swift-format](https://github.com/vknabel/vscode-apple-swift-format) if you want to use [apple/swift-format](https://github.com/apple/swift-format).

### Global Installation

You can [install](https://github.com/nicklockwood/SwiftFormat#how-do-i-install-it) SwiftFormat globally using [Homebrew](http://brew.sh/) or [Mint](https://github.com/yonaskolb/Mint)

```bash
# Using Homebrew
$ brew update && brew install swiftformat
# Using Mint
$ mint install nicklockwood/SwiftFormat
```

### Local Installation

Add the package to your dependencies in `Package.swift`:

```diff
// swift-tools-version:4.2

import PackageDescription

let package = Package(
    name: "Komondor",
    products: [ ... ],
    dependencies: [
        // My dependencies
        .package(url: "https://github.com/orta/PackageConfig.git", from: "0.0.1"),
        // Dev deps
        .package(url: "https://github.com/orta/Komondor.git", from: "0.0.1"),
+        .package(url: "https://github.com/nicklockwood/SwiftFormat.git", from: "0.55.5"),
    ],
    targets: [...]
)
```

## 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. This will cause the extension to build the Swift package upon first launch. |
| `swiftformat.onlyEnableWithConfig`        | `Bool`     | `false`            | Only format if config present.                                                             |
| `swiftformat.path`                        | `[String]  or String`            | `["/usr/bin/env", "swiftformat"]`                                                        | The location of the installed SwiftFormat (global/workspace-relative). |
| `swiftformat.options`                     | `[String]` | `[]`               | Additional [options for SwiftFormat](https://github.com/nicklockwood/SwiftFormat#options). |
| `swiftformat.configSearchPaths`           | `[String]` | `[".swiftformat"]` | Possible paths for SwiftFormat config.                                                     |

Note that when `swiftformat.onlyEnableOnSwiftPMProjects` is enabled, the extension will only run `swiftformat`
executables built as part of the Swift package open in the workspace. It will try to build the binary once on first
launch. If the build fails, the extension will not fall back to a globally installed `swiftformat`. If you prefer a
locally built `swiftformat`, but want to skip the automatic initial build, let `swiftformat.path` point to the local
executable you have built manually or by other means independent of the extension.

## FAQs

### How do I enable formatting on type?

To enable formatting on while typing code without saving, simply enable the setting `"editor.formatOnType": true`.
In case you only want to enable it when editing Swift files, you can override as [`[swift]` language specific setting](https://code.visualstudio.com/docs/getstarted/settings#_language-specific-editor-settings).

## License

vscode-swiftformat is available under the [MIT](./LICENSE) license.

vscode-swiftformat

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README