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.

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

[Sketch] Supplemental discussion #479

Draft
wants to merge 5 commits into
base: main
Choose a base branch
from
Draft

Conversation

rauhul
Copy link
Contributor

@rauhul rauhul commented Aug 29, 2022

  • 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 rauhul changed the title IDEA: Supplemental discussion [Sketch] Supplemental discussion Aug 29, 2022
@rauhul
Copy link
Contributor Author

rauhul commented Aug 29, 2022

I'm kinda liking --help-detailed (--detailed-help) and renaming this property detailedDiscussion.

@natecook1000
Copy link
Member

I think --help-detailed makes a lot of sense! We could/should also detect when that's a reasonable option and add it to the help screen (along with --help-hidden when there are hidden args).

@arthurcro
Copy link

Hey! 👋 Is this skech pull request somehow related to #159?

@rauhul
Copy link
Contributor Author

rauhul commented Oct 2, 2022

Hey! 👋 Is this skech pull request somehow related to #159?

Yep this would close that issue once fleshed out and merged.

@rauhul rauhul force-pushed the rauhul/supplementalDiscussion branch from 89bedad to ae645fb Compare November 21, 2022 17:37
- 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 rauhul force-pushed the rauhul/supplementalDiscussion branch from ae645fb to ede9fca Compare November 21, 2022 22:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants