Skip to content

chore: Migrate to the new documenter API #82

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

Closed
wants to merge 2 commits into from
Closed

chore: Migrate to the new documenter API #82

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8abde3a
chore: Migrate to the new documenter API
taheramr May 22, 2025
9c7f0c3
chore: Add documenter tests
taheramr May 22, 2025
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
28 changes: 4 additions & 24 deletions scripts/docs.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,41 +2,21 @@
// SPDX-License-Identifier: Apache-2.0
import path from "node:path";

import { documentComponents, documentTestUtils } from "@cloudscape-design/documenter";
import { documentTestUtils, writeComponentsDocumentation } from "@cloudscape-design/documenter";

import { listPublicDirs, writeSourceFile } from "./utils.js";
import { writeSourceFile } from "./utils.js";

const publicDirs = listPublicDirs("src");
const targetDir = "lib/components/internal/api-docs";

componentDocs();
testUtilDocs();

function validatePublicFiles(definitionFiles) {
for (const publicDir of publicDirs) {
if (!definitionFiles.includes(publicDir)) {
throw new Error(`Directory src/${publicDir} does not have a corresponding API definition`);
}
}
}

function componentDocs() {
const definitions = documentComponents({
writeComponentsDocumentation({
outDir: path.join(targetDir, "components"),
tsconfigPath: path.resolve("tsconfig.json"),
publicFilesGlob: "src/*/index.tsx",
});
const outDir = path.join(targetDir, "components");
for (const definition of definitions) {
writeSourceFile(
path.join(outDir, definition.dashCaseName + ".js"),
`module.exports = ${JSON.stringify(definition, null, 2)};`,
);
}
const indexContent = `module.exports = {
${definitions.map((definition) => `${JSON.stringify(definition.dashCaseName)}:require('./${definition.dashCaseName}')`).join(",\n")}
}`;
writeSourceFile(path.join(outDir, "index.js"), indexContent);
validatePublicFiles(definitions.map((def) => def.dashCaseName));
}

function testUtilDocs() {
Expand Down
3 changes: 1 addition & 2 deletions src/__tests__/documenter.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,8 @@
// SPDX-License-Identifier: Apache-2.0
import { expect, test } from "vitest";

// @ts-expect-error no types here
import apiDocs from "../../lib/components/internal/api-docs/components";

test.each(Object.entries(apiDocs))("definition for $0 matches the snapshot", (name, definition) => {
test.each(Object.entries(apiDocs))("definition for $0 matches the snapshot", (_name, definition) => {
expect(definition).toMatchSnapshot();
});
Loading