RuleListDocumentation

public struct RuleListDocumentation

User-facing documentation for a SwiftLint RuleList.

Show on GitHub

  • Creates a RuleListDocumentation instance from a RuleList.

    Declaration

    Swift

    public init(_ list: RuleList)

    Parameters

    list

    A RuleList to document.
    Show on GitHub

  • Write the rule list documentation as markdown files to the specified directory.

    Throws

    Throws if the files could not be written to.

    Declaration

    Swift

    public func write(to url: URL) throws

    Parameters

    url

    Local URL for directory where the markdown files for this documentation should be saved.
    Show on GitHub