feat: docgen package (#8029)

packages/docgen/src/interfaces/access.type.ts

@@ -0,0 +1 @@
+export type Access = 'public' | 'private' | 'protected';

packages/docgen/src/interfaces/childTypes.type.ts

@@ -0,0 +1,3 @@
+import type { Constructor, Event, Member, Method } from './index.js';
+
+export type ChildTypes = Constructor | Member | Method | Event;

packages/docgen/src/interfaces/class.interface.ts

@@ -0,0 +1,13 @@
+import type { Access, Item, Meta, Scope } from './index.js';
+
+export interface Class extends Item {
+	kind: 'class';
+	scope: Scope;
+	implements?: string[];
+	augments?: string[];
+	see?: string[];
+	access?: Access;
+	virtual?: boolean;
+	deprecated?: boolean | string;
+	meta: Meta;
+}

packages/docgen/src/interfaces/config.interface.ts

@@ -0,0 +1,3 @@
+export interface Config {
+	root: string;
+}

packages/docgen/src/interfaces/constructor.interface.ts

@@ -0,0 +1,9 @@
+import type { Access, Item, Param } from './index.js';
+
+export interface Constructor extends Item {
+	kind: 'constructor';
+	memberof: string;
+	see?: string[];
+	access?: Access;
+	params?: Param[];
+}

packages/docgen/src/interfaces/customDocs.interface.ts

@@ -0,0 +1,12 @@
+export interface CustomDocs {
+	name?: string;
+	files: Record<
+		string,
+		{
+			name?: string;
+			type?: string;
+			content?: string;
+			path?: string;
+		}
+	>;
+}

packages/docgen/src/interfaces/event.interface.ts

@@ -0,0 +1,11 @@
+import type { Item, Meta, Param, Scope } from './index.js';
+
+export interface Event extends Item {
+	kind: 'event';
+	scope: Scope;
+	memberof: string;
+	see?: string[];
+	deprecated?: boolean | string;
+	params?: Param[];
+	meta: Meta;
+}

packages/docgen/src/interfaces/exception.interface.ts

@@ -0,0 +1,7 @@
+import type { Type } from './index.js';
+
+export interface Exception {
+	type: Type;
+	nullable?: boolean;
+	description?: string;
+}

packages/docgen/src/interfaces/external.interface.ts

@@ -0,0 +1,7 @@
+import type { Item, Meta } from './index.js';
+
+export interface External extends Item {
+	kind: 'external';
+	see?: string[];
+	meta: Meta;
+}

packages/docgen/src/interfaces/index.ts

@@ -0,0 +1,21 @@
+export * from './access.type.js';
+export * from './childTypes.type';
+export * from './class.interface.js';
+export * from './config.interface.js';
+export * from './constructor.interface.js';
+export * from './customDocs.interface.js';
+export * from './event.interface.js';
+export * from './exception.interface.js';
+export * from './external.interface.js';
+export * from './interface.interface.js';
+export * from './item.interface.js';
+export * from './member.interface.js';
+export * from './meta.interface.js';
+export * from './method.interface.js';
+export * from './param.interface.js';
+export * from './return.interface.js';
+export * from './rootTypes.type.js';
+export * from './scope.type.js';
+export * from './type.interface.js';
+export * from './typedef.interface.js';
+export * from './var-type.interface';

packages/docgen/src/interfaces/interface.interface.ts

@@ -0,0 +1,7 @@
+import type { Class } from './index.js';
+
+// @ts-expect-error
+export interface Interface extends Class {
+	kind: 'interface';
+	classdesc: string;
+}

packages/docgen/src/interfaces/item.interface.ts

@@ -0,0 +1,8 @@
+export interface Item {
+	id: string;
+	longname: string;
+	name: string;
+	kind: string;
+	description: string;
+	order: number;
+}

packages/docgen/src/interfaces/member.interface.ts

@@ -0,0 +1,17 @@
+import type { Access, Item, Meta, Param, Scope, Type } from './index.js';
+
+export interface Member extends Item {
+	kind: 'member';
+	see?: string[];
+	scope: Scope;
+	memberof: string;
+	type: Type;
+	access?: Access;
+	readonly?: boolean;
+	nullable?: boolean;
+	virtual?: boolean;
+	deprecated?: boolean | string;
+	default?: string;
+	properties?: Param[];
+	meta: Meta;
+}

packages/docgen/src/interfaces/meta.interface.ts

@@ -0,0 +1,5 @@
+export interface Meta {
+	lineno: number;
+	filename: string;
+	path: string;
+}

packages/docgen/src/interfaces/method.interface.ts

@@ -0,0 +1,22 @@
+import type { Access, Exception, Item, Meta, Param, Return, Scope } from './index.js';
+
+export interface Method extends Item {
+	kind: 'function';
+	see?: string[];
+	scope: Scope;
+	access?: Access;
+	inherits?: string;
+	inherited?: boolean;
+	implements?: string[];
+	examples?: string[];
+	virtual?: boolean;
+	deprecated?: boolean | string;
+	memberof?: string;
+	params?: Param[];
+	async?: boolean;
+	generator?: boolean;
+	fires?: string[];
+	returns?: Return[];
+	exceptions?: Exception[];
+	meta: Meta;
+}

packages/docgen/src/interfaces/param.interface.ts

@@ -0,0 +1,11 @@
+import type { Type } from './index.js';
+
+export interface Param {
+	type: Type;
+	description: string;
+	name: string;
+	optional?: boolean;
+	defaultvalue?: string;
+	variable?: string;
+	nullable?: boolean;
+}

packages/docgen/src/interfaces/return.interface.ts

@@ -0,0 +1,7 @@
+import type { Type } from './index.js';
+
+export interface Return {
+	type: Type;
+	nullable?: boolean;
+	description?: string;
+}

packages/docgen/src/interfaces/rootTypes.type.ts

@@ -0,0 +1,3 @@
+import type { Class, External, Interface, Method, Typedef } from './index.js';
+
+export type RootTypes = Class | Method | Interface | Typedef | External;

packages/docgen/src/interfaces/scope.type.ts

@@ -0,0 +1 @@
+export type Scope = 'global' | 'instance' | 'static';

packages/docgen/src/interfaces/type.interface.ts

@@ -0,0 +1,3 @@
+export interface Type {
+	names?: string[];
+}

packages/docgen/src/interfaces/typedef.interface.ts

@@ -0,0 +1,14 @@
+import type { Access, Item, Meta, Param, Return, Scope, Type } from './index.js';
+
+export interface Typedef extends Item {
+	kind: 'typedef';
+	scope: Scope;
+	see?: string[];
+	access?: Access;
+	deprecated?: boolean | string;
+	type: Type;
+	properties?: Param[];
+	params?: Param[];
+	returns?: Return[];
+	meta: Meta;
+}

packages/docgen/src/interfaces/var-type.interface.ts

@@ -0,0 +1,6 @@
+import type { Type } from './index.js';
+
+export interface VarType extends Type {
+	description?: string;
+	nullable?: boolean;
+}