Skip to content

fix(website): add type to variables #10779

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
Apr 10, 2025
Merged

fix(website): add type to variables #10779

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
780f915
fix(website): add type to variables
Qjuh Feb 23, 2025
563a75d
chore: apply suggestion
Qjuh Feb 23, 2025
832a3c5
chore: lint
Qjuh Apr 10, 2025
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
2 changes: 1 addition & 1 deletion apps/website/src/components/UnionMember.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import { ExcerptNode } from './ExcerptNode';
export async function UnionMember({ node, version }: { readonly node: any; readonly version: string }) {
return (
<div className="flex flex-col gap-4">
<h2 className="flex place-items-center gap-2 p-2 text-xl font-bold">Union Members</h2>
{node.length > 1 ? <h2 className="flex place-items-center gap-2 p-2 text-xl font-bold">Union Members</h2> : null}

<span className="flex flex-col gap-4 px-2 font-mono text-sm break-words">
<ExcerptNode node={node} version={version} />
Expand Down
15 changes: 11 additions & 4 deletions packages/scripts/src/generateSplitDocumentation.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -903,13 +903,13 @@ function itemInterface(item: ApiInterface) {
};
}

function itemUnion(item: ApiTypeAlias) {
function itemUnion(item: Excerpt) {
const union: ExcerptToken[][] = [];
let currentUnionMember: ExcerptToken[] = [];
let depth = 0;
for (const token of item.typeExcerpt.spannedTokens) {
for (const token of item.spannedTokens) {
if (token.text.includes('?')) {
return [item.typeExcerpt.spannedTokens];
return [item.spannedTokens];
}

depth += token.text.split('<').length - token.text.split('>').length;
Expand Down Expand Up @@ -948,7 +948,7 @@ function itemTypeAlias(item: ApiTypeAlias) {
return {
...itemInfo(item),
typeParameters: itemTypeParameters(item),
unionMembers: itemUnion(item).map((member) =>
unionMembers: itemUnion(item.typeExcerpt).map((member) =>
itemExcerptText(
new Excerpt(member, { startIndex: 0, endIndex: member.length }),
item.getAssociatedPackage()!,
Expand All @@ -961,6 +961,13 @@ function itemTypeAlias(item: ApiTypeAlias) {
function itemVariable(item: ApiVariable) {
return {
...itemInfo(item),
unionMembers: itemUnion(item.variableTypeExcerpt).map((member) =>
itemExcerptText(
new Excerpt(member, { startIndex: 0, endIndex: member.length }),
item.getAssociatedPackage()!,
item.getHierarchy().find(ApiTypeParameterListMixin.isBaseClassOf),
),
),
};
}

Expand Down