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

Add lit-labs/context docs #1100

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
Fix all breakages caused by the update.
AndrewJakubowicz committed May 5, 2023
commit da3a2626030815bafdb13987cd4e38d0b3f4226c
8 changes: 8 additions & 0 deletions packages/lit-dev-tools-cjs/src/api-docs/transformer.ts
Original file line number Diff line number Diff line change
@@ -120,6 +120,7 @@ export class ApiDocsTransformer {
// to copy our original entrypoint source info to each node.
(node as ExtendedDeclarationReflection).entrypointSources =
entrypoint.sources;
this.addKindStringToNodes(node);
for (const source of node.sources ?? []) {
this.makeSourceRelativeToMonorepoRoot(source);
await this.updateSourceFromDtsToTs(source);
@@ -689,6 +690,13 @@ export class ApiDocsTransformer {
commentNode.summary = undefined;
}

private addKindStringToNodes(node: DeclarationReflection) {
if (node.kind) {
(node as ExtendedDeclarationReflection).kindString =
typedoc.ReflectionKind.singularString(node.kind);
}
}

/**
* TypeDoc 0.24.x removed `kindString` from their data structure. However we
* use `kindString` to locate and generate correct documentation within