Macros Reference


                    
                    
                    AutoConfigParser()

Macro to be attached to rule configurations. It generates the configuration parsing logic automatically based on the defined @ConfigurationElements.

Declaration

Swift

@attached(member, names: named(apply)
) public macro AutoConfigParser() = #externalMacro(
    module: "SwiftLintCoreMacros",
    type: "AutoConfigParser"
)

Show on GitHub


                    
                    
                    AcceptableByConfigurationElement()

Macro that lets an enum with a String raw type automatically conform to AcceptableByConfigurationElement.

Declaration

Swift

@attached(extension, conformances: AcceptableByConfigurationElement, names: named(init(fromAny:context:)
), named(asOption)) public macro AcceptableByConfigurationElement() = #externalMacro(
    module: "SwiftLintCoreMacros",
    type: "AcceptableByConfigurationElement"
)

Show on GitHub


                    
                    
                    SwiftSyntaxRule(foldExpressions:explicitRewriter:correctable:optIn:)

Macro that adds a conformance to the SwiftSyntaxRule protocol and a default makeVisitor(file:) implementation that creates a visitor defined in the rule struct.

Declaration

Swift

@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"
)

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`.

Show on GitHub