Özel SwiftLint Kurallarının Gücünü Kucaklayın ve Regex'e Elveda Deyin

SwiftLint, kodlama standartlarını ve en iyi uygulamaları uygulamak için en iyi araçtır. Bireysel proje ihtiyaçlarına uyacak şekilde özelleştirilebilen önceden tanımlanmış kurallarla birlikte gelir. Ancak bazen yerleşik kurallar proje gereksinimlerini karşılayamaz. Bu gibi durumlarda boşluğu doldurmak için düzenli ifadeler yazarız. Regex güçlü bir araç olsa da karmaşık kurallar oluşturmak zor, hatta imkansız olabilir. Yerel SwiftLint kuralları burada devreye giriyor. Bunlar tıpkı SwiftLint ile gelen kurallar gibidir; Swift'de yazılmıştır, verimlidir ve regex'e kıyasla daha fazla ihlali yakalayabilir. https://twitter.com/simjp/status/1558168307756318720?s=20&embedable=true Nihai projeyi adresinde bulabilirsiniz. https://github.com/jpsim/swiftlint-bazel-example Projenin Kurulumu Kurulu değilse Bazel'i yükleyin. brew list --formula | grep -q "bazel" || brew install bazel Yeni bir dizin oluşturarak başlayın. mkdir MySwiftLintRules && cd MySwiftLintRules Ardından yeni bir Bazel çalışma alanı kurun. Bu, birkaç dosya oluşturmayı ve bzlmod'u etkinleştirmeyi içerir: touch .bazelrc WORKSPACE MODULE.bazel BUILD && echo "common --enable_bzlmod" > .bazelrc Standart kodu ekleyin 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") Standart kodu dosyasına ekleyin. Bu, Bazel projemize Xcode desteği ekleyecektir. 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", ], ) Kurallarınızın kaynak kodunu depolamak için bir dizin oluşturun. mkdir swiftlint_extra_rules && touch swiftlint_extra_rules/Rules.swift && touch swiftlint_extra_rules/BUILD Ve son kez standart kodu dosyasına yapıştırın. swiftlint_extra_rules/BUILD filegroup( name = "extra_rules", srcs = glob(["**/*.swift"]), visibility = ["//visibility:public"], ) Bu noktada komutunu kullanarak SwiftLint'i derleyebilmelisiniz. bazel build Xcode ile Kural Geliştirme Özel kurallarınızı geliştirmeyi kolaylaştırmak için projemize bağımlılığını ekledik. O halde projemizi oluşturalım: rules_xcodeproj bazel run swiftlint_xcodeproj && open SwiftLint.xcodeproj -a Xcode Artık şemasını oluşturup hatalarını ayıklayabiliriz. Bu uygulamayı, homebrew'dan yüklenen Swiftlint ikili dosyasıyla her zamanki gibi kullanabilirsiniz. swiftlint Projenizde çalıştırmayı deneyin: çubuğundaki şema adına tıklayın, “Şemayı Düzenle…”ye tıklayın ve "Seçenekler" sekmesindeki "Çalışma Dizini"ni SwiftLint'i çalıştırmak istediğiniz yola ayarlayın. Proje pencerenizin araç Yerel SwiftLint kuralları geliştirme hakkında daha fazla bilgi için SwiftLint'in göz atın. CONTRIBUTING.md sayfasına Özel Kural Ekleme Bu örnekte, adresindeki video eğitiminde gösterildiği gibi "yasak var kuralı"nı oluşturuyoruz. https://vimeo.com/819268038 Bu kodu kopyalayıp dosyasına yapıştırın, ardından şemasını Xcode'da çalıştırın. 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) } } } } Ve bu kadar! Özel bir SwiftLint kuralı oluşturdunuz ve bunu Bazel kullanarak Swift projenize entegre ettiniz. Bu kurulumla, ihtiyaç duyduğunuz sayıda özel kural oluşturup test edebilir, kodunuzun tutarlı kalmasını ve ekibinizin kodlama standartlarına uygun olmasını sağlamaya yardımcı olabilirsiniz. Mutlu tüyler!