https://github.com/vknabel/vscode-swiftformat

SwiftFormat for VS Code
https://github.com/vknabel/vscode-swiftformat

formatter hacktoberfest preffifier swift swiftformat vscode vscode-extension

Last synced: 14 days ago
JSON representation

SwiftFormat for VS Code

• Host: GitHub
• URL: https://github.com/vknabel/vscode-swiftformat
• Owner: vknabel
• License: mit
• Created: 2018-09-01T10:09:16.000Z (over 6 years ago)
• Default Branch: main
• Last Pushed: 2024-11-28T20:08:46.000Z (2 months ago)
• Last Synced: 2025-01-13T01:09:02.342Z (20 days ago)
• Topics: formatter, hacktoberfest, preffifier, swift, swiftformat, vscode, vscode-extension
• Language: TypeScript
• Homepage: https://marketplace.visualstudio.com/items?itemName=vknabel.vscode-swiftformat
• Size: 337 KB
• Stars: 42
• Watchers: 5
• Forks: 8
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 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.35.8"),

    ],

    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.                                     |

| `swiftformat.onlyEnableWithConfig`        | `Bool`     | `false`            | Only format if config present.                                                             |

| `swiftformat.path`                        | `[String]  or 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.                                                     |

## 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.