mirror of
https://github.com/discordjs/discord.js.git
synced 2026-03-15 11:03:30 +01:00
chore: fix leftover eslint exceptions
This commit is contained in:
@@ -123,7 +123,6 @@ export class Documentation {
|
||||
|
||||
case 'Method': {
|
||||
const event = prop?.groups?.find((group) => group.title === 'Events');
|
||||
// eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
|
||||
if ((event?.children as unknown as number[])?.includes(member.id)) {
|
||||
item = new DocumentedEvent(member, this.config);
|
||||
break;
|
||||
@@ -139,7 +138,6 @@ export class Documentation {
|
||||
}
|
||||
|
||||
default: {
|
||||
// eslint-disable-next-line @typescript-eslint/restrict-template-expressions
|
||||
console.warn(`- Unknown documentation kind "${member.kindString}" - \n${JSON.stringify(member)}\n`);
|
||||
}
|
||||
}
|
||||
@@ -212,7 +210,6 @@ export class Documentation {
|
||||
|
||||
default: {
|
||||
// @ts-expect-error: This is a valid case
|
||||
// eslint-disable-next-line @typescript-eslint/restrict-template-expressions
|
||||
console.warn(`- Unknown documentation kind "${member.kind}" - \n${JSON.stringify(member)}\n`);
|
||||
}
|
||||
}
|
||||
@@ -233,7 +230,6 @@ export class Documentation {
|
||||
const info = [];
|
||||
const name = (member.name || item?.data.name) ?? 'UNKNOWN';
|
||||
// @ts-expect-error: Typescript can't infer this
|
||||
// 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'
|
||||
|
||||
@@ -2,9 +2,9 @@ import { readFileSync, writeFileSync } from 'node:fs';
|
||||
import { dirname, join, extname, basename, relative } from 'node:path';
|
||||
import jsdoc2md from 'jsdoc-to-markdown';
|
||||
import { type DeclarationReflection, Application, TSConfigReader } from 'typedoc';
|
||||
import type { CLIOptions } from './cli';
|
||||
import type { CLIOptions } from './cli.js';
|
||||
import { Documentation } from './documentation.js';
|
||||
import type { RootTypes, ChildTypes, CustomDocs } from './interfaces';
|
||||
import type { RootTypes, ChildTypes, CustomDocs } from './interfaces/index.js';
|
||||
|
||||
interface CustomFiles {
|
||||
files: {
|
||||
|
||||
@@ -58,7 +58,6 @@ export class DocumentedClass extends DocumentedItem<Class | DeclarationReflectio
|
||||
this.construct = item;
|
||||
} else if (item instanceof DocumentedMethod) {
|
||||
// @ts-expect-error: No type for methods
|
||||
// eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
|
||||
const prefix = item.data.scope === 'static' || item.data.flags?.isStatic ? 's-' : '';
|
||||
if (this.methods.has(prefix + item.data.name)) {
|
||||
throw new Error(`Doc ${this.data.name} already has method ${item.data.name}`);
|
||||
@@ -91,7 +90,6 @@ export class DocumentedClass extends DocumentedItem<Class | DeclarationReflectio
|
||||
meta = new DocumentedItemMeta(sources, this.config).serialize();
|
||||
}
|
||||
|
||||
// eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
|
||||
const see = signature.comment?.blockTags?.filter((block) => block.tag === '@see').length
|
||||
? signature.comment.blockTags
|
||||
.filter((block) => block.tag === '@see')
|
||||
@@ -100,7 +98,6 @@ export class DocumentedClass extends DocumentedItem<Class | DeclarationReflectio
|
||||
|
||||
return {
|
||||
// @ts-expect-error: Type cannot be inferred
|
||||
// eslint-disable-next-line @typescript-eslint/no-unsafe-argument
|
||||
name: signature.name === 'default' ? parse(meta?.file ?? 'default').name : signature.name,
|
||||
// eslint-disable-next-line @typescript-eslint/prefer-nullish-coalescing, no-param-reassign
|
||||
description: signature.comment?.summary.reduce((prev, curr) => (prev += curr.text), '').trim() || undefined,
|
||||
@@ -109,13 +106,11 @@ export class DocumentedClass extends DocumentedItem<Class | DeclarationReflectio
|
||||
implements: this.implements?.serialize(),
|
||||
access:
|
||||
data.flags.isPrivate ||
|
||||
// eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
|
||||
signature.comment?.blockTags?.some((block) => block.tag === '@private' || block.tag === '@internal')
|
||||
? 'private'
|
||||
: undefined,
|
||||
// eslint-disable-next-line @typescript-eslint/prefer-nullish-coalescing, @typescript-eslint/no-unnecessary-condition
|
||||
// eslint-disable-next-line @typescript-eslint/prefer-nullish-coalescing
|
||||
abstract: signature.comment?.blockTags?.some((block) => block.tag === '@abstract') || undefined,
|
||||
// eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
|
||||
deprecated: signature.comment?.blockTags?.some((block) => block.tag === '@deprecated')
|
||||
? signature.comment.blockTags
|
||||
.find((block) => block.tag === '@deprecated')
|
||||
|
||||
@@ -9,7 +9,6 @@ export class DocumentedConstructor extends DocumentedItem<Constructor | Declarat
|
||||
const data = this.data as DeclarationReflection;
|
||||
const signature = (data.signatures ?? [])[0] ?? data;
|
||||
|
||||
// eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
|
||||
const see = signature.comment?.blockTags?.filter((block) => block.tag === '@see').length
|
||||
? signature.comment.blockTags
|
||||
.filter((block) => block.tag === '@see')
|
||||
@@ -18,12 +17,11 @@ export class DocumentedConstructor extends DocumentedItem<Constructor | Declarat
|
||||
|
||||
return {
|
||||
name: signature.name,
|
||||
// eslint-disable-next-line @typescript-eslint/no-unnecessary-condition, @typescript-eslint/prefer-nullish-coalescing, no-param-reassign
|
||||
// eslint-disable-next-line @typescript-eslint/prefer-nullish-coalescing, no-param-reassign
|
||||
description: signature.comment?.summary?.reduce((prev, curr) => (prev += curr.text), '').trim() || undefined,
|
||||
see,
|
||||
access:
|
||||
data.flags.isPrivate ||
|
||||
// eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
|
||||
signature.comment?.blockTags?.some((block) => block.tag === '@private' || block.tag === '@internal')
|
||||
? 'private'
|
||||
: undefined,
|
||||
|
||||
@@ -18,14 +18,12 @@ export class DocumentedEvent extends DocumentedItem<DeclarationReflection | Even
|
||||
meta = new DocumentedItemMeta(sources, this.config).serialize();
|
||||
}
|
||||
|
||||
// eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
|
||||
const see = signature.comment?.blockTags?.filter((block) => block.tag === '@see').length
|
||||
? signature.comment.blockTags
|
||||
.filter((block) => block.tag === '@see')
|
||||
.map((block) => block.content.find((contentText) => contentText.kind === 'text')?.text.trim())
|
||||
: undefined;
|
||||
|
||||
// eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
|
||||
const examples = signature.comment?.blockTags?.filter((block) => block.tag === '@example').length
|
||||
? signature.comment.blockTags
|
||||
.filter((block) => block.tag === '@example')
|
||||
@@ -35,19 +33,16 @@ export class DocumentedEvent extends DocumentedItem<DeclarationReflection | Even
|
||||
|
||||
return {
|
||||
// @ts-expect-error: No type for params
|
||||
// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment, @typescript-eslint/no-unsafe-member-access
|
||||
name: signature.parameters?.[0]?.type?.value,
|
||||
// eslint-disable-next-line @typescript-eslint/no-unnecessary-condition, @typescript-eslint/prefer-nullish-coalescing, no-param-reassign
|
||||
// eslint-disable-next-line @typescript-eslint/prefer-nullish-coalescing, no-param-reassign
|
||||
description: signature.comment?.summary?.reduce((prev, curr) => (prev += curr.text), '').trim() || undefined,
|
||||
see,
|
||||
access:
|
||||
data.flags.isPrivate ||
|
||||
// eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
|
||||
signature.comment?.blockTags?.some((block) => block.tag === '@private' || block.tag === '@internal')
|
||||
? 'private'
|
||||
: undefined,
|
||||
examples,
|
||||
// eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
|
||||
deprecated: signature.comment?.blockTags?.some((block) => block.tag === '@deprecated')
|
||||
? signature.comment.blockTags
|
||||
.find((block) => block.tag === '@deprecated')
|
||||
@@ -68,7 +63,6 @@ export class DocumentedEvent extends DocumentedItem<DeclarationReflection | Even
|
||||
names: [parseType(signature.type)],
|
||||
description:
|
||||
signature.comment?.blockTags
|
||||
// eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
|
||||
?.find((block) => block.tag === '@returns')
|
||||
// eslint-disable-next-line no-param-reassign
|
||||
?.content.reduce((prev, curr) => (prev += curr.text), '')
|
||||
@@ -81,7 +75,6 @@ export class DocumentedEvent extends DocumentedItem<DeclarationReflection | Even
|
||||
: undefined,
|
||||
returnsDescription:
|
||||
signature.comment?.blockTags
|
||||
// eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
|
||||
?.find((block) => block.tag === '@returns')
|
||||
// eslint-disable-next-line no-param-reassign
|
||||
?.content.reduce((prev, curr) => (prev += curr.text), '')
|
||||
|
||||
@@ -18,7 +18,6 @@ export class DocumentedMember extends DocumentedItem<DeclarationReflection | Mem
|
||||
meta = new DocumentedItemMeta(sources, this.config).serialize();
|
||||
}
|
||||
|
||||
// eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
|
||||
const see = signature.comment?.blockTags?.filter((block) => block.tag === '@see').length
|
||||
? signature.comment.blockTags
|
||||
.filter((block) => block.tag === '@see')
|
||||
@@ -27,20 +26,18 @@ export class DocumentedMember extends DocumentedItem<DeclarationReflection | Mem
|
||||
|
||||
const base = {
|
||||
name: signature.name,
|
||||
// eslint-disable-next-line @typescript-eslint/no-unnecessary-condition, @typescript-eslint/prefer-nullish-coalescing, no-param-reassign
|
||||
// eslint-disable-next-line @typescript-eslint/prefer-nullish-coalescing, no-param-reassign
|
||||
description: signature.comment?.summary?.reduce((prev, curr) => (prev += curr.text), '').trim() || undefined,
|
||||
see,
|
||||
scope: data.flags.isStatic ? 'static' : undefined,
|
||||
access:
|
||||
data.flags.isPrivate ||
|
||||
// eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
|
||||
signature.comment?.blockTags?.some((block) => block.tag === '@private' || block.tag === '@internal')
|
||||
? 'private'
|
||||
: undefined,
|
||||
readonly: data.flags.isReadonly,
|
||||
// eslint-disable-next-line @typescript-eslint/no-unnecessary-condition, @typescript-eslint/prefer-nullish-coalescing
|
||||
// eslint-disable-next-line @typescript-eslint/prefer-nullish-coalescing
|
||||
abstract: signature.comment?.blockTags?.some((block) => block.tag === '@abstract') || undefined,
|
||||
// eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
|
||||
deprecated: signature.comment?.blockTags?.some((block) => block.tag === '@deprecated')
|
||||
? signature.comment.blockTags
|
||||
.find((block) => block.tag === '@deprecated')
|
||||
@@ -51,7 +48,6 @@ export class DocumentedMember extends DocumentedItem<DeclarationReflection | Mem
|
||||
default:
|
||||
(data.defaultValue === '...' ? undefined : data.defaultValue) ??
|
||||
(signature.comment?.blockTags
|
||||
// eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
|
||||
?.find((block) => block.tag === '@default')
|
||||
// eslint-disable-next-line no-param-reassign
|
||||
?.content.reduce((prev, curr) => (prev += curr.text), '')
|
||||
@@ -76,7 +72,6 @@ export class DocumentedMember extends DocumentedItem<DeclarationReflection | Mem
|
||||
base.readonly = true;
|
||||
}
|
||||
|
||||
// eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
|
||||
const see = getter.comment?.blockTags?.filter((block) => block.tag === '@see').length
|
||||
? getter.comment.blockTags
|
||||
.filter((block) => block.tag === '@see')
|
||||
@@ -85,19 +80,17 @@ export class DocumentedMember extends DocumentedItem<DeclarationReflection | Mem
|
||||
|
||||
return {
|
||||
...base,
|
||||
// eslint-disable-next-line @typescript-eslint/no-unnecessary-condition, @typescript-eslint/prefer-nullish-coalescing, no-param-reassign
|
||||
// eslint-disable-next-line @typescript-eslint/prefer-nullish-coalescing, no-param-reassign
|
||||
description: getter.comment?.summary?.reduce((prev, curr) => (prev += curr.text), '').trim() || undefined,
|
||||
see,
|
||||
access:
|
||||
data.flags.isPrivate ||
|
||||
// eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
|
||||
getter.comment?.blockTags?.some((block) => block.tag === '@private' || block.tag === '@internal')
|
||||
? 'private'
|
||||
: undefined,
|
||||
readonly: base.readonly || !hasSetter,
|
||||
// eslint-disable-next-line @typescript-eslint/no-unnecessary-condition, @typescript-eslint/prefer-nullish-coalescing
|
||||
// eslint-disable-next-line @typescript-eslint/prefer-nullish-coalescing
|
||||
abstract: getter.comment?.blockTags?.some((block) => block.tag === '@abstract') || undefined,
|
||||
// eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
|
||||
deprecated: getter.comment?.blockTags?.some((block) => block.tag === '@deprecated')
|
||||
? getter.comment.blockTags
|
||||
.find((block) => block.tag === '@deprecated')
|
||||
@@ -108,7 +101,6 @@ export class DocumentedMember extends DocumentedItem<DeclarationReflection | Mem
|
||||
default:
|
||||
base.default ??
|
||||
(getter.comment?.blockTags
|
||||
// eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
|
||||
?.find((block) => block.tag === '@default')
|
||||
// eslint-disable-next-line no-param-reassign
|
||||
?.content.reduce((prev, curr) => (prev += curr.text), '')
|
||||
|
||||
@@ -18,14 +18,12 @@ export class DocumentedMethod extends DocumentedItem<DeclarationReflection | Met
|
||||
meta = new DocumentedItemMeta(sources, this.config).serialize();
|
||||
}
|
||||
|
||||
// eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
|
||||
const see = signature.comment?.blockTags?.filter((block) => block.tag === '@see').length
|
||||
? signature.comment.blockTags
|
||||
.filter((block) => block.tag === '@see')
|
||||
.map((block) => block.content.find((innerContent) => innerContent.kind === 'text')?.text.trim())
|
||||
: undefined;
|
||||
|
||||
// eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
|
||||
const examples = signature.comment?.blockTags?.filter((block) => block.tag === '@example').length
|
||||
? signature.comment.blockTags
|
||||
.filter((block) => block.tag === '@example')
|
||||
@@ -35,20 +33,18 @@ export class DocumentedMethod extends DocumentedItem<DeclarationReflection | Met
|
||||
|
||||
return {
|
||||
name: signature.name,
|
||||
// eslint-disable-next-line @typescript-eslint/no-unnecessary-condition, @typescript-eslint/prefer-nullish-coalescing, no-param-reassign
|
||||
// eslint-disable-next-line @typescript-eslint/prefer-nullish-coalescing, no-param-reassign
|
||||
description: signature.comment?.summary?.reduce((prev, curr) => (prev += curr.text), '').trim() || undefined,
|
||||
see,
|
||||
scope: data.flags.isStatic ? 'static' : undefined,
|
||||
access:
|
||||
data.flags.isPrivate ||
|
||||
// eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
|
||||
signature.comment?.blockTags?.some((block) => block.tag === '@private' || block.tag === '@internal')
|
||||
? 'private'
|
||||
: undefined,
|
||||
examples,
|
||||
// eslint-disable-next-line @typescript-eslint/no-unnecessary-condition, @typescript-eslint/prefer-nullish-coalescing
|
||||
// eslint-disable-next-line @typescript-eslint/prefer-nullish-coalescing
|
||||
abstract: signature.comment?.blockTags?.some((block) => block.tag === '@abstract') || undefined,
|
||||
// eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
|
||||
deprecated: signature.comment?.blockTags?.some((block) => block.tag === '@deprecated')
|
||||
? signature.comment.blockTags
|
||||
.find((block) => block.tag === '@deprecated')
|
||||
@@ -56,7 +52,6 @@ export class DocumentedMethod extends DocumentedItem<DeclarationReflection | Met
|
||||
?.content.reduce((prev, curr) => (prev += curr.text), '')
|
||||
.trim() ?? true
|
||||
: undefined,
|
||||
// eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
|
||||
// emits: signature.comment?.blockTags?.filter((t) => t.tag === '@emits').map((t) => t.content),
|
||||
// @ts-expect-error: Typescript doesn't know that this is a SignatureReflection
|
||||
params: signature.parameters
|
||||
@@ -71,7 +66,6 @@ export class DocumentedMethod extends DocumentedItem<DeclarationReflection | Met
|
||||
names: [parseType(signature.type)],
|
||||
description:
|
||||
signature.comment?.blockTags
|
||||
// eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
|
||||
?.find((block) => block.tag === '@returns')
|
||||
// eslint-disable-next-line no-param-reassign
|
||||
?.content.reduce((prev, curr) => (prev += curr.text), '')
|
||||
@@ -84,7 +78,6 @@ export class DocumentedMethod extends DocumentedItem<DeclarationReflection | Met
|
||||
: undefined,
|
||||
returnsDescription:
|
||||
signature.comment?.blockTags
|
||||
// eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
|
||||
?.find((block) => block.tag === '@returns')
|
||||
// eslint-disable-next-line no-param-reassign
|
||||
?.content.reduce((prev, curr) => (prev += curr.text), '')
|
||||
|
||||
@@ -11,13 +11,12 @@ export class DocumentedParam extends DocumentedItem<Param | ParameterReflection>
|
||||
|
||||
return {
|
||||
name: data.name,
|
||||
// eslint-disable-next-line @typescript-eslint/no-unnecessary-condition, @typescript-eslint/prefer-nullish-coalescing, no-param-reassign
|
||||
// eslint-disable-next-line @typescript-eslint/prefer-nullish-coalescing, no-param-reassign
|
||||
description: data.comment?.summary?.reduce((prev, curr) => (prev += curr.text), '').trim() || undefined,
|
||||
optional: data.flags.isOptional || typeof data.defaultValue !== 'undefined',
|
||||
default:
|
||||
(data.defaultValue === '...' ? undefined : data.defaultValue) ??
|
||||
(data.comment?.blockTags
|
||||
// eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
|
||||
?.find((block) => block.tag === '@default')
|
||||
// eslint-disable-next-line no-param-reassign
|
||||
?.content.reduce((prev, curr) => (prev += curr.text), '')
|
||||
|
||||
@@ -19,7 +19,6 @@ export class DocumentedTypeDef extends DocumentedItem<DeclarationReflection | Ty
|
||||
meta = new DocumentedItemMeta(sources, this.config).serialize();
|
||||
}
|
||||
|
||||
// eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
|
||||
const see = signature.comment?.blockTags?.filter((block) => block.tag === '@see').length
|
||||
? signature.comment.blockTags
|
||||
.filter((block) => block.tag === '@see')
|
||||
@@ -28,16 +27,14 @@ export class DocumentedTypeDef extends DocumentedItem<DeclarationReflection | Ty
|
||||
|
||||
const baseReturn = {
|
||||
name: signature.name,
|
||||
// eslint-disable-next-line @typescript-eslint/no-unnecessary-condition, @typescript-eslint/prefer-nullish-coalescing, no-param-reassign
|
||||
// eslint-disable-next-line @typescript-eslint/prefer-nullish-coalescing, no-param-reassign
|
||||
description: signature.comment?.summary?.reduce((prev, curr) => (prev += curr.text), '').trim() || undefined,
|
||||
see,
|
||||
access:
|
||||
data.flags.isPrivate ||
|
||||
// eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
|
||||
signature.comment?.blockTags?.some((block) => block.tag === '@private' || block.tag === '@internal')
|
||||
? 'private'
|
||||
: undefined,
|
||||
// eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
|
||||
deprecated: signature.comment?.blockTags?.some((block) => block.tag === '@deprecated')
|
||||
? signature.comment.blockTags
|
||||
.find((block) => block.tag === '@deprecated')
|
||||
@@ -64,7 +61,7 @@ export class DocumentedTypeDef extends DocumentedItem<DeclarationReflection | Ty
|
||||
name: child.name,
|
||||
description:
|
||||
child.comment?.summary
|
||||
// eslint-disable-next-line @typescript-eslint/no-unnecessary-condition, no-param-reassign
|
||||
// eslint-disable-next-line no-param-reassign
|
||||
?.reduce((prev, curr) => (prev += curr.text), '')
|
||||
// eslint-disable-next-line @typescript-eslint/prefer-nullish-coalescing
|
||||
.trim() || undefined,
|
||||
@@ -82,18 +79,17 @@ export class DocumentedTypeDef extends DocumentedItem<DeclarationReflection | Ty
|
||||
name: child.name,
|
||||
description:
|
||||
child.comment?.summary
|
||||
// eslint-disable-next-line @typescript-eslint/no-unnecessary-condition, no-param-reassign
|
||||
// eslint-disable-next-line no-param-reassign
|
||||
?.reduce((prev, curr) => (prev += curr.text), '')
|
||||
// eslint-disable-next-line @typescript-eslint/prefer-nullish-coalescing
|
||||
.trim() ||
|
||||
// eslint-disable-next-line @typescript-eslint/no-unnecessary-condition, @typescript-eslint/prefer-nullish-coalescing, no-param-reassign
|
||||
// eslint-disable-next-line @typescript-eslint/prefer-nullish-coalescing, no-param-reassign
|
||||
child.signatures?.[0]?.comment?.summary?.reduce((prev, curr) => (prev += curr.text), '').trim() ||
|
||||
undefined,
|
||||
optional: child.flags.isOptional || typeof child.defaultValue !== 'undefined',
|
||||
default:
|
||||
(child.defaultValue === '...' ? undefined : child.defaultValue) ??
|
||||
(child.comment?.blockTags
|
||||
// eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
|
||||
?.find((block) => block.tag === '@default')
|
||||
// eslint-disable-next-line no-param-reassign
|
||||
?.content.reduce((prev, curr) => (prev += curr.text), '')
|
||||
@@ -112,7 +108,6 @@ export class DocumentedTypeDef extends DocumentedItem<DeclarationReflection | Ty
|
||||
}),
|
||||
],
|
||||
description: child.signatures?.[0]?.comment?.blockTags
|
||||
// eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
|
||||
?.find((block) => block.tag === '@returns')
|
||||
// eslint-disable-next-line no-param-reassign
|
||||
?.content.reduce((prev, curr) => (prev += curr.text), '')
|
||||
@@ -134,13 +129,12 @@ export class DocumentedTypeDef extends DocumentedItem<DeclarationReflection | Ty
|
||||
|
||||
const params = sig?.parameters?.map((param) => ({
|
||||
name: param.name,
|
||||
// eslint-disable-next-line @typescript-eslint/no-unnecessary-condition, @typescript-eslint/prefer-nullish-coalescing, no-param-reassign
|
||||
// eslint-disable-next-line @typescript-eslint/prefer-nullish-coalescing, no-param-reassign
|
||||
description: param.comment?.summary?.reduce((prev, curr) => (prev += curr.text), '').trim() || undefined,
|
||||
optional: param.flags.isOptional || typeof param.defaultValue !== 'undefined',
|
||||
default:
|
||||
(param.defaultValue === '...' ? undefined : param.defaultValue) ??
|
||||
(param.comment?.blockTags
|
||||
// eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
|
||||
?.find((block) => block.tag === '@default')
|
||||
// eslint-disable-next-line no-param-reassign
|
||||
?.content.reduce((prev, curr) => (prev += curr.text), '')
|
||||
@@ -152,7 +146,6 @@ export class DocumentedTypeDef extends DocumentedItem<DeclarationReflection | Ty
|
||||
: undefined,
|
||||
}));
|
||||
|
||||
// eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
|
||||
const see = sig?.comment?.blockTags?.filter((block) => block.tag === '@see').length
|
||||
? sig.comment.blockTags
|
||||
.filter((block) => block.tag === '@see')
|
||||
@@ -161,16 +154,14 @@ export class DocumentedTypeDef extends DocumentedItem<DeclarationReflection | Ty
|
||||
|
||||
return {
|
||||
...baseReturn,
|
||||
// eslint-disable-next-line @typescript-eslint/no-unnecessary-condition, @typescript-eslint/prefer-nullish-coalescing, no-param-reassign
|
||||
// eslint-disable-next-line @typescript-eslint/prefer-nullish-coalescing, no-param-reassign
|
||||
description: sig?.comment?.summary?.reduce((prev, curr) => (prev += curr.text), '').trim() || undefined,
|
||||
see,
|
||||
access:
|
||||
sig?.flags.isPrivate ||
|
||||
// eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
|
||||
sig?.comment?.blockTags?.some((block) => block.tag === '@private' || block.tag === '@internal')
|
||||
? 'private'
|
||||
: undefined,
|
||||
// eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
|
||||
deprecated: sig?.comment?.blockTags?.some((block) => block.tag === '@deprecated')
|
||||
? sig.comment.blockTags
|
||||
.find((block) => block.tag === '@deprecated')
|
||||
@@ -186,7 +177,6 @@ export class DocumentedTypeDef extends DocumentedItem<DeclarationReflection | Ty
|
||||
names: [parseType(sig.type)],
|
||||
description:
|
||||
sig.comment?.blockTags
|
||||
// eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
|
||||
?.find((block) => block.tag === '@returns')
|
||||
// eslint-disable-next-line no-param-reassign
|
||||
?.content.reduce((prev, curr) => (prev += curr.text), '')
|
||||
@@ -199,7 +189,6 @@ export class DocumentedTypeDef extends DocumentedItem<DeclarationReflection | Ty
|
||||
: undefined,
|
||||
returnsDescription:
|
||||
sig?.comment?.blockTags
|
||||
// eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
|
||||
?.find((block) => block.tag === '@returns')
|
||||
// eslint-disable-next-line no-param-reassign
|
||||
?.content.reduce((prev, curr) => (prev += curr.text), '')
|
||||
|
||||
@@ -91,7 +91,6 @@ export function parseType(someType: JSONOutput.SomeType | JSONOutput.Type | stri
|
||||
return `'${someType.value}'`;
|
||||
}
|
||||
|
||||
// eslint-disable-next-line @typescript-eslint/restrict-template-expressions
|
||||
return `${someType.value}`;
|
||||
}
|
||||
|
||||
|
||||
@@ -1,4 +1,3 @@
|
||||
/* eslint-disable @typescript-eslint/no-unsafe-member-access */
|
||||
import type { JSONOutput } from 'typedoc';
|
||||
|
||||
interface QueryType {
|
||||
|
||||
Reference in New Issue
Block a user