SwiftLintCore Enumerations OptionType Enumeration Reference

OptionType

public enum OptionType : Equatable, Sendable

extension OptionType: Documentable

Type of an option.

Show on GitHub

empty
An irrelevant option. It will be ignored in documentation serialization.
Declaration
Swift

case empty
Show on GitHub
flag(_:)
A boolean flag.
Declaration
Swift

case flag(Bool)
Show on GitHub
string(_:)
A string option.
Declaration
Swift

case string(String)
Show on GitHub
symbol(_:)
Like a string option but without quotes in the serialized output.
Declaration
Swift

case symbol(String)
Show on GitHub
integer(_:)
An integer option.
Declaration
Swift

case integer(Int)
Show on GitHub
float(_:)
A floating point number option.
Declaration
Swift

case float(Double)
Show on GitHub
severity(_:)
Special option for a ViolationSeverity.
Declaration
Swift

case severity(ViolationSeverity)
Show on GitHub
list(_:)
A list of options.
Declaration
Swift

case list([`Self`])
Show on GitHub
nested(_:)
An option which is another set of configuration options to be nested in the serialized output.
Declaration
Swift

case nested(RuleConfigurationDescription)
Show on GitHub
hasContent
Declaration
Swift

public var hasContent: Bool { get }
Show on GitHub
markdown()
Declaration
Swift

public func markdown() -> String
Show on GitHub
oneLiner()
Declaration
Swift

public func oneLiner() -> String
Show on GitHub
yaml()
Declaration
Swift

public func yaml() -> String
Show on GitHub

Result builder


                    
                    
                    =>(_:_:)

Operator enabling an easy way to create a configuration option.

Declaration

Swift

static func => (key: String, value: OptionType) -> RuleConfigurationOption

Parameters

`key`	Name of the option.
`value`	Value of the option.

Return Value

A configuration option built up by the given data.

Show on GitHub


                    
                    
                    nest(_:)

Create an option defined by nested configuration description.

Declaration

Swift

static func nest(@RuleConfigurationDescriptionBuilder _ description: () -> RuleConfigurationDescription) -> OptionType

Parameters


                                description

A configuration description buildable by applying the result builder syntax.

Return Value

A configuration option with a value being another configuration description.

Show on GitHub