Here's a summary of the changes I want to do to enable this:

Make all rules to take a dictionary. This will have the side effect of removing support to implicit configurations (Deprecate/remove implicit configurations #1475), but I think this is better in the longer term.
Add a var parameters: ParameterDefinition { get } on RuleConfiguration. This will be used for documentation and initing the variables in a RuleConfiguration.

This is a simple example for TrailingCommaConfiguration (removing the severity configuration for demonstration purposes):

protocol YamlLoadable {}

extension Bool: YamlLoadable {}

protocol ParameterDefinition {
    var key: String { get }
    var defaultValueDescription: String { get }
    var description: String { get }
}

struct Parameter<T: YamlLoadable>: ParameterDefinition {
    let key: String
    let `default`: T
    let description: String
    let defaultValueDescription: String

    func parse(from configuration: [String: Any]) throws -> T {
        if let value = configuration[key] as? T {
            return value
        } else if configuration[key] != nil {
            throw ConfigurationError.unknownConfiguration
        }

        return `default`
    }
}

public struct TrailingCommaConfiguration: RuleConfiguration, Equatable {
    private(set) var mandatoryComma: Bool

    private static let mandatoryCommaParam = Parameter(key: "mandatory_comma",
                                                       default: false,
                                                       description: "Is Mandatory comma",
                                                       defaultValueDescription: "false")

    static let parameters: [ParameterDefinition] = [mandatoryCommaParam]

    public init(mandatoryComma: Bool = mandatoryCommaParam.default) {
        self.mandatoryComma = mandatoryComma
    }

    public mutating func apply(configuration: [String: Any]) throws {
        mandatoryComma = try type(of: self).mandatoryCommaParam.parse(from: configuration)
    }
}

I'd love to hear more thoughts about this since it'd be quite a breaking change. // @jpsim

Add configurations to Rules.md #1653

Description

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Issue actions