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: 11 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 (over 5 years ago)
- Default Branch: main
- Last Pushed: 2025-06-15T18:19:19.000Z (23 days ago)
- Last Synced: 2025-06-21T18:58:46.954Z (17 days ago)
- Topics: hacktoberfest, linter, swift, swiftlint, vscode, vscode-extension
- Language: TypeScript
- Homepage: https://marketplace.visualstudio.com/items?itemName=vknabel.vscode-swiftlint
- Size: 366 KB
- Stars: 23
- Watchers: 3
- Forks: 2
- Open Issues: 17
-
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.58.2"),
],
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. This will cause the extension to build the Swift package upon first launch. |
| `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. |
Note that when `swiftlint.onlyEnableOnSwiftPMProjects` is enabled, the extension will only run `swiftlint` 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 `swiftlint`. If you prefer a
locally built `swiftlint`, but want to skip the automatic initial build, let `swiftlint.path` point to the local
executable you have built manually or by other means independent of the extension.
## 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.