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

docs: Add missing subcommand to manual CLI invocation example #76

Merged
merged 2 commits into from
Jun 19, 2023

Conversation

miguel-arrf
Copy link
Contributor

Motivation

While I was doing some changes to other parts of the code, I had to manually run the CLI to obtain the generated code, however, the command was not working. Only after did I realize that the generate keyword was missing!

Modifications

Modified the Manually-invoking-the-generator-CLI.md file to fix the CLI command instruction.

Result

Users now know how to properly manually execute the CLI.

Test Plan

As of now I didn't add any tests for this. I'm not really sure where to start. My idea was to check if the function createBuildCommands from the Plugins/OpenAPIGenerator/plugin.swift file was returning the correct command with the generate argument. I was not able to import the SwiftOpenAPIGeneratorPlugin struct from a test file, meaning that I was not able to do this.

Copy link
Contributor

@czechboy0 czechboy0 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice catch, thank you!

@czechboy0 czechboy0 requested a review from simonjbeaumont June 19, 2023 14:56
@simonjbeaumont simonjbeaumont changed the title Fixes the command to manually invoke the CLI docs: Add missing subcommand to manual CLI invocation example Jun 19, 2023
@simonjbeaumont simonjbeaumont merged commit 2c9fc55 into apple:main Jun 19, 2023
@czechboy0 czechboy0 added the semver/none No version bump required. label Jun 20, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
semver/none No version bump required.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants