mirror of
https://github.com/angular/angular
synced 2026-05-24 09:28:37 +00:00
ca700e1def
The commit introduce prettier to format some API entries. For now we'll do only functions are other are a bit more complex because of the support of deprecation. fixes #59211 PR Close #61154
85 lines
2.8 KiB
TypeScript
85 lines
2.8 KiB
TypeScript
/*!
|
|
* @license
|
|
* Copyright Google LLC All Rights Reserved.
|
|
*
|
|
* Use of this source code is governed by an MIT-style license that can be
|
|
* found in the LICENSE file at https://angular.dev/license
|
|
*/
|
|
|
|
import {DocEntry} from './entities.mjs';
|
|
|
|
import {CliCommand} from './cli-entities.mjs';
|
|
import {
|
|
isClassEntry,
|
|
isCliEntry,
|
|
isConstantEntry,
|
|
isDecoratorEntry,
|
|
isEnumEntry,
|
|
isFunctionEntry,
|
|
isInitializerApiFunctionEntry,
|
|
isInterfaceEntry,
|
|
isTypeAliasEntry,
|
|
} from './entities/categorization.mjs';
|
|
import {CliCommandRenderable, DocEntryRenderable} from './entities/renderables.mjs';
|
|
import {getClassRenderable} from './transforms/class-transforms.mjs';
|
|
import {getCliRenderable} from './transforms/cli-transforms.mjs';
|
|
import {getConstantRenderable} from './transforms/constant-transforms.mjs';
|
|
import {getDecoratorRenderable} from './transforms/decorator-transforms.mjs';
|
|
import {getEnumRenderable} from './transforms/enum-transforms.mjs';
|
|
import {getFunctionRenderable} from './transforms/function-transforms.mjs';
|
|
import {getInitializerApiFunctionRenderable} from './transforms/initializer-api-functions-transform.mjs';
|
|
import {getInterfaceRenderable} from './transforms/interface-transforms.mjs';
|
|
import {
|
|
addHtmlAdditionalLinks,
|
|
addHtmlDescription,
|
|
addHtmlJsDocTagComments,
|
|
addHtmlUsageNotes,
|
|
setEntryFlags,
|
|
} from './transforms/jsdoc-transforms.mjs';
|
|
import {addModuleName} from './transforms/module-name.mjs';
|
|
import {addRepo} from './transforms/repo.mjs';
|
|
import {getTypeAliasRenderable} from './transforms/type-alias-transforms.mjs';
|
|
|
|
export async function getRenderable(
|
|
entry: DocEntry | CliCommand,
|
|
moduleName: string,
|
|
repo: string,
|
|
): Promise<DocEntryRenderable | CliCommandRenderable> {
|
|
if (isCliEntry(entry)) {
|
|
return getCliRenderable(entry);
|
|
}
|
|
|
|
if (isClassEntry(entry)) {
|
|
return getClassRenderable(entry, moduleName, repo);
|
|
}
|
|
if (isDecoratorEntry(entry)) {
|
|
return getDecoratorRenderable(entry, moduleName, repo);
|
|
}
|
|
if (isConstantEntry(entry)) {
|
|
return getConstantRenderable(entry, moduleName, repo);
|
|
}
|
|
if (isEnumEntry(entry)) {
|
|
return getEnumRenderable(entry, moduleName, repo);
|
|
}
|
|
if (isInterfaceEntry(entry)) {
|
|
return getInterfaceRenderable(entry, moduleName, repo);
|
|
}
|
|
if (isFunctionEntry(entry)) {
|
|
return getFunctionRenderable(entry, moduleName, repo);
|
|
}
|
|
if (isTypeAliasEntry(entry)) {
|
|
return getTypeAliasRenderable(entry, moduleName, repo);
|
|
}
|
|
if (isInitializerApiFunctionEntry(entry)) {
|
|
return getInitializerApiFunctionRenderable(entry, moduleName, repo);
|
|
}
|
|
|
|
// Fallback to an uncategorized renderable.
|
|
return setEntryFlags(
|
|
addHtmlAdditionalLinks(
|
|
addHtmlDescription(
|
|
addHtmlUsageNotes(addHtmlJsDocTagComments(addRepo(addModuleName(entry, moduleName), repo))),
|
|
),
|
|
),
|
|
);
|
|
}
|