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
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
|
/*
This source file is part of the Swift.org open source project
Copyright (c) 2021-2022 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
/// Checks for non-inclusive language in documentation.
///
/// Unlike the other checkers, this type performs global analysis on all types of documentation.
public struct NonInclusiveLanguageChecker: Checker {
/// The severity for this checker's diagnostics.
public static let severity: DiagnosticSeverity = .information
public var problems: [Problem] = []
/// The list of terms to search for in documentation.
///
/// This type has a built-in list of terms to look for, but a custom array of terms can be passed at
/// initialization.
private var terms: [Term]
/// The URL of the documentation file being analyzed.
private var sourceFile: URL?
/// A structure that represents a term to match in content.
public struct Term: Codable {
/// The term to search for in the content.
///
/// - Note: This property will be treated as a regular expression, so normal regular expression
/// syntax is supported.
public let expression: String
/// A user-facing message explaining why the term is problematic.
public let message: String
/// The suggested replacement for the word.
public let replacement: String
}
public init(sourceFile: URL?, terms: [Term]? = nil) {
self.sourceFile = sourceFile
self.terms = terms ?? builtinExcludedTerms
}
public mutating func visitCodeBlock(_ codeBlock: CodeBlock) -> () {
for term in terms {
let termRanges = ranges(for: term, in: codeBlock.code, of: codeBlock)
termRanges.forEach { range in
// Need to offset the lines by +1 to take into account the start
// of the code fence
let start = SourceLocation(
line: range.lowerBound.line + 1,
column: range.lowerBound.column,
source: sourceFile
)
let end = SourceLocation(
line: range.upperBound.line + 1,
column: range.upperBound.column,
source: sourceFile
)
let offseted = start..<end
matched(term, at: offseted)
}
}
}
public mutating func visitInlineCode(_ inlineCode: InlineCode) -> () {
for term in terms {
let termRanges = ranges(for: term, in: inlineCode.code, of: inlineCode)
termRanges.forEach { range in
// Need to offset the columns by +1 to account for the `
let start = SourceLocation(
line: range.lowerBound.line,
column: range.lowerBound.column + 1,
source: sourceFile
)
let end = SourceLocation(
line: range.upperBound.line,
column: range.upperBound.column + 1,
source: sourceFile
)
let offseted = start..<end
matched(term, at: offseted)
}
}
}
public mutating func visitText(_ text: Text) {
for term in terms {
ranges(for: term, in: text.string, of: text).forEach { matched(term, at: $0) }
}
}
/// Creates a new diagnostic describing where a term was found.
/// - Note: This method has the side-effect of appending the new diagnostic to `self.problems`.
/// - Parameters:
/// - term: The term that was found.
/// - range: The range at which the term was found in the current file.
mutating func matched(_ term: Term, at range: SourceRange?) {
let diagnostic = Diagnostic(
source: sourceFile,
severity: Self.severity,
range: range,
identifier: "org.swift.docc.NonInclusiveLanguage",
summary: "Non-inclusive language.",
explanation: term.message
)
var solutions: [Solution] = []
if let range {
let replacement = Replacement(range: range, replacement: term.replacement)
let solution = Solution(summary: "Replace with \(term.replacement.singleQuoted)", replacements: [replacement])
solutions.append(solution)
}
let problem = Problem(diagnostic: diagnostic, possibleSolutions: solutions)
problems.append(problem)
}
/// Checks for a term in text.
///
/// The regular expression created from the provided term is evaluated with the case insensitive flag.
///
/// - Parameters:
/// - term: The term to look for.
/// - text: The text to check.
/// - markup: The markup element that contains the text.
/// - Returns: An array of ranges at which the term was found.
/// > Warning: Crashes if the term expression pattern is not valid.
func ranges(for term: Term, in text: String, of markup: Markup) -> [SourceRange] {
var ranges = [SourceRange]()
let regex = try! defaultRegularExpressions[term.expression]
?? NSRegularExpression(pattern: term.expression, options: [.caseInsensitive])
let range = NSRange(text.startIndex..., in: text)
let matches = regex.matches(in: text, range: range)
for match in matches {
if let startCursor = PrintCursor(offset: match.range.location, in: text),
let endCursor = PrintCursor(offset: NSMaxRange(match.range), in: text),
let markupRange = markup.range {
let start = SourceLocation(
line: markupRange.lowerBound.line + startCursor.line - 1,
column: startCursor.column + markupRange.lowerBound.column - 1,
source: sourceFile
)
let end = SourceLocation(
line: markupRange.lowerBound.line + endCursor.line - 1,
column: start.column + match.range.length,
source: sourceFile
)
let range = start..<end
ranges.append(range)
}
}
return ranges
}
}
/// The default list of terms to look for in documentation.
fileprivate let builtinExcludedTerms: [NonInclusiveLanguageChecker.Term] = [
NonInclusiveLanguageChecker.Term(
expression: #"black\W*list\w{0,2}"#,
message: "Choose a more inclusive alternative that’s appropriate to the context, such as deny list/allow list or unapproved list/approved list.",
replacement: "deny list"
),
NonInclusiveLanguageChecker.Term(
expression: #"master\w{0,2}"#,
message: #"Don't use "master" to describe the relationship between two devices, processes, or other things. Use an alternative that's appropriate to the context, such as "main" and "secondary" or "host" and "client"."#,
replacement: "primary"
),
NonInclusiveLanguageChecker.Term(
expression: #"slave\w{0,2}"#,
message: #"Don't use "slave" to describe the relationship between two devices, processes, or other things. Use an alternative that's appropriate to the context, such as "main" and "secondary" or "host" and "client"."#,
replacement: "secondary"
),
NonInclusiveLanguageChecker.Term(
expression: #"white\W*list\w{0,2}"#,
message: "Choose a more inclusive alternative that’s appropriate to the context, such as deny list/allow list or unapproved list/approved list.",
replacement: "allow list"
)
]
/// The regular expressions for the default term list.
fileprivate let defaultRegularExpressions: [String: NSRegularExpression] = builtinExcludedTerms.reduce(into: [:]) { result, term in
if let regex = try? NSRegularExpression(pattern: term.expression, options: .caseInsensitive) {
result[term.expression] = regex
}
}
|
