SwiftLint for VS Code
VS Code extension to enforce Swift style and conventions via SwiftLint. You can use SwiftLint installed globally or via the Swift Package Manager.
Global Installation
You can install SwiftLint globally using Homebrew or Mint. For a local setup you can use the Swift Package Manager.
# 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
:
// 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.path |
String |
/usr/local/bin/swiftlint |
The location of the globally installed SwiftLint. |
swiftlint.configSearchPaths |
[String] |
[".swiftlint.yml"] |
Possible paths for SwiftLint config. |
swiftlint.forceExcludePaths |
[String] |
["tmp","build",".build","Pods","Carthage"] |
Paths to be excluded from being passed to SwiftLint. |
Contributors
License
vscode-swiftlint is available under the MIT license.