mirror of
https://github.com/realm/SwiftLint.git
synced 2026-05-07 20:12:49 +00:00
Danny Mösch
91 lines
3.2 KiB
Swift
91 lines
3.2 KiB
Swift
/// Macro to be attached to rule configurations. It generates the configuration parsing logic
|
|
/// automatically based on the defined `@ConfigurationElement`s.
|
|
@attached(
|
|
member,
|
|
names: named(apply), named(Parent)
|
|
)
|
|
public macro AutoConfigParser() = #externalMacro(
|
|
module: "SwiftLintCoreMacros",
|
|
type: "AutoConfigParser"
|
|
)
|
|
|
|
/// Deprecated. Use `AutoConfigParser` instead.
|
|
@available(*, deprecated, renamed: "AutoConfigParser")
|
|
@attached(
|
|
member,
|
|
names: named(apply), named(Parent)
|
|
)
|
|
public macro AutoApply() = #externalMacro(
|
|
module: "SwiftLintCoreMacros",
|
|
type: "AutoConfigParser"
|
|
)
|
|
|
|
/// Macro that lets an enum with a ``String`` raw type automatically conform to ``AcceptableByConfigurationElement``.
|
|
@attached(
|
|
extension,
|
|
conformances: AcceptableByConfigurationElement,
|
|
names: named(init(fromAny:context:)), named(asOption)
|
|
)
|
|
public macro AcceptableByConfigurationElement() = #externalMacro(
|
|
module: "SwiftLintCoreMacros",
|
|
type: "AcceptableByConfigurationElement"
|
|
)
|
|
|
|
@attached(
|
|
extension,
|
|
names: named(notifyRuleDisabledOnce), named(postMessage)
|
|
)
|
|
public macro DisabledWithoutSourceKit() = #externalMacro(
|
|
module: "SwiftLintCoreMacros",
|
|
type: "DisabledWithoutSourceKit"
|
|
)
|
|
|
|
/// Deprecated. Use `AcceptableByConfigurationElement` instead.
|
|
@available(*, deprecated, renamed: "AcceptableByConfigurationElement")
|
|
@attached(
|
|
extension,
|
|
conformances: AcceptableByConfigurationElement,
|
|
names: named(init(fromAny:context:)), named(asOption)
|
|
)
|
|
public macro MakeAcceptableByConfigurationElement() = #externalMacro(
|
|
module: "SwiftLintCoreMacros",
|
|
type: "AcceptableByConfigurationElement"
|
|
)
|
|
|
|
/// Macro that adds a conformance to the ``SwiftSyntaxRule`` protocol and a default `makeVisitor(file:)` implementation
|
|
/// that creates a visitor defined in the rule struct.
|
|
///
|
|
/// - Parameters:
|
|
/// - foldExpressions: Setting it to `true` adds an implementation of `preprocess(file:)` which folds expressions
|
|
/// before they are passed to the visitor.
|
|
/// - explicitRewriter: Set it to `true` to add a `makeRewriter(file:)` implementation which creates a rewriter
|
|
/// defined in the rule struct. In this case, the rule automatically conforms to
|
|
/// ``SwiftSyntaxCorrectableRule``.
|
|
/// - correctable: Set it to `true` to make the rule conform to ``SwiftSyntaxCorrectableRule`` without an explicit
|
|
/// rewriter.
|
|
/// - optIn: Set it to `true` to make the rule conform to ``OptInRule``.
|
|
@attached(
|
|
extension,
|
|
conformances: SwiftSyntaxRule, SwiftSyntaxCorrectableRule, OptInRule, Rule,
|
|
names: named(makeVisitor(file:)), named(preprocess(file:)), named(makeRewriter(file:))
|
|
)
|
|
public macro SwiftSyntaxRule(foldExpressions: Bool = false,
|
|
explicitRewriter: Bool = false,
|
|
correctable: Bool = false,
|
|
optIn: Bool = false) = #externalMacro(
|
|
module: "SwiftLintCoreMacros",
|
|
type: "SwiftSyntaxRule"
|
|
)
|
|
|
|
@attached(body)
|
|
macro TemporaryDirectory() = #externalMacro(
|
|
module: "SwiftLintCoreMacros",
|
|
type: "TemporaryDirectory"
|
|
)
|
|
|
|
@attached(body)
|
|
macro WorkingDirectory(path: String) = #externalMacro(
|
|
module: "SwiftLintCoreMacros",
|
|
type: "WorkingDirectory"
|
|
)
|