[Sketch] Supplemental discussion #479
Draft
+361
−147
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
rauhul
changed the title
|
I'm kinda liking |
|
I think |
|
Hey! 👋 Is this skech pull request somehow related to #159? |
Yep this would close that issue once fleshed out and merged. |
rauhul
force-pushed
the
rauhul/supplementalDiscussion
branch
from
89bedad to
ae645fb
Compare
- 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.
- IDEA: additional discussion for commands and arguments which is exported to dump-help and can be consumed by supplemental content generators to contains much more detailed information than you may want to include in a help screen. Maybe a better idea would be to have --help-detailed flag that would include this information in the help output. Suggestions are welcome.
rauhul
force-pushed
the
rauhul/supplementalDiscussion
branch
from
ae645fb to
ede9fca
Compare
# for free
to join this conversation on GitHub.
Already have an account?
# to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
exported to dump-help and can be consumed by supplemental content
generators to contains much more detailed information than you may want
to include in a help screen.
Maybe a better idea would be to have --help-detailed flag that would
include this information in the help output. Suggestions are welcome.