1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70
|
//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2014 - 2023 Apple Inc. and the Swift project authors
// Licensed under Apache License v2.0 with Runtime Library Exception
//
// See https://swift.org/LICENSE.txt for license information
// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
//
//===----------------------------------------------------------------------===//
import Foundation
import SwiftFormat
/// Generates the markdown file with extended documenation on the available rules.
final class RuleDocumentationGenerator: FileGenerator {
/// The rules collected by scanning the formatter source code.
let ruleCollector: RuleCollector
/// Creates a new rule registry generator.
init(ruleCollector: RuleCollector) {
self.ruleCollector = ruleCollector
}
func write(into handle: FileHandle) throws {
handle.write(
"""
<!-- This file is automatically generated with generate-swift-format. Do not edit! -->
# `swift-format` Lint and Format Rules
Use the rules below in the `rules` block of your `.swift-format`
configuration file, as described in
[Configuration](Documentation/Configuration.md). All of these rules can be
applied in the linter, but only some of them can format your source code
automatically.
Here's the list of available rules:
"""
)
for detectedRule in ruleCollector.allLinters.sorted(by: { $0.typeName < $1.typeName }) {
handle.write("""
- [\(detectedRule.typeName)](#\(detectedRule.typeName))
""")
}
for detectedRule in ruleCollector.allLinters.sorted(by: { $0.typeName < $1.typeName }) {
handle.write("""
### \(detectedRule.typeName)
\(detectedRule.description ?? "")
\(ruleFormatSupportDescription(for: detectedRule))
""")
}
}
private func ruleFormatSupportDescription(for rule: RuleCollector.DetectedRule) -> String {
return rule.canFormat ?
"`\(rule.typeName)` rule can format your code automatically." :
"`\(rule.typeName)` is a linter-only rule."
}
}
|