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

VS Code extension to enforce Swift style and conventions via SwiftLint
https://github.com/vknabel/vscode-swiftlint

hacktoberfest linter swift swiftlint vscode vscode-extension

Last synced: 15 days ago
JSON representation

VS Code extension to enforce Swift style and conventions via SwiftLint

• Host: GitHub
• URL: https://github.com/vknabel/vscode-swiftlint
• Owner: vknabel
• License: mit
• Created: 2019-11-21T11:33:35.000Z (about 5 years ago)
• Default Branch: main
• Last Pushed: 2024-12-07T20:32:50.000Z (about 2 months ago)
• Last Synced: 2025-01-10T18:11:45.377Z (23 days ago)
• Topics: hacktoberfest, linter, swift, swiftlint, vscode, vscode-extension
• Language: TypeScript
• Homepage: https://marketplace.visualstudio.com/items?itemName=vknabel.vscode-swiftlint
• Size: 355 KB
• Stars: 22
• Watchers: 4
• Forks: 1
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# SwiftLint for VS Code

VS Code extension to enforce Swift style and conventions via [SwiftLint](https://github.com/realm/SwiftLint). You can use SwiftLint installed globally or via the Swift Package Manager.

### Global Installation

You can [install](https://github.com/realm/SwiftLint#installation) SwiftLint globally using [Homebrew](http://brew.sh/) or [Mint](https://github.com/yonaskolb/Mint). For a local setup you can use the Swift Package Manager.

```bash

# Using Homebrew

$ brew install swiftlint

# Using Mint

$ mint install realm/SwiftLint

# Manually

$ git clone https://github.com/realm/SwiftLint.git

$ swift build -c release

```

### 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/realm/SwiftLint.git", from: "0.37.0"),

    ],

    targets: [...]

)

```

## Configuration

| Config                                  | Type       | Default     | Description                                                                                                                             |

| --------------------------------------- | ---------- | ----------- | --------------------------------------------------------------------------------------------------------------------------------------- |

| `swiftlint.enable`                      | `Bool`     | `true`      | Whether SwiftLint should actually do something.                                                                                         |

| `swiftlint.onlyEnableOnSwiftPMProjects` | `Bool`     | `false`     | Requires and uses a SwiftLint as SwiftPM dependency.                                                                                    |

| `swiftlint.onlyEnableWithConfig`        | `Bool`     | `false`     | Only lint if config present. Requires `swiftlint.configSearchPaths`.                                                                    |

| `swiftlint.path`                        | `String`   | `swiftlint` | The location of the globally installed SwiftLint (resolved with the current path if only a filename).                                   |

| `swiftlint.additionalParameters`        | `[String]` | `[]`        | Additional parameters to pass to SwiftLint.                                                                                             |

| `swiftlint.configSearchPaths`           | `[String]` | `[]`        | Possible paths for SwiftLint config. _This disables [nested configurations](https://github.com/realm/SwiftLint#nested-configurations)!_ |

| `swiftlint.autoLintWorkspace`           | `Bool`     | `true`      | Automatically lint the whole project right after start.                                                                                 |

## Commands

| Short Title                     | Command                   |

| ------------------------------- | ------------------------- |

| SwiftLint: Lint workspace       | `swiftlint.lintWorkspace` |

| SwiftLint: Fix workspace        | `swiftlint.fixWorkspace`  |

| SwiftLint: Fix document         | `swiftlint.fixDocument`   |

| SwiftLint: Fix all known issues | `source.fixAll.swiftlint` |

To automatically fix all issues within a document on save, add the following to your `.vscode/settings.json`:

```json

{

  "editor.codeActionsOnSave": {

    "source.fixAll": true

  }

}

```

## License

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