automatic command doc gen for plugins #18029
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This was referenced Jan 10, 2023
|
Current dependencies on/for this PR:
This comment was auto-generated by Graphite. |
boneskull
force-pushed
the
boneskull/typedoc-plugin
branch
from
0e0ac84
to
3dce433
Compare
boneskull
added
Enhancement
boneskull
commented
Jan 10, 2023
| * @param {string} script - the string representing the driver script to run | ||
| * @param {string} [scriptType='webdriverio'] - the name of the driver script | ||
| * library (currently only webdriverio is supported) | ||
| * @param {number} [timeoutMs=3600000] - timeout for the script process | ||
| * | ||
| * @returns {Object} - a JSONifiable object representing the return value of | ||
| * @returns {Promise<any>} - a JSONifiable object representing the return value of |
There was a problem hiding this comment.
Note that an invalid return type (non-Promise<T>) prevents documentation from getting generated for a command, so we need to be careful about it. No error will be generated by TS even though it's an async function (which must return a Promise<T>). TS (and thus TypeDoc) "believe" the function returns whatever is in @returns.
There was a problem hiding this comment.
yep good to know. i'm sure this was my type mistake
jlipps
approved these changes
Jan 10, 2023
| * @param {string} script - the string representing the driver script to run | ||
| * @param {string} [scriptType='webdriverio'] - the name of the driver script | ||
| * library (currently only webdriverio is supported) | ||
| * @param {number} [timeoutMs=3600000] - timeout for the script process | ||
| * | ||
| * @returns {Object} - a JSONifiable object representing the return value of | ||
| * @returns {Promise<any>} - a JSONifiable object representing the return value of |
There was a problem hiding this comment.
yep good to know. i'm sure this was my type mistake
maybe some day we will even use this!
Most of this "just works", but the additional parameters to a plugin command need special handling. To do that, we have to understand what is a plugin and what is not. Note that this is incompatible with the "mixin" pattern as found in `BaseDriver` and `FakeDriver`. In other words, a _Plugin_ should not use mixin classes. I would not recommend mixin classes going forward due to its complexity and opacity.
Also enables type checks in `execute-driver-plugins` and exports types where we weren't before
boneskull
force-pushed
the
boneskull/typedoc-plugin
branch
from
3dce433
to
6a8b791
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This enables automatic command docs for plugins:
@appium/typedoc-plugin-appiumto do so