一个强制执行Swift风格和约定的工具。___下载.zip

# SwiftLint A tool to enforce Swift style and conventions, loosely based on the now archived [GitHub Swift Style Guide](https://github.com/github/swift-style-guide). SwiftLint enforces the style guide rules that are generally accepted by the Swift community. These rules are well described in popular style guides like [Ray Wenderlich's Swift Style Guide](https://github.com/raywenderlich/swift-style-guide). SwiftLint hooks into [Clang](http://clang.llvm.org) and [SourceKit](http://www.jpsim.com/uncovering-sourcekit) to use the [AST](http://clang.llvm.org/docs/IntroductionToTheClangAST.html) representation of your source files for more accurate results. [](https://dev.azure.com/jpsim/SwiftLint/_build/latest?definitionId=4?branchName=main) [](https://codecov.io/github/realm/SwiftLint?branch=main)  This project adheres to the [Contributor Covenant Code of Conduct](https://realm.io/conduct). By participating, you are expected to uphold this code. Please report unacceptable behavior to [info@realm.io](mailto:info@realm.io). > Language Switch: [中文](https://github.com/realm/SwiftLint/blob/main/README_CN.md), [한국어](https://github.com/realm/SwiftLint/blob/main/README_KR.md). ## Installation ### Using [Homebrew](http://brew.sh/): ``` brew install swiftlint ``` ### Using [CocoaPods](https://cocoapods.org): Simply add the following line to your Podfile: ```ruby pod 'SwiftLint' ``` This will download the SwiftLint binaries and dependencies in `Pods/` during your next `pod install` execution and will allow you to invoke it via `${PODS_ROOT}/SwiftLint/swiftlint` in your Script Build Phases. This is the recommended way to install a specific version of SwiftLint since it supports installing a pinned version rather than simply the latest (which is the case with Homebrew). Note that this will add the SwiftLint binaries, its dependencies' binaries, and the Swift binary library distribution to the `Pods/` directory, so checking in this directory to SCM such as git is discouraged. ### Using [Mint](https://github.com/yonaskolb/mint): ``` $ mint install realm/SwiftLint ``` ### Using a pre-built package: You can also install SwiftLint by downloading `SwiftLint.pkg` from the [latest GitHub release](https://github.com/realm/SwiftLint/releases/latest) and running it. ### Installing from source: You can also build and install from source by cloning this project and running `make install` (Xcode 13.3 or later). ### Using Bazel Put this in your `MODULE.bazel`: ```bzl bazel_dep(name = "swiftlint", version = "0.50.4", repo_name = "SwiftLint") ``` Or put this in your `WORKSPACE`: <details> <summary>WORKSPACE</summary> ```bzl load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive") http_archive( name = "build_bazel_rules_apple", sha256 = "f94e6dddf74739ef5cb30f000e13a2a613f6ebfa5e63588305a71fce8a8a9911", url = "https://github.com/bazelbuild/rules_apple/releases/download/1.1.3/rules_apple.1.1.3.tar.gz", ) load( "@build_bazel_rules_apple//apple:repositories.bzl", "apple_rules_dependencies", ) apple_rules_dependencies() load( "@build_bazel_rules_swift//swift:repositories.bzl", "swift_rules_dependencies", ) swift_rules_dependencies() load( "@build_bazel_rules_swift//swift:extras.bzl", "swift_rules_extra_dependencies", ) swift_rules_extra_dependencies() http_archive( name = "SwiftLint", sha256 = "7c454ff4abeeecdd9513f6293238a6d9f803b587eb93de147f9aa1be0d8337c4", url = "https://github.com/realm/SwiftLint/releases/download/0.49.1/bazel.tar.gz", ) load("@SwiftLint//bazel:repos.bzl", "swiftlint_repos") swiftlint_repos() load("@SwiftLint//bazel:deps.bzl", "swiftlint_deps") swiftlint_deps() ``` </details> Then you can run SwiftLint in the current directory with this command: ```console bazel run -c opt @SwiftLint//:swiftlint ``` ## Usage ### Presentation To get a high-level overview of recommended ways to integrate SwiftLint into your project, we encourage you to watch this presentation or read the transcript: [](https://youtu.be/9Z1nTMTejqU) ### Xcode Integrate SwiftLint into your Xcode project to get warnings and errors displayed in the issue navigator. To do this select the project in the file navigator, then select the primary app target, and go to Build Phases. Click the + and select "New Run Script Phase". Insert the following as the script:  If you installed SwiftLint via Homebrew on Apple Silicon, you might experience this warning: > warning: SwiftLint not installed, download from https://github.com/realm/SwiftLint That is because Homebrew on Apple Silicon installs the binaries into the `/opt/homebrew/bin` folder by default. To instruct Xcode where to find SwiftLint, you can either add `/opt/homebrew/bin` to the `PATH` environment variable in your build phase ```bash export PATH="$PATH:/opt/homebrew/bin" if which swiftlint > /dev/null; then swiftlint else echo "warning: SwiftLint not installed, download from https://github.com/realm/SwiftLint" fi ``` or you can create a symbolic link in `/usr/local/bin` pointing to the actual binary: ```bash ln -s /opt/homebrew/bin/swiftlint /usr/local/bin/swiftlint ``` You might want to move your SwiftLint phase directly before the 'Compile Sources' step to detect errors quickly before compiling. However, SwiftLint is designed to run on valid Swift code that cleanly completes the compiler's parsing stage. So running SwiftLint before 'Compile Sources' might yield some incorrect results. If you wish to fix violations as well, your script could run `swiftlint --fix && swiftlint` instead of just `swiftlint`. This will mean that all correctable violations are fixed while ensuring warnings show up in your project for remaining violations. If you've installed SwiftLint via CocoaPods the script should look like this: ```bash "${PODS_ROOT}/SwiftLint/swiftlint" ``` ### Plug-in Support SwiftLint can be used as a build tool plug-in for both Xcode projects as well as Swift packages. > Due to limitations with Swift Package Manager Plug-ins this is only recommended for projects that have a SwiftLint configuration in their root directory as there is currently no way to pass any additional options to the SwiftLint executable. #### Xcode You can integrate SwiftLint as an Xcode Build Tool Plug-in if you're working with a project in Xcode. Add SwiftLint as a package dependency to your project without linking any of the products. Select the target you want to add linting to and open the `Build Phases` inspector. Open `Run Build Tool Plug-ins` and select the `+` button. Select `SwiftLintPlugin` from the list and add it to the project.  For unattended use (e.g. on CI), you can disable the package validation dialog by * individually passing `-skipPackagePluginValidation` to `xcodebuild` or * globally setting `defaults write com.apple.dt.Xcode IDESkipPackagePluginFingerprintValidatation -bool YES` for that user. _Note: This implicitly trusts all Xcode package plugins and bypasses Xcode's package validation dialogs, which has security implications._ #### Swift Package You can integrate SwiftLint as a Swift Package Manager Plug-in if you're working with a Swift Package with a `Package.swift` manifest. Add SwiftLint as a package dependency to your `Package.swift` file. Add SwiftLint to a target using the `plugins` parameter. ```swift .target( ... plugins: [.plugin(name: "SwiftLintPlugin", package: "SwiftLint")] ), ``` ### AppCode To integrate SwiftLint with AppCode, install [this plugin](https://plugins.jetbrains.com/plugin/9175) and configure SwiftLint's installed path in the plugin's preferences. The