feat(typedoc-appium-plugin): implement cross-referencing of methods #17971
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
boneskull
force-pushed
the
boneskull/xref-commands
branch
from
1cea73d
to
58ddc9a
Compare
|
Current dependencies on/for this PR:
This comment was auto-generated by Graphite. |
boneskull
added
Enhancement
boneskull
commented
Dec 22, 2022
| import {Comment, CommentDisplayPart} from 'typedoc'; | ||
| import {AsyncMethodDeclarationReflection, KnownMethods} from './types'; | ||
|
|
||
| export const stats = _.fill(new Array(5), 0); |
There was a problem hiding this comment.
this is for debugging to let me know which "comment finders" are actually being called, so I can remove the ones that don't get called
boneskull
force-pushed
the
boneskull/xref-commands
branch
3 times, most recently
from
7c0204b
to
b1ba787
Compare
|
@jlipps OK, this is looking pretty good now. This is what we get from
Above we can see that:
Here are some from
And some from the execute method map:
|
boneskull
force-pushed
the
boneskull/xref-commands
branch
from
b1ba787
to
57c2ab4
Compare
|
And there's some output when run with verbose log level, so you can see what's happening: |
|
("routes", for statistical purposes above, have a unique name, but each may have 1-3 associated HTTP methods) |
boneskull
force-pushed
the
boneskull/xref-commands
branch
5 times, most recently
from
d5212b7
to
7af99cc
Compare
This is getting pretty close, but: - Commands from a driver will show even w/o a `newMethodMap` or `execMethodMap`; it is able to understand that it's overriding `BaseDriver` - It's also able to understand the associated routes - And it's able to understand the routes even if `BaseDriver` does not implement it Still working on the parameters display, but we have the name override working at least. Added some docstrings in `fake-driver`, `base-driver` for testing
trying to make some things less opaque. maybe failed
boneskull
force-pushed
the
boneskull/xref-commands
branch
from
7af99cc
to
c0314f1
Compare
For the TypeDoc plugin to correctly pull information from `@appium/types` and `@appium/base-driver`, they both need `tsconfig.json` files. They currently _have_ `tsconfig.json` files, but they extend base configs in the monorepo root, which is problematic. Moving the configs into a package seems reasonable. Further, all packages must publish `tsconfig.json`. There's precedent for publishing a `tsconfig.json` this way. FWIW the `paths` and `references` fields in the `tsconfig.json` files seem to be ignored by TypeDoc, so we can get away with this.
I do not trust it
This was referenced Jan 4, 2023
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 is getting pretty close, but:
newMethodMaporexecMethodMap; it is able to understand that it's overridingBaseDriverBaseDriverdoes not implement itStill working on the parameters display, but we have the name override working at least.Update: Parameters are working fine.
Added some docstrings in
fake-driver,base-driverfor testing