SwiftLint は、コーディング標準とベスト プラクティスを強制するための最良のツールです。個々のプロジェクトのニーズに合わせてカスタマイズできる事前定義されたルールが付属しています。ただし、組み込みルールがプロジェクトの要件を満たしていない場合があります。このような場合、ギャップを埋めるために正規表現を作成します。 正規表現は強力なツールですが、複雑なルールの作成は困難または不可能になる場合があります。ここで、ネイティブの SwiftLint ルールが登場します。これらは SwiftLint に付属のルールと同様です。Swift で書かれており、効率的で、正規表現と比較してより多くの違反を検出できます。   https://twitter.com/simjp/status/1558168307756318720?s=20&embedable=true 最終的なプロジェクトは にあります。 https://github.com/jpsim/swiftlint-bazel-example プロジェクトのセットアップ Bazel がインストールされていない場合はインストールします。   brew list --formula | grep -q "bazel" || brew install bazel まず、新しいディレクトリを作成します。   mkdir MySwiftLintRules && cd MySwiftLintRules 次に、新しい Bazel ワークスペースをセットアップします。これには、いくつかのファイルを作成し、bzlmod を有効にすることが含まれます。   touch .bazelrc WORKSPACE MODULE.bazel BUILD && echo "common --enable_bzlmod" > .bazelrc 定型コードを に追加します。 MODULE.bazel   module( name = "swiftlint-bazel-example", version = "0.0.0", compatibility_level = 1 ) bazel_dep(name = "swiftlint", version = "0.51.0", repo_name = "SwiftLint") extra_rules = use_extension("@SwiftLint//bazel:extensions.bzl", "extra_rules") extra_rules.setup(srcs = "@swiftlint-bazel-example//swiftlint_extra_rules:extra_rules") bazel_dep(name = "rules_xcodeproj", version = "1.4.0") 定型コードを ファイルに追加します。これにより、Bazel プロジェクトに Xcode サポートが追加されます。 BUILD   load("@rules_xcodeproj//xcodeproj:defs.bzl", "xcodeproj") xcodeproj( name = "swiftlint_xcodeproj", project_name = "SwiftLint", tags = ["manual"], top_level_targets = [ "@SwiftLint//:swiftlint", "@SwiftLint//Tests:ExtraRulesTests", ], ) ルールのソース コードを保存するディレクトリを作成します。   mkdir swiftlint_extra_rules && touch swiftlint_extra_rules/Rules.swift && touch swiftlint_extra_rules/BUILD 最後に、定型コードを ファイルに貼り付けます。 swiftlint_extra_rules/BUILD   filegroup( name = "extra_rules", srcs = glob(["**/*.swift"]), visibility = ["//visibility:public"], ) この時点で、  コマンドを使用して SwiftLint をビルドできるようになります。 bazel build  Xcode を使用したルールの開発 カスタム ルールの開発を容易にするために、プロジェクトに 依存関係を追加しました。それでは、プロジェクトを生成しましょう。 rules_xcodeproj   bazel run swiftlint_xcodeproj && open SwiftLint.xcodeproj -a Xcode これで、  スキームを構築してデバッグできるようになりました。このアプリは、Homebrew からインストールされた swiftlint バイナリで通常どおり使用できます。 swiftlint プロジェクトで実行してみてください。  でスキーム名をクリックし、「スキームの編集…」をクリックして、「オプション」タブの「作業ディレクトリ」を SwiftLint を実行するパスに設定します。 プロジェクト ウィンドウのツールバー ネイティブ SwiftLint ルールの開発の詳細については、SwiftLint の を確認してください。 COTRIBUTING.md カスタムルールの追加 この例では、  のビデオ チュートリアルで示されているように、「禁止された var ルール」を作成します。 https://vimeo.com/819268038 このコードをコピーして ファイルに貼り付け、Xcode で スキームを実行します。 Rules.swift swiftlint   import SwiftSyntax // This function should return an array containing all of your custom rules func extraRules() -> [Rule.Type] { [ForbiddenVarRule.self] } struct ForbiddenVarRule: ConfigurationProviderRule, SwiftSyntaxRule { var configuration = SeverityConfiguration(.error) init() {} static let description = RuleDescription( identifier: "forbidden_var", name: "Forbidden Var", description: "Variables should not be called 'forbidden'", kind: .idiomatic, nonTriggeringExamples: [ Example("let notForbidden = 0") ], triggeringExamples: [ Example("let ↓forbidden = 0") ] ) func makeVisitor(file: SwiftLintFile) -> ViolationsSyntaxVisitor { Visitor(viewMode: .sourceAccurate) } } private extension ForbiddenVarRule { final class Visitor: ViolationsSyntaxVisitor { override func visitPost(_ node: IdentifierPatternSyntax) { if node.identifier.text == "forbidden" { violations.append(node.identifier.positionAfterSkippingLeadingTrivia) } } } } 以上です！カスタム SwiftLint ルールを作成し、Bazel を使用して Swift プロジェクトに統合しました。この設定を使用すると、必要なだけカスタム ルールを作成してテストできるため、コードの一貫性が維持され、チームのコーディング標準に準拠していることを確認できます。 リンティングを楽しんでください！

Read My Stories

このオーディオは、ストーリーの元の言語で制作されています。

カスタム SwiftLint ルールのパワーを活用し、正規表現に別れを告げましょう

About Author

コメント

ラベル

この記事は

Related Stories

デジタルノマドの皆さん、タイの新しい DTV ビザについて知っておくべきこと

18 種類の開発者ツールで生産性を向上しましょう 🚀🔥

フォーラムからフィードへ: ソーシャルメディアアルゴリズムがデジタルインタラクションを形作る仕組み

HackerNoon Coded: HackerNoonが最も活発に活動している上位10カ国

デジタルノマドの皆さん、タイの新しい DTV ビザについて知っておくべきこと

18 種類の開発者ツールで生産性を向上しましょう 🚀🔥

フォーラムからフィードへ: ソーシャルメディアアルゴリズムがデジタルインタラクションを形作る仕組み

HackerNoon Coded: HackerNoonが最も活発に活動している上位10カ国

Light-Mode

Classic

Newspaper

Minty

Dark-Mode

Neon Noir

Minty

HN StartUps