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
|
/*
This source file is part of the Swift.org open source project
Copyright (c) 2021 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 Swift project authors
*/
import Foundation
import Markdown
extension Semantic.Analyses {
public struct HasOnlyKnownArguments<Parent: Semantic & DirectiveConvertible>: SemanticAnalysis {
let severityIfFound: DiagnosticSeverity?
let allowedArguments: [String]
public init(severityIfFound: DiagnosticSeverity?, allowedArguments: [String]) {
self.severityIfFound = severityIfFound
self.allowedArguments = allowedArguments
}
public func analyze(_ directive: BlockDirective, children: some Sequence<Markup>, source: URL?, for bundle: DocumentationBundle, in context: DocumentationContext, problems: inout [Problem]) -> [String: Markdown.DirectiveArgument] {
let arguments = directive.arguments(problems: &problems)
if let severity = severityIfFound {
let unknownKeys = Set(arguments.keys).subtracting(allowedArguments)
let unusedKeys = Set(allowedArguments).subtracting(arguments.keys)
let unknownKeyIssues: [String] = unknownKeys.lazy.map { unknownKey in
var summary = "Unknown argument '\(unknownKey)' in \(Parent.directiveName)."
if !unusedKeys.isEmpty {
let unusedKeyList = unusedKeys.sorted().map { "'\($0)'"}.joined(separator: ", ")
summary += " These arguments are currently unused but allowed: \(unusedKeyList)."
}
return summary
}
let newProblems: [Problem] = unknownKeyIssues.map { summary in
let diagnostic = Diagnostic(source: source, severity: severity, range: directive.range, identifier: "org.swift.docc.UnknownArgument", summary: summary)
return Problem(diagnostic: diagnostic, possibleSolutions: [])
}
problems.append(contentsOf: newProblems)
}
return arguments
}
}
}
|
