Skip to content

Commit 8b8d89d

Browse files
d-ronnqvistd-ronnqvist
committed
Fix unrelated warning about a deprecated (renamed) DocC flag
1 parent 0284c97 commit 8b8d89d

File tree

6 files changed

+24
-25
lines changed

6 files changed

+24
-25
lines changed

‎Sources/SwiftDocCPluginUtilities/ParsedArguments.swift

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -174,10 +174,9 @@ public struct ParsedArguments {
174174
.outputPath,
175175
]
176176

177-
178177
/// The command-line flags required by the `docc` tool.
179178
private static let requiredFlags = [
180-
"--index",
179+
"--emit-lmdb-index",
181180
]
182181

183182
private static let argumentsTransformers: [ArgumentsTransforming] = [

‎Sources/SwiftDocCPluginUtilities/PluginFlags/DisableIndexFlag.swift

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ extension PluginFlag {
2323
argumentTransformation: { arguments in
2424
// Filter out any --index flags from the parsed arguments.
2525
return arguments.filter { argument in
26-
argument != "--index"
26+
argument != "--emit-lmdb-index"
2727
}
2828
}
2929
)

‎Sources/SwiftDocCPluginUtilities/PluginFlags/PluginFlag.swift

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -68,9 +68,9 @@ struct PluginFlag: ArgumentsTransforming {
6868
/// parsed values.
6969
///
7070
/// For example, if the flag's ``parsedValues`` are `["--disable-index"]`,
71-
/// and the given parsed arguments contain `["--disable-index", "--index"]`,
71+
/// and the given parsed arguments contain `["--disable-index", "--emit-lmdb-index"]`,
7272
/// then the transformation would both consume the `"--disable-index"` flag
73-
/// and remove the `"--index"` flag since indexing should be disabled.
73+
/// and remove the `"--emit-lmdb-index"` flag since indexing should be disabled.
7474
func transform(_ arguments: Arguments) -> Arguments {
7575
guard !parsedValues.isDisjoint(with: arguments) else {
7676
// The given parsed arguments do not contain any of this flags

‎Tests/SwiftDocCPluginUtilitiesTests/ParsedArgumentsTests.swift

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ final class ParsedArgumentsTests: XCTestCase {
5959
),
6060
[
6161
"convert",
62-
"--index",
62+
"--emit-lmdb-index",
6363
"--fallback-display-name", "MyTarget",
6464
"--fallback-bundle-identifier", "MyTarget",
6565
"--additional-symbol-graph-dir", "/my/symbol-graph",
@@ -78,7 +78,7 @@ final class ParsedArgumentsTests: XCTestCase {
7878
),
7979
[
8080
"preview",
81-
"--index",
81+
"--emit-lmdb-index",
8282
"--fallback-display-name", "MyTarget",
8383
"--fallback-bundle-identifier", "MyTarget",
8484
"--additional-symbol-graph-dir", "/my/symbol-graph",
@@ -98,7 +98,7 @@ final class ParsedArgumentsTests: XCTestCase {
9898
[
9999
"convert",
100100
"/my/catalog.docc",
101-
"--index",
101+
"--emit-lmdb-index",
102102
"--fallback-display-name", "MyTarget",
103103
"--fallback-bundle-identifier", "MyTarget",
104104
"--additional-symbol-graph-dir", "/my/symbol-graph",
@@ -124,7 +124,7 @@ final class ParsedArgumentsTests: XCTestCase {
124124
[
125125
"convert",
126126
"--fallback-display-name", "custom-display-name",
127-
"--index",
127+
"--emit-lmdb-index",
128128
"--fallback-bundle-identifier", "MyTarget",
129129
"--additional-symbol-graph-dir", "/my/symbol-graph",
130130
"--output-path", "/my/output-path"
@@ -147,7 +147,7 @@ final class ParsedArgumentsTests: XCTestCase {
147147
[
148148
"convert",
149149
"--fallback-bundle-identifier", "custom-bundle-identifier",
150-
"--index",
150+
"--emit-lmdb-index",
151151
"--fallback-display-name", "MyTarget",
152152
"--additional-symbol-graph-dir", "/my/symbol-graph",
153153
"--output-path", "/my/output-path"
@@ -170,7 +170,7 @@ final class ParsedArgumentsTests: XCTestCase {
170170
[
171171
"convert",
172172
"--additional-symbol-graph-dir", "/my/custom/symbol-graph",
173-
"--index",
173+
"--emit-lmdb-index",
174174
"--fallback-display-name", "MyTarget",
175175
"--fallback-bundle-identifier", "MyTarget",
176176
"--output-path", "/my/output-path",
@@ -193,7 +193,7 @@ final class ParsedArgumentsTests: XCTestCase {
193193
[
194194
"convert",
195195
"--output-path", "/my/custom/output-path",
196-
"--index",
196+
"--emit-lmdb-index",
197197
"--fallback-display-name", "MyTarget",
198198
"--fallback-bundle-identifier", "MyTarget",
199199
"--additional-symbol-graph-dir", "/my/symbol-graph",
@@ -222,7 +222,7 @@ final class ParsedArgumentsTests: XCTestCase {
222222
"convert",
223223
"--fallback-display-name", "custom-display-name",
224224
"--fallback-bundle-identifier", "custom-bundle-identifier",
225-
"--index",
225+
"--emit-lmdb-index",
226226
"--additional-symbol-graph-dir", "/my/symbol-graph",
227227
"--output-path", "/my/output-path",
228228
]
@@ -252,7 +252,7 @@ final class ParsedArgumentsTests: XCTestCase {
252252
"--fallback-bundle-identifier", "custom-bundle-identifier",
253253
"--additional-symbol-graph-dir", "/my/custom/symbol-graph",
254254
"--output-path", "/my/custom/output-path",
255-
"--index",
255+
"--emit-lmdb-index",
256256
]
257257
)
258258
}
@@ -349,7 +349,7 @@ final class ParsedArgumentsTests: XCTestCase {
349349
"convert",
350350
"/my/catalog.docc",
351351
"--transform-for-static-hosting",
352-
"--index",
352+
"--emit-lmdb-index",
353353
"--fallback-display-name", "MyTarget",
354354
"--fallback-bundle-identifier", "MyTarget",
355355
"--additional-symbol-graph-dir", "/my/symbol-graph",
@@ -384,7 +384,7 @@ final class ParsedArgumentsTests: XCTestCase {
384384
"--analyze",
385385
"--fallback-display-name", "custom-display-name",
386386
"--output-path", "/my/custom/output-path",
387-
"--index",
387+
"--emit-lmdb-index",
388388
"--fallback-bundle-identifier", "MyTarget",
389389
"--additional-symbol-graph-dir", "/my/symbol-graph",
390390
]
@@ -408,7 +408,7 @@ final class ParsedArgumentsTests: XCTestCase {
408408
[
409409
"convert",
410410
"/my/catalog.docc",
411-
"--index",
411+
"--emit-lmdb-index",
412412
"--fallback-display-name", "MyTarget",
413413
"--fallback-bundle-identifier", "MyTarget",
414414
"--additional-symbol-graph-dir", "/my/symbol-graph",
@@ -434,7 +434,7 @@ final class ParsedArgumentsTests: XCTestCase {
434434
"convert",
435435
"/my/catalog.docc",
436436
"--fallback-default-module-kind", "Executable",
437-
"--index",
437+
"--emit-lmdb-index",
438438
"--fallback-display-name", "MyTarget",
439439
"--fallback-bundle-identifier", "MyTarget",
440440
"--additional-symbol-graph-dir", "/my/symbol-graph",

‎Tests/SwiftDocCPluginUtilitiesTests/PluginFlags/DisableIndexFlagTests.swift

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,21 +14,21 @@ final class DisableIndexFlagTests: XCTestCase {
1414
func testRemovesIndexFlagWhenPresent() {
1515
XCTAssertEqual(
1616
PluginFlag.disableIndex.transform(
17-
["--disable-indexing", "--index", "--other-flag"]
17+
["--disable-indexing", "--emit-lmdb-index", "--other-flag"]
1818
),
1919
["--other-flag"]
2020
)
2121

2222
XCTAssertEqual(
2323
PluginFlag.disableIndex.transform(
24-
["--no-indexing", "--index", "--other-flag"]
24+
["--no-indexing", "--emit-lmdb-index", "--other-flag"]
2525
),
2626
["--other-flag"]
2727
)
2828

2929
XCTAssertEqual(
3030
PluginFlag.disableIndex.transform(
31-
["--no-indexing", "--disable-indexing", "--index", "--other-flag"]
31+
["--no-indexing", "--disable-indexing", "--emit-lmdb-index", "--other-flag"]
3232
),
3333
["--other-flag"]
3434
)
@@ -37,9 +37,9 @@ final class DisableIndexFlagTests: XCTestCase {
3737
func testDoesNotRemoveIndexFlagWhenNotPresent() {
3838
XCTAssertEqual(
3939
PluginFlag.disableIndex.transform(
40-
["--index", "--other-flag"]
40+
["--emit-lmdb-index", "--other-flag"]
4141
),
42-
["--index", "--other-flag"]
42+
["--emit-lmdb-index", "--other-flag"]
4343
)
4444
}
4545

‎Tests/SwiftDocCPluginUtilitiesTests/PluginFlags/SkipSynthesizedSymbolsFlagTests.swift

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,9 @@ final class SkipSynthesizedSymbolsFlagTests: XCTestCase {
1414
func testNotTransformExistingFlagsWhenPresent() {
1515
XCTAssertEqual(
1616
PluginFlag.skipSynthesizedSymbols.transform(
17-
["--index", "--other-flag"]
17+
["--emit-lmdb-index", "--other-flag"]
1818
),
19-
["--index", "--other-flag"]
19+
["--emit-lmdb-index", "--other-flag"]
2020
)
2121
}
2222
}

0 commit comments

Comments
 (0)