Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix generate-manual plugin authors argument #471

Merged
merged 1 commit into from Aug 25, 2022
Merged

Fix generate-manual plugin authors argument #471

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion Plugins/GenerateManualPlugin/GenerateManualPlugin.swift
View file
Open in desktop
Expand Up @@ -85,7 +85,7 @@ struct GenerateManualPlugin: CommandPlugin {
outputDirectory.string
]
generationToolArguments.append(
contentsOf: extractor.unextractedOptionsOrFlags)
contentsOf: extractor.remainingArguments)

// Spawn generation tool.
try generationToolFile.exec(arguments: generationToolArguments)
Expand Down
2 changes: 1 addition & 1 deletion Plugins/GenerateManualPlugin/GenerateManualPluginError.swift
View file
Open in desktop
Expand Up @@ -46,5 +46,5 @@ extension GenerateManualPluginError: CustomStringConvertible {
}

extension GenerateManualPluginError: LocalizedError {
var localizedDescription: String { self.description }
var errorDescription: String? { self.description }
}
2 changes: 2 additions & 0 deletions Tests/ArgumentParserGenerateManualTests/CountLinesGenerateManualTests.swift
View file
Open in desktop
Expand Up @@ -48,6 +48,7 @@ final class CountLinesGenerateManualTests: XCTestCase {
.An -nosplit
.An "Jane Appleseed" ,
.Mt johnappleseed@apple.com ,
and
.An -nosplit
.An "The Appleseeds"
.Ao
Expand Down Expand Up @@ -89,6 +90,7 @@ final class CountLinesGenerateManualTests: XCTestCase {
.An -nosplit
.An "Jane Appleseed" ,
.Mt johnappleseed@apple.com ,
and
.An -nosplit
.An "The Appleseeds"
.Ao
Expand Down
8 changes: 8 additions & 0 deletions Tests/ArgumentParserGenerateManualTests/MathGenerateManualTests.swift
View file
Open in desktop
Expand Up @@ -110,6 +110,7 @@ final class MathGenerateManualTests: XCTestCase {
.An -nosplit
.An "Jane Appleseed" ,
.Mt johnappleseed@apple.com ,
and
.An -nosplit
.An "The Appleseeds"
.Ao
Expand Down Expand Up @@ -150,6 +151,7 @@ final class MathGenerateManualTests: XCTestCase {
.An -nosplit
.An "Jane Appleseed" ,
.Mt johnappleseed@apple.com ,
and
.An -nosplit
.An "The Appleseeds"
.Ao
Expand Down Expand Up @@ -186,6 +188,7 @@ final class MathGenerateManualTests: XCTestCase {
.An -nosplit
.An "Jane Appleseed" ,
.Mt johnappleseed@apple.com ,
and
.An -nosplit
.An "The Appleseeds"
.Ao
Expand Down Expand Up @@ -222,6 +225,7 @@ final class MathGenerateManualTests: XCTestCase {
.An -nosplit
.An "Jane Appleseed" ,
.Mt johnappleseed@apple.com ,
and
.An -nosplit
.An "The Appleseeds"
.Ao
Expand Down Expand Up @@ -257,6 +261,7 @@ final class MathGenerateManualTests: XCTestCase {
.An -nosplit
.An "Jane Appleseed" ,
.Mt johnappleseed@apple.com ,
and
.An -nosplit
.An "The Appleseeds"
.Ao
Expand Down Expand Up @@ -293,6 +298,7 @@ final class MathGenerateManualTests: XCTestCase {
.An -nosplit
.An "Jane Appleseed" ,
.Mt johnappleseed@apple.com ,
and
.An -nosplit
.An "The Appleseeds"
.Ao
Expand Down Expand Up @@ -326,6 +332,7 @@ final class MathGenerateManualTests: XCTestCase {
.An -nosplit
.An "Jane Appleseed" ,
.Mt johnappleseed@apple.com ,
and
.An -nosplit
.An "The Appleseeds"
.Ao
Expand Down Expand Up @@ -379,6 +386,7 @@ final class MathGenerateManualTests: XCTestCase {
.An -nosplit
.An "Jane Appleseed" ,
.Mt johnappleseed@apple.com ,
and
.An -nosplit
.An "The Appleseeds"
.Ao
Expand Down
2 changes: 2 additions & 0 deletions Tests/ArgumentParserGenerateManualTests/RepeatGenerateManualTests.swift
View file
Open in desktop
Expand Up @@ -45,6 +45,7 @@ final class RepeatGenerateManualTests: XCTestCase {
.An -nosplit
.An "Jane Appleseed" ,
.Mt johnappleseed@apple.com ,
and
.An -nosplit
.An "The Appleseeds"
.Ao
Expand Down Expand Up @@ -85,6 +86,7 @@ final class RepeatGenerateManualTests: XCTestCase {
.An -nosplit
.An "Jane Appleseed" ,
.Mt johnappleseed@apple.com ,
and
.An -nosplit
.An "The Appleseeds"
.Ao
Expand Down
2 changes: 2 additions & 0 deletions Tests/ArgumentParserGenerateManualTests/RollDiceGenerateManualTests.swift
View file
Open in desktop
Expand Up @@ -50,6 +50,7 @@ final class RollDiceGenerateManualTests: XCTestCase {
.An -nosplit
.An "Jane Appleseed" ,
.Mt johnappleseed@apple.com ,
and
.An -nosplit
.An "The Appleseeds"
.Ao
Expand Down Expand Up @@ -95,6 +96,7 @@ final class RollDiceGenerateManualTests: XCTestCase {
.An -nosplit
.An "Jane Appleseed" ,
.Mt johnappleseed@apple.com ,
and
.An -nosplit
.An "The Appleseeds"
.Ao
Expand Down
22 changes: 20 additions & 2 deletions Tools/generate-manual/DSL/Authors.swift
View file
Open in desktop
Expand Up @@ -21,8 +21,26 @@ struct Authors: MDocComponent {
"The"
MDocMacro.DocumentName()
"reference was written by"
ForEach(authors) { author, last in
Author(author: author, trailing: last ? "." : ",")
ForEach(authors) { author, index in
switch index {
case authors.count - 2 where authors.count > 2:
Author(
author: author,
trailing: ",")
"and"
case authors.count - 2:
Author(
author: author,
trailing: "and")
case authors.count - 1:
Author(
author: author,
trailing: ".")
default:
Author(
author: author,
trailing: ",")
}
}
}
}
Expand Down
12 changes: 5 additions & 7 deletions Tools/generate-manual/DSL/Core/ForEach.swift
View file
Open in desktop
Expand Up @@ -11,24 +11,22 @@

struct ForEach<C>: MDocComponent where C: Collection {
var items: C
var builder: (C.Element, Bool) -> MDocComponent
var builder: (C.Element, C.Index) -> MDocComponent

init(_ items: C, @MDocBuilder builder: @escaping (C.Element, Bool) -> MDocComponent) {
init(_ items: C, @MDocBuilder builder: @escaping (C.Element, C.Index) -> MDocComponent) {
self.items = items
self.builder = builder
}

var body: MDocComponent {
guard !items.isEmpty else { return Empty() }
var currentIndex = items.startIndex
var last = false
var components = [MDocComponent]()
repeat {
while currentIndex < items.endIndex {
let item = items[currentIndex]
components.append(builder(item, currentIndex))
currentIndex = items.index(after: currentIndex)
last = currentIndex == items.endIndex
components.append(builder(item, last))
} while !last
}
return Container(children: components)
}
}
5 changes: 3 additions & 2 deletions Tools/generate-manual/DSL/SeeAlso.swift
View file
Open in desktop
Expand Up @@ -23,9 +23,10 @@ struct SeeAlso: MDocComponent {

var body: MDocComponent {
Section(title: "see also") {
ForEach(references) { reference, isLast in
ForEach(references) { reference, index in
MDocMacro.CrossManualReference(title: reference, section: section)
.withUnsafeChildren(nodes: isLast ? [] : [","])
.withUnsafeChildren(
nodes: index == references.count - 1 ? [] : [","])
}
}
}
Expand Down