Nomchy/discord.js
1
0
Fork 0
mirror of https://github.com/discordjs/discord.js.git synced 2026-03-09 16:13:31 +01:00
Code Issues Packages Projects Releases Wiki Activity

fix(api-extractor): include entrypoint in links (#10902)

Browse Source 
* fix(api-extractor): include entrypoint in links

* chore: prettier
This commit is contained in:
Qjuh
2025-05-18 20:36:17 +02:00
committed by GitHub
parent 33d8619a4e
commit 8605fc81fa
2 changed files with 23 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
packages/api-extractor/src/generators/DeclarationReferenceGenerator.ts
View File

@@ -1,6 +1,7 @@
// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
// See LICENSE in the project root for license information.
import { dirname } from 'node:path';
import { Navigation, Meaning } from '@discordjs/api-extractor-model';
import {
DeclarationReference,
@@ -348,6 +349,16 @@ export class DeclarationReferenceGenerator {
);
if (packageJson?.name) {
if (packageJson?.exports && !Array.isArray(packageJson.exports) && typeof packageJson.exports !== 'string') {
const entryPoint = Object.keys(packageJson.exports).find((path) =>
dirname(sourceFile.fileName).endsWith(path.slice(1)),
);
if (entryPoint && packageJson.exports[entryPoint]) {
return `${packageJson.name}${entryPoint.slice(1)}`;
}
}
return packageJson.name;
}

14
packages/scripts/src/generateSplitDocumentation.ts
View File

@@ -46,7 +46,7 @@ import type {
DocFencedCode,
DocComment,
} from '@microsoft/tsdoc';
import type { DeclarationReference } from '@microsoft/tsdoc/lib-commonjs/beta/DeclarationReference.js';
import type { DeclarationReference, ModuleSource } from '@microsoft/tsdoc/lib-commonjs/beta/DeclarationReference.js';
import { BuiltinDocumentationLinks } from './builtinDocumentationLinks.js';
import { PACKAGES, fetchVersionDocs, fetchVersions } from './shared.js';
@@ -147,6 +147,9 @@ function resolveCanonicalReference(
containerKey: `|${
canonicalReference.symbol.meaning
}|${canonicalReference.symbol.componentPath.component.toString()}`,
getAssociatedEntryPoint() {
return canonicalReference.source as ModuleSource;
},
},
// eslint-disable-next-line unicorn/better-regex
version: apiPackage?.dependencies?.[canonicalReference.source.packageName]?.replace(/[~^]/, ''),
@@ -167,6 +170,9 @@ function resolveCanonicalReference(
members: canonicalReference.memberReferences
.slice(1)
.map((member) => ({ kind: member.kind, displayName: member.memberIdentifier!.identifier! })),
getAssociatedEntryPoint() {
return canonicalReference;
},
},
// eslint-disable-next-line unicorn/better-regex
version: apiPackage?.dependencies?.[canonicalReference.packageName ?? '']?.replace(/[~^]/, ''),
@@ -204,10 +210,14 @@ export function hasEvents(item: ApiItemContainerMixin) {
return resolveMembers(item, memberPredicate).some(({ item: member }) => member.kind === ApiItemKind.Event);
}
interface ApiEntryPointLike {
importPath: string | undefined;
}
interface ApiItemLike {
containerKey?: string;
displayName: string;
getAssociatedEntryPoint?(): ApiEntryPoint | undefined;
getAssociatedEntryPoint?(): ApiEntryPointLike | undefined;
kind: string;
members?: readonly ApiItemLike[];
parent?: ApiItemLike | undefined;