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

GenerateManualPlugin is not available as package plugin #455

Closed
2 tasks done
MarcoEidinger opened this issue Jul 17, 2022 · 2 comments · Fixed by #456
Closed
2 tasks done

GenerateManualPlugin is not available as package plugin #455

MarcoEidinger opened this issue Jul 17, 2022 · 2 comments · Fixed by #456

Comments

@MarcoEidinger
Copy link
Contributor

MarcoEidinger commented Jul 17, 2022 •
edited

ArgumentParser version: 1.1.3
Swift version: 5.6

Checklist

  • If possible, I've reproduced the issue using the main branch of this package
  • I've searched for existing GitHub issues

Relates to

ArgumentParser includes a SwiftPM plugin for generating man pages. Explore the functionality and configuration by running swift package plugin experimental-generate-manual --help from your package root. (#332)

Steps to Reproduce

Add ArgumentParser as a package dependency to an existing package

    dependencies: [
        // other dependencies
        .package(url: "https://github.com/apple/swift-argument-parser", from: "1.1.3"),
    ],

Run command to list available plugins

swift package plugin --list

Expected behavior

Expected that GenerateManualPlugin is shown as available plugin

‘experimental-generate-manual’ (plugin ‘GenerateManualPlugin’ in package ‘swift-argument-parser’)

Actual behavior

No plugin(s) are listed
MarcoEidinger added a commit to MarcoEidinger/swift-argument-parser that referenced this issue Jul 17, 2022
@MarcoEidinger
fix: 🐛 Declare GenerateManualPlugin as plugin product
4bfb3ca 
✅ Closes: apple#455
@MarcoEidinger MarcoEidinger mentioned this issue Jul 17, 2022
Merged
4 tasks
rauhul pushed a commit that referenced this issue Aug 13, 2022
@MarcoEidinger
fix: 🐛 Declare GenerateManualPlugin as plugin product (#456)
898d1ae 
`ArgumentParser` 1.1.3 includes a SwiftPM plugin for generating man
pages. However, this plugin is not visible to packages that declare
`ArgumentParser` as a package dependency.

Defining a product of type `plugin` in the package manifest will solve
that. Running `swift package plugin --list` for a package, that
declares `ArgumentParser` as a package dependency, will then list the
`GenerateManualPlugin`

```
‘experimental-generate-manual’ (plugin ‘GenerateManualPlugin’ in package ‘swift-argument-parser’)
```

Closes: #455
@MarcoEidinger
Copy link
Contributor Author

@rauhul I am so happy to see that fix merged! What is the ETA for a new release (1.1.4) that will include the fix? After all, the feature to generate man pages is otherwise only working for people pinning to the main branch.

@MarcoEidinger
Copy link
Contributor Author

@natecook1000 what is the ETA for a new release (1.1.4) that will include the fix?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

fix: 🐛 Declare GenerateManualPlugin as plugin product MarcoEidinger/swift-argument-parser
1 participant
@MarcoEidinger