mirror of
https://github.com/discordjs/discord.js.git
synced 2026-03-13 01:53:30 +01:00
feat(docgen): typescript support
This commit is contained in:
iCrawl
@@ -1,5 +1,6 @@
|
||||
import { join } from 'node:path';
|
||||
import { dirname, join } from 'node:path';
|
||||
import { Collection } from '@discordjs/collection';
|
||||
import type { DeclarationReflection } from 'typedoc';
|
||||
import type { ChildTypes, Class, Config, CustomDocs, RootTypes } from './interfaces/index.js';
|
||||
import { DocumentedClass } from './types/class.js';
|
||||
import { DocumentedConstructor } from './types/constructor.js';
|
||||
@@ -23,101 +24,199 @@ export class Documentation {
|
||||
public readonly externals = new Collection<string, DocumentedExternal>();
|
||||
|
||||
public constructor(
|
||||
data: RootTypes[],
|
||||
data: RootTypes[] | DeclarationReflection[],
|
||||
private readonly config: Config,
|
||||
private readonly custom?: Record<string, CustomDocs>,
|
||||
) {
|
||||
let items = data;
|
||||
for (const item of items) {
|
||||
switch (item.kind) {
|
||||
case 'class': {
|
||||
this.classes.set(item.name, new DocumentedClass(item, config));
|
||||
items = items.filter((i) => i.longname !== item.longname);
|
||||
break;
|
||||
}
|
||||
case 'function': {
|
||||
if (item.scope === 'global' || !item.memberof) {
|
||||
this.functions.set(item.name, new DocumentedMethod(item, config));
|
||||
items = items.filter((i) => i.longname !== item.longname);
|
||||
}
|
||||
break;
|
||||
}
|
||||
case 'interface': {
|
||||
this.interfaces.set(item.name, new DocumentedInterface(item as unknown as Class, config));
|
||||
items = items.filter((i) => i.longname !== item.longname);
|
||||
break;
|
||||
}
|
||||
case 'typedef': {
|
||||
this.typedefs.set(item.name, new DocumentedTypeDef(item, config));
|
||||
items = items.filter((i) => i.longname !== item.longname);
|
||||
break;
|
||||
}
|
||||
case 'external': {
|
||||
this.externals.set(item.name, new DocumentedExternal(item, config));
|
||||
items = items.filter((i) => i.longname !== item.longname);
|
||||
break;
|
||||
}
|
||||
default:
|
||||
break;
|
||||
}
|
||||
}
|
||||
if (config.typescript) {
|
||||
const items = data as DeclarationReflection[];
|
||||
|
||||
this.parse(items as ChildTypes[]);
|
||||
for (const item of items) {
|
||||
switch (item.kindString) {
|
||||
case 'Class': {
|
||||
this.classes.set(item.name, new DocumentedClass(item, config));
|
||||
if (item.children) {
|
||||
this.parse(item.children, item.name);
|
||||
}
|
||||
break;
|
||||
}
|
||||
|
||||
case 'Function': {
|
||||
this.functions.set(item.name, new DocumentedMethod(item, config));
|
||||
break;
|
||||
}
|
||||
|
||||
case 'Interface':
|
||||
case 'Type alias':
|
||||
case 'Enumeration':
|
||||
this.typedefs.set(item.name, new DocumentedTypeDef(item, config));
|
||||
if (item.children) {
|
||||
this.parse(item.children, item.name);
|
||||
}
|
||||
break;
|
||||
|
||||
default:
|
||||
break;
|
||||
}
|
||||
}
|
||||
} else {
|
||||
let items = data as RootTypes[];
|
||||
|
||||
for (const item of items) {
|
||||
switch (item.kind) {
|
||||
case 'class': {
|
||||
this.classes.set(item.name, new DocumentedClass(item, config));
|
||||
items = items.filter((i) => i.longname !== item.longname);
|
||||
break;
|
||||
}
|
||||
case 'function': {
|
||||
if (item.scope === 'global' || !item.memberof) {
|
||||
this.functions.set(item.name, new DocumentedMethod(item, config));
|
||||
items = items.filter((i) => i.longname !== item.longname);
|
||||
}
|
||||
break;
|
||||
}
|
||||
case 'interface': {
|
||||
this.interfaces.set(item.name, new DocumentedInterface(item as unknown as Class, config));
|
||||
items = items.filter((i) => i.longname !== item.longname);
|
||||
break;
|
||||
}
|
||||
case 'typedef': {
|
||||
this.typedefs.set(item.name, new DocumentedTypeDef(item, config));
|
||||
items = items.filter((i) => i.longname !== item.longname);
|
||||
break;
|
||||
}
|
||||
case 'external': {
|
||||
this.externals.set(item.name, new DocumentedExternal(item, config));
|
||||
items = items.filter((i) => i.longname !== item.longname);
|
||||
break;
|
||||
}
|
||||
default:
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
this.parse(items as ChildTypes[]);
|
||||
}
|
||||
}
|
||||
|
||||
public parse(items: ChildTypes[]) {
|
||||
for (const member of items) {
|
||||
let item: DocumentedMethod | DocumentedConstructor | DocumentedMember | DocumentedEvent | null = null;
|
||||
public parse(items: ChildTypes[] | DeclarationReflection[], memberOf = '') {
|
||||
if (this.config.typescript) {
|
||||
const it = items as DeclarationReflection[];
|
||||
|
||||
switch (member.kind) {
|
||||
case 'constructor': {
|
||||
item = new DocumentedConstructor(member, this.config);
|
||||
break;
|
||||
for (const member of it) {
|
||||
let item: DocumentedMethod | DocumentedConstructor | DocumentedMember | DocumentedEvent | null = null;
|
||||
|
||||
switch (member.kindString) {
|
||||
case 'Constructor': {
|
||||
item = new DocumentedConstructor(member, this.config);
|
||||
break;
|
||||
}
|
||||
case 'Method': {
|
||||
item = new DocumentedMethod(member, this.config);
|
||||
break;
|
||||
}
|
||||
case 'Property': {
|
||||
item = new DocumentedMember(member, this.config);
|
||||
break;
|
||||
}
|
||||
case 'event': {
|
||||
item = new DocumentedEvent(member, this.config);
|
||||
break;
|
||||
}
|
||||
default: {
|
||||
// eslint-disable-next-line @typescript-eslint/restrict-template-expressions
|
||||
console.warn(`- Unknown documentation kind "${member.kindString}" - \n${JSON.stringify(member)}\n`);
|
||||
}
|
||||
}
|
||||
case 'function': {
|
||||
item = new DocumentedMethod(member, this.config);
|
||||
break;
|
||||
}
|
||||
case 'member': {
|
||||
item = new DocumentedMember(member, this.config);
|
||||
break;
|
||||
}
|
||||
case 'event': {
|
||||
item = new DocumentedEvent(member, this.config);
|
||||
break;
|
||||
}
|
||||
default: {
|
||||
// @ts-expect-error
|
||||
// eslint-disable-next-line @typescript-eslint/restrict-template-expressions
|
||||
console.warn(`- Unknown documentation kind "${member.kind}" - \n${JSON.stringify(member)}\n`);
|
||||
|
||||
const parent = this.classes.get(memberOf) ?? this.interfaces.get(memberOf);
|
||||
if (parent) {
|
||||
if (item) {
|
||||
parent.add(item);
|
||||
} else {
|
||||
console.warn(
|
||||
`- Documentation item could not be constructed for "${member.name}" - \n${JSON.stringify(member)}\n`,
|
||||
);
|
||||
}
|
||||
continue;
|
||||
}
|
||||
|
||||
const info = [];
|
||||
const name = (member.name || item?.data.name) ?? 'UNKNOWN';
|
||||
const meta =
|
||||
member.kindString === 'constructor'
|
||||
? null
|
||||
: {
|
||||
file: member.sources?.[0]?.fileName,
|
||||
line: member.sources?.[0]?.line,
|
||||
path: dirname(member.sources?.[0]?.fileName ?? ''),
|
||||
};
|
||||
|
||||
if (memberOf) info.push(`member of "${memberOf}"`);
|
||||
if (meta) info.push(`${join(meta.path, meta.file ?? '')}${meta.line ? `:${meta.line}` : ''}`);
|
||||
|
||||
console.warn(`- "${name}"${info.length ? ` (${info.join(', ')})` : ''} has no accessible parent.`);
|
||||
if (!name && !info.length) console.warn('Raw object:', member);
|
||||
}
|
||||
} else {
|
||||
const it = items as ChildTypes[];
|
||||
|
||||
const parent = this.classes.get(member.memberof ?? '') ?? this.interfaces.get(member.memberof ?? '');
|
||||
if (parent) {
|
||||
if (item) {
|
||||
parent.add(item);
|
||||
} else {
|
||||
console.warn(
|
||||
`- Documentation item could not be constructed for "${member.name}" - \n${JSON.stringify(member)}\n`,
|
||||
);
|
||||
for (const member of it) {
|
||||
let item: DocumentedMethod | DocumentedConstructor | DocumentedMember | DocumentedEvent | null = null;
|
||||
|
||||
switch (member.kind) {
|
||||
case 'constructor': {
|
||||
item = new DocumentedConstructor(member, this.config);
|
||||
break;
|
||||
}
|
||||
case 'function': {
|
||||
item = new DocumentedMethod(member, this.config);
|
||||
break;
|
||||
}
|
||||
case 'member': {
|
||||
item = new DocumentedMember(member, this.config);
|
||||
break;
|
||||
}
|
||||
case 'event': {
|
||||
item = new DocumentedEvent(member, this.config);
|
||||
break;
|
||||
}
|
||||
default: {
|
||||
// @ts-expect-error
|
||||
// eslint-disable-next-line @typescript-eslint/restrict-template-expressions
|
||||
console.warn(`- Unknown documentation kind "${member.kind}" - \n${JSON.stringify(member)}\n`);
|
||||
}
|
||||
}
|
||||
continue;
|
||||
|
||||
const parent = this.classes.get(member.memberof ?? '') ?? this.interfaces.get(member.memberof ?? '');
|
||||
if (parent) {
|
||||
if (item) {
|
||||
parent.add(item);
|
||||
} else {
|
||||
console.warn(
|
||||
`- Documentation item could not be constructed for "${member.name}" - \n${JSON.stringify(member)}\n`,
|
||||
);
|
||||
}
|
||||
continue;
|
||||
}
|
||||
|
||||
const info = [];
|
||||
const name = (member.name || item?.data.name) ?? 'UNKNOWN';
|
||||
// @ts-expect-error
|
||||
// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment, @typescript-eslint/no-unnecessary-condition
|
||||
const memberof = member.memberof ?? item?.data?.memberof;
|
||||
const meta =
|
||||
member.kind === 'constructor'
|
||||
? null
|
||||
: { file: member.meta.filename, line: member.meta.lineno, path: member.meta.path };
|
||||
|
||||
if (memberof) info.push(`member of "${memberof as string}"`);
|
||||
if (meta) info.push(`${join(meta.path, meta.file)}${meta.line ? `:${meta.line}` : ''}`);
|
||||
|
||||
console.warn(`- "${name}"${info.length ? ` (${info.join(', ')})` : ''} has no accessible parent.`);
|
||||
if (!name && !info.length) console.warn('Raw object:', member);
|
||||
}
|
||||
|
||||
const info = [];
|
||||
const name = (member.name || item?.data.name) ?? 'UNKNOWN';
|
||||
const memberof = member.memberof ?? item?.data.memberof;
|
||||
const meta =
|
||||
member.kind === 'constructor'
|
||||
? null
|
||||
: { file: member.meta.filename, line: member.meta.lineno, path: member.meta.path };
|
||||
|
||||
if (memberof) info.push(`member of "${memberof}"`);
|
||||
if (meta) info.push(`${join(meta.path, meta.file)}${meta.line ? `:${meta.line}` : ''}`);
|
||||
|
||||
console.warn(`- "${name}"${info.length ? ` (${info.join(', ')})` : ''} has no accessible parent.`);
|
||||
if (!name && !info.length) console.warn('Raw object:', member);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
Reference in New Issue
Block a user