third-party extension support for typedoc plugin #18007
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 4, 2023
|
Current dependencies on/for this PR:
This comment was auto-generated by Graphite. |
boneskull
added
Enhancement
boneskull
force-pushed
the
boneskull/cmd-docs-3p
branch
from
bb32c1f
to
6e9421b
Compare
typedoc respects this flag as well
E2E tests are quasi-blocking on merge & release of TypeStrong/typedoc#2130; it is a huge pain to test without this. - Adds some options to control output - Rename `CommandsReflection` to `ExtensionReflection` due to poor granular control over the display name - Rename the custom "kinds"; add kinds for drivers and plugins (which affects display titles) - Remove namespace from "kinds" for same reason - Refactors, reformatting - Rename entry point from `plugin.ts` to `index.ts` - Update keywords in `package.json` for auto-discovery - Remove cruft from root `typedoc.json` - Update `README.md` - Update peer dependencies; the other plugins must be peer deps or typedoc will be unable to auto-discover them
boneskull
changed the base branch from
boneskull/consume-tsconfig-pkg
to
master
boneskull
force-pushed
the
boneskull/cmd-docs-3p
branch
from
6e9421b
to
daee4b2
Compare
…async methods
Instead of only inspecting `ReflectionKind.Method`, we now examine `ReflectionKind.Property`, which can be of type `ReflectionType` pointing to an async function. Example:
```js
async function baz() {}
class Foo {
async bar() {} // ReflectionKind.Method
baz = baz; // ReflectionKind.Property referencing a function
}
```
Also ensures `static` methods aren't picked up; this could happen if a static method shares the same name with a known command method as defined in the builtin routes.
boneskull
force-pushed
the
boneskull/cmd-docs-3p
branch
from
93c0b83
to
8f076c0
Compare
|
will merge once CI passes |
- `BuiltinMethodMapConverter`'s `convert()` will _always_ return a `BuiltinCommands` / removed unused import - Verbose logging for skipped methods - Remove useless type aliases from option declarations and add some no-op typechecks (these will be compiled away) - Add some docstrings to guards and types - `CallSignatureReflectionWithParams` is now `CallSignatureReflectionWithArity`, and it is specific about having a nonzero arity. Broke out `CallSignatureReflection` from this, since the guard and type didn't fully match up
boneskull
force-pushed
the
boneskull/cmd-docs-3p
branch
from
8f076c0
to
8954adf
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.
WIP PR which makes changes needed for
@appium/typedoc-plugin-appiumto work with "third party" extensions (in other words: extensions not in this monorepo).Summary
E2E tests are quasi-blocking on merge & release of TypeStrong/typedoc#2130; it is a huge pain to test without this.
CommandsReflectiontoExtensionReflectiondue to poor granular control over the display nameplugin.tstoindex.tspackage.jsonfor auto-discoverytypedoc.jsonREADME.md