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

[Sketch] Supplemental discussion #479

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

[Sketch] Supplemental discussion #479

wants to merge 5 commits into from

Commits on Nov 21, 2022

  1. Partially revert "Generate Manual" target name 

    - 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.
    @rauhul
    rauhul committed Nov 21, 2022
    Configuration menu
    Copy the full SHA
    d6b104c View commit details
    Browse the repository at this point in the history

  2. WIP: supplemental discussion 

    - 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 committed Nov 21, 2022
    Configuration menu
    Copy the full SHA
    85da077 View commit details
    Browse the repository at this point in the history

  3. update verbiage

    @rauhul
    rauhul committed Nov 21, 2022
    Configuration menu
    Copy the full SHA
    da1eece View commit details
    Browse the repository at this point in the history

  4. wip

    @rauhul
    rauhul committed Nov 21, 2022
    Configuration menu
    Copy the full SHA
    4a02221 View commit details
    Browse the repository at this point in the history

  5. wip: flag parsing and help generation

    @rauhul
    rauhul committed Nov 21, 2022
    Configuration menu
    Copy the full SHA
    ede9fca View commit details
    Browse the repository at this point in the history