Skip to content

Commit 8f7e87b

Browse files
authored
Partially revert "Generate Manual" target name (#527)
- The name of "GenerateManualPlugin" was changed to "Generate Manual" to improve the plugin's display name in Xcode. This however results in the `.pluginWorkDirectory` provided by SPM to include a space (' ') in the path. The space in the output path by itself is not a deal breaker, but unfortunately `man` (at least on macOS) does not properly handle path arguments with spaces. Example: ```shell ➜ swift package generate-manual ... Generating manual for roll... Generated manual in '.build/plugins/Generate Manual/outputs/roll' ... ➜ man '.build/plugins/Generate Manual/outputs/roll/roll.1' /usr/bin/man: line 413: cd: .build/plugins/Generate: No such file or \ directory ``` IMO, easily previewing the generating manual takes precedence over the UI in Xcode; as a result, this commit partially reverts the plugin's name to "GenerateManual" to hopefully provide a good middle ground of an output path without a space and a display name in Xcode that is a little easier on the eyes than "GenerateManualPlugin" was.
1 parent bc29743 commit 8f7e87b

File tree

4 files changed

+4
-5
lines changed

4 files changed

+4
-5
lines changed

[email protected]

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,8 @@ var package = Package(
1919
name: "ArgumentParser",
2020
targets: ["ArgumentParser"]),
2121
.plugin(
22-
name: "GenerateManualPlugin",
23-
targets: ["Generate Manual"]),
22+
name: "GenerateManual",
23+
targets: ["GenerateManual"]),
2424
],
2525
dependencies: [],
2626
targets: [
@@ -40,13 +40,12 @@ var package = Package(
4040

4141
// Plugins
4242
.plugin(
43-
name: "Generate Manual",
43+
name: "GenerateManual",
4444
capability: .command(
4545
intent: .custom(
4646
verb: "generate-manual",
4747
description: "Generate a manual entry for a specified target.")),
48-
dependencies: ["generate-manual"],
49-
path: "Plugins/GenerateManualPlugin"),
48+
dependencies: ["generate-manual"]),
5049

5150
// Examples
5251
.executableTarget(

0 commit comments

Comments
 (0)