Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: format signature with prettier #2956

Merged
merged 2 commits into from
Jun 19, 2024
Merged

docs: format signature with prettier #2956

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5bf334f
docs: format signature with prettier
ST-DDT Jun 18, 2024
e2b6f60
Merge branch 'next' into docs/format/signature
ST-DDT Jun 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 10 additions & 6 deletions scripts/apidocs/output/page.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import { resolve } from 'node:path';
import type { ApiDocsMethod } from '../../../docs/.vitepress/components/api-docs/method';
import type { RawApiDocsPage } from '../processing/class';
import type { RawApiDocsMethod } from '../processing/method';
import { formatMarkdown } from '../utils/format';
import { formatMarkdown, formatTypescript } from '../utils/format';
import { adjustUrls, codeToHtml, mdToHtml } from '../utils/markdown';
import { FILE_PATH_API_DOCS } from '../utils/paths';
import { required } from '../utils/value-checks';
Expand Down Expand Up @@ -33,7 +33,7 @@ export async function writePages(pages: RawApiDocsPage[]): Promise<void> {
async function writePage(page: RawApiDocsPage): Promise<void> {
try {
await writePageMarkdown(page);
writePageJsonData(page);
await writePageJsonData(page);
} catch (error) {
throw new Error(`Error writing page ${page.title}`, { cause: error });
}
Expand Down Expand Up @@ -98,10 +98,12 @@ async function writePageMarkdown(page: RawApiDocsPage): Promise<void> {
*
* @param page The page to write.
*/
function writePageJsonData(page: RawApiDocsPage): void {
async function writePageJsonData(page: RawApiDocsPage): Promise<void> {
const { camelTitle, methods } = page;
const pageData: Record<string, ApiDocsMethod> = Object.fromEntries(
methods.map((method) => [method.name, toMethodData(method)])
await Promise.all(
methods.map(async (method) => [method.name, await toMethodData(method)])
)
);
const content = JSON.stringify(pageData, null, 2);

Expand All @@ -110,7 +112,7 @@ function writePageJsonData(page: RawApiDocsPage): void {

const defaultCommentRegex = /\s+Defaults to `([^`]+)`\..*/;

function toMethodData(method: RawApiDocsMethod): ApiDocsMethod {
async function toMethodData(method: RawApiDocsMethod): Promise<ApiDocsMethod> {
const { name, signatures, source } = method;
const signatureData = required(signatures.at(-1), 'method signature');
const {
Expand All @@ -125,6 +127,8 @@ function toMethodData(method: RawApiDocsMethod): ApiDocsMethod {
seeAlsos,
} = signatureData;
const { filePath, line } = source;
let formattedSignature = await formatTypescript(signature);
formattedSignature = formattedSignature.trim();

/* Target order, omitted to improve diff to old files
return {
Expand Down Expand Up @@ -161,7 +165,7 @@ function toMethodData(method: RawApiDocsMethod): ApiDocsMethod {
sourcePath: `${filePath}#L${line}`,
throws: throws.length === 0 ? undefined : mdToHtml(throws.join('\n'), true),
returns: returns.text,
examples: codeToHtml([signature, ...examples].join('\n')),
examples: codeToHtml([formattedSignature, ...examples].join('\n')),
deprecated: mdToHtml(deprecated),
seeAlsos: seeAlsos.map((seeAlso) => mdToHtml(seeAlso, true)),
};
Expand Down
Loading