docs: Add missing subcommand to manual CLI invocation example #76
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.
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 thePlugins/OpenAPIGenerator/plugin.swift
file was returning the correct command with thegenerate
argument. I was not able to import theSwiftOpenAPIGeneratorPlugin
struct from a test file, meaning that I was not able to do this.