Some checks failed
App Prod-Parity E2E Dispatch / dispatch (push) Failing after 10s
CD Storybook UI / build (push) Failing after 3m25s
CD Storybook UI / dispatch (push) Has been skipped
CD deploy main / website-changed-files (push) Successful in 18m8s
CI Agent Skills / changed-files-check (push) Successful in 18m9s
CI Create App E2E minimal / changed-files-check (push) Successful in 24s
CI Create App / changed-files-check (push) Successful in 26s
CI Docs / changed-files-check (push) Successful in 26s
CI Emails / changed-files-check (push) Successful in 28s
CI Example App Hello World / changed-files-check (push) Successful in 23s
CI Front / changed-files-check (push) Has been skipped
CI Example App Postcard / changed-files-check (push) Successful in 27s
CI UI / changed-files-check (push) Has been skipped
CI Utils Test / changed-files-check (push) Successful in 45s
CI Twenty Apps / discover (push) Successful in 1m3s
CD deploy main / deploy-main (push) Failing after 3s
CI Agent Skills / agent-skills-validate (push) Has been skipped
CI Create App / create-app-test (lint) (push) Has been skipped
CI Emails / emails-test (push) Has been skipped
CI Front / front-task (lingui:compile) (push) Has been skipped
CI Front / front-task (lint) (push) Has been skipped
CI Example App Postcard / example-app-postcard (push) Has been skipped
CI UI / ui-task (lint) (push) Has been skipped
CI UI / ui-task (pack-size) (push) Has been skipped
CI UI / ui-task (size) (push) Has been skipped
CI UI / ui-task (test) (push) Has been skipped
CI UI / ui-task (typecheck) (push) Has been skipped
CI Utils Test / utils-test (push) Has been skipped
CI Twenty Apps / ${{ matrix.app.name }} (push) Has been skipped
CI Emails / ci-emails-status-check (push) Successful in 2s
CI Example App Hello World / ci-example-app-hello-world-status-check (push) Successful in 2s
CI Example App Postcard / ci-example-app-postcard-status-check (push) Successful in 3s
CI UI / ui-sb-test (push) Has been skipped
CI Utils Test / ci-utils-test-status-check (push) Successful in 2s
CI Twenty Apps / ci-twenty-apps-status-check (push) Successful in 2s
CI UI / ci-ui-status-check (push) Successful in 2s
CI Desktop / desktop (push) Failing after 1m8s
Push docs to Crowdin / Push documentation to Crowdin (push) Failing after 55s
Push translations to Crowdin / Extract and upload translations (push) Failing after 5s
Push website translations to Crowdin / Extract and upload website translations (push) Failing after 5s
CI Create App / create-app-test (test) (push) Has been skipped
CI Create App / create-app-test (typecheck) (push) Has been skipped
CI Docs / docs-lint (push) Has been skipped
CI Example App Hello World / example-app-hello-world (push) Has been skipped
CI Front / front-task (lingui:extract) (push) Has been skipped
CI Front / front-task (test) (push) Has been skipped
CI Front / front-task (typecheck) (push) Has been skipped
CI UI / ui-sb-build (push) Failing after 1m32s
CI Twenty Apps / ${{ matrix.app.name }} (${{ matrix.server-source }}) (push) Has been skipped
CI Agent Skills / agent-skills-publish (push) Has been skipped
CI Create App / ci-create-app-status-check (push) Successful in 2s
CI Agent Skills / agent-skills-remote-source (push) Has been skipped
CI Create App E2E minimal / create-app-e2e-minimal (push) Has been cancelled
CI E2E Main / e2e-test (push) Has been cancelled
CI Front / front-sb-build (push) Has been cancelled
CI Front / front-build (push) Has been cancelled
CI Create App E2E minimal / ci-create-app-e2e-minimal-status-check (push) Has been cancelled
CI E2E Main / ci-e2e-main-status-check (push) Has been cancelled
CI E2E Main / notify-main-ci-failure (push) Has been cancelled
CI E2E Main / qa-scout-comment (push) Has been cancelled
CI Front / front-sb-test (push) Has been cancelled
CI Front / front-sb-screenshots (push) Has been cancelled
CI Front / ci-front-status-check (push) Has been cancelled
DPA Sub-Processor Sync / sync-subprocessors (push) Failing after 3s
AI Catalog Sync / sync-catalog (push) Failing after 2s
72 lines
1.8 KiB
TypeScript
72 lines
1.8 KiB
TypeScript
const FENCE_OPENING_PATTERN = /^(\s*)(`{3,}|~{3,})[ \t]*(\S*)/;
|
|
const FENCE_CLOSING_PATTERN = /^\s*(`{3,}|~{3,})\s*$/;
|
|
const EXAMPLE_LANGUAGES = ['ts', 'tsx'] as const;
|
|
|
|
type OpenFence = {
|
|
indentation: number;
|
|
marker: string;
|
|
language: string;
|
|
codeLines: string[];
|
|
};
|
|
|
|
const isExampleLanguage = (
|
|
language: string,
|
|
): language is (typeof EXAMPLE_LANGUAGES)[number] =>
|
|
EXAMPLE_LANGUAGES.some((exampleLanguage) => exampleLanguage === language);
|
|
|
|
const closesFence = (line: string, fence: OpenFence): boolean => {
|
|
const marker = FENCE_CLOSING_PATTERN.exec(line)?.[1];
|
|
|
|
return (
|
|
marker !== undefined &&
|
|
marker[0] === fence.marker[0] &&
|
|
marker.length >= fence.marker.length
|
|
);
|
|
};
|
|
|
|
const removeIndentation = (line: string, indentation: number): string => {
|
|
const leadingWhitespace = line.length - line.trimStart().length;
|
|
|
|
return line.slice(Math.min(leadingWhitespace, indentation));
|
|
};
|
|
|
|
export const extractDocumentationExamples = (
|
|
content: string,
|
|
): { language: 'ts' | 'tsx'; code: string }[] => {
|
|
const examples: { language: 'ts' | 'tsx'; code: string }[] = [];
|
|
let openFence: OpenFence | null = null;
|
|
|
|
for (const line of content.split(/\r?\n/)) {
|
|
if (openFence === null) {
|
|
const opening = FENCE_OPENING_PATTERN.exec(line);
|
|
|
|
if (opening) {
|
|
openFence = {
|
|
indentation: opening[1].length,
|
|
marker: opening[2],
|
|
language: opening[3].toLowerCase(),
|
|
codeLines: [],
|
|
};
|
|
}
|
|
|
|
continue;
|
|
}
|
|
|
|
if (!closesFence(line, openFence)) {
|
|
openFence.codeLines.push(removeIndentation(line, openFence.indentation));
|
|
continue;
|
|
}
|
|
|
|
if (isExampleLanguage(openFence.language)) {
|
|
examples.push({
|
|
language: openFence.language,
|
|
code: `${openFence.codeLines.join('\n')}\n`,
|
|
});
|
|
}
|
|
|
|
openFence = null;
|
|
}
|
|
|
|
return examples;
|
|
};
|