このプロジェクトについて
SwiftLintは、Swiftコードのスタイルと規約を強制する人気のオープンソースツールで、現在アーカイブされているGitHub Swift Style Guideに大まかに基づいています。Swiftコミュニティで一般的に受け入れられているルールを強制し、KodecoのSwift Style Guideなどの人気スタイルガイドに記載されています。
このツールには200以上のルールが含まれており、主にSwiftSyntaxに基づいていますが、一部のルールは型情報を得るためにClangやSourceKitにフックします。ルールは.swiftlint.ymlファイルで設定でき、個々のルールはコメント(例:// swiftlint:disable rule_name)を使用してインラインで無効にできます。オプトインルールはデフォルトで無効になっており、明示的に有効にする必要があります。
SwiftLintは複数のインストール方法をサポートしています:Swift Package Manager(コマンドプラグインまたはビルドツールプラグインとして)、Xcodeパッケージ依存関係、Homebrew、CocoaPods、Mint、Bazel、事前ビルド済み.pkgインストーラ、およびソースからのビルドです。また、コンテナ化された使用のためのDockerイメージも提供しています。
統合オプションには、XcodeビルドツールプラグインとRun Script Build Phases、vscode-swiftlint拡張機能によるVisual Studio Code、Fastlaneのswiftlintアクション、Git pre-commitフック、CI集約用のMegaLinterが含まれます。このツールはコマンドラインから実行でき、linting、分析、ドキュメント生成、ルール一覧表示、およびベースライン操作のためのサブコマンドがあります。
SwiftLintはSourceKitにフックするため、完全なコンパイラを出荷せずに複数のSwiftバージョンで動作できます。環境変数とXcodeツールチェーンオーバーライドを通じて、複数のSwiftツールチェーンをサポートします。このプロジェクトは積極的にメンテナンスされており、プルリクエストを通じての貢献が奨励され、Contributor Covenant Code of Conductに準拠しています。
Comments
0 Rating appears after 10 ratings
Sign in to join the discussion.