Skip to content

carlossless/SwiftLint

 
 

Repository files navigation

SwiftLint

An experimental tool to enforce Swift style and conventions, loosely based on GitHub's Swift Style Guide.

SwiftLint hooks into Clang and SourceKit to use the AST representation of your source files for more accurate results.

Test Status

Installation

Using Homebrew

brew install swiftlint 

You can also install SwiftLint by downloading SwiftLint.pkg from the latest GitHub release and running it.

You can also build from source by cloning this project and running make install.

Usage

Xcode

Integrate SwiftLint into an Xcode scheme to get warnings and errors displayed in the IDE. Just add a new "Run Script Phase" with /usr/local/bin/swiftlint as its contents.

Atom

To integrate SwiftLint with Atom install the linter-swiftlint package from APM.

Command Line

$ swiftlint help Available commands: help Display general or command-specific help lint Print lint warnings and errors for the Swift files in the current directory (default command) rules Display the list of rules and examples version Display the current version of SwiftLint 

Run swiftlint in the directory containing the Swift files to lint. Directories will be searched recursively.

Rules

There are only a small number of rules currently implemented, but we hope the Swift community (that's you!) will contribute more over time. Pull requests are encouraged.

The rules that are currently implemented are mostly there as a starting point and are subject to change.

See the Source/SwiftLintFramework/Rules directory to see the currently implemented rules.

License

MIT licensed.

About

An experimental tool to enforce Swift style and conventions.

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages

  • Swift 94.8%
  • Makefile 3.3%
  • Shell 1.9%