Skip to content

Commit 0791d1e

Browse files
committed
fixup! build, doc: use new api doc tooling
1 parent cfb5e9c commit 0791d1e

3 files changed

Lines changed: 245 additions & 397 deletions

File tree

test/doctool/test-doc-api-json.mjs

Lines changed: 21 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -41,16 +41,10 @@ const metaExpectedKeys = new Set([
4141

4242
function validateMeta(meta) {
4343
assert.partialDeepStrictEqual(metaExpectedKeys, new Set(Object.keys(meta)));
44-
assert.ok(
45-
!Object.hasOwn(meta, 'added') ||
46-
Array.isArray(meta.added) ||
47-
typeof meta.added === 'string',
48-
);
44+
assert.ok(!Object.hasOwn(meta, 'added') || Array.isArray(meta.added) || typeof meta.added === 'string');
4945
if (meta.deprecated) {
5046
numberOfDeprecatedSections++;
51-
assert.ok(
52-
Array.isArray(meta.deprecated) || typeof meta.deprecated === 'string',
53-
);
47+
assert.ok(Array.isArray(meta.deprecated) || typeof meta.deprecated === 'string');
5448
}
5549
if (meta.removed) {
5650
numberOfRemovedAPIs++;
@@ -121,15 +115,10 @@ const allExpectedKeys = new Set([
121115
'version',
122116
]);
123117

124-
for await (const dirent of await fs.opendir(
125-
new URL('../../out/doc/api/', import.meta.url),
126-
)) {
118+
for await (const dirent of await fs.opendir(new URL('../../out/doc/api/', import.meta.url))) {
127119
if (!dirent.name.endsWith('.md')) continue;
128120

129-
const jsonPath = path.join(
130-
dirent.parentPath,
131-
dirent.name.slice(0, -2) + 'json',
132-
);
121+
const jsonPath = path.join(dirent.parentPath, dirent.name.slice(0, -2) + 'json');
133122
const expectedSource = `doc/api/${dirent.name}`;
134123
if (dirent.name === 'quic.md') {
135124
assert.ok(!existsSync(jsonPath)); // QUIC documentation is not public yet
@@ -146,53 +135,26 @@ for await (const dirent of await fs.opendir(
146135
assert.strictEqual(json.source, expectedSource);
147136

148137
if (dirent.name !== 'index.md') {
149-
assert.ok(
150-
json.introduced_in || Object.values(json).at(-1)?.[0].introduced_in,
151-
);
138+
assert.ok(json.introduced_in || Object.values(json).at(-1)?.[0].introduced_in);
152139
assert.partialDeepStrictEqual(allExpectedKeys, findAllKeys(json));
153140
}
154141

155-
assert.deepStrictEqual(Object.keys(json).sort(), [
156-
'type',
157-
'api',
158-
'source',
159-
...({
160-
'addons.md': ['introduced_in', 'miscs'],
161-
'cli.md': ['introduced_in', 'miscs'],
162-
'debugger.md': ['introduced_in', 'stability', 'stabilityText', 'miscs'],
163-
'deprecations.md': ['introduced_in', 'miscs'],
164-
'documentation.md': ['introduced_in', 'miscs'],
165-
'errors.md': ['introduced_in', 'classes', 'miscs'],
166-
'esm.md': [
167-
'introduced_in',
168-
'meta',
169-
'stability',
170-
'stabilityText',
171-
'properties',
172-
'miscs',
173-
],
174-
'globals.md': [
175-
'introduced_in',
176-
'stability',
177-
'stabilityText',
178-
'classes',
179-
'methods',
180-
'miscs',
181-
],
182-
'intl.md': ['introduced_in', 'miscs'],
183-
'n-api.md': ['introduced_in', 'stability', 'stabilityText', 'miscs'],
184-
'packages.md': ['introduced_in', 'meta', 'miscs'],
185-
'process.md': ['globals'],
186-
'report.md': [
187-
'introduced_in',
188-
'meta',
189-
'stability',
190-
'stabilityText',
191-
'miscs',
192-
],
193-
'synopsis.md': ['introduced_in', 'miscs'],
194-
}[dirent.name] ?? ['modules']),
195-
]);
142+
assert.deepStrictEqual(Object.keys(json).sort(), ['type', 'api', 'source', ...({
143+
'addons.md': ['introduced_in', 'miscs'],
144+
'cli.md': ['introduced_in', 'miscs'],
145+
'debugger.md': ['introduced_in', 'stability', 'stabilityText', 'miscs'],
146+
'deprecations.md': ['introduced_in', 'miscs'],
147+
'documentation.md': ['introduced_in', 'miscs'],
148+
'errors.md': ['introduced_in', 'classes', 'miscs'],
149+
'esm.md': ['introduced_in', 'meta', 'stability', 'stabilityText', 'properties', 'miscs'],
150+
'globals.md': ['introduced_in', 'stability', 'stabilityText', 'classes', 'methods', 'miscs'],
151+
'intl.md': ['introduced_in', 'miscs'],
152+
'n-api.md': ['introduced_in', 'stability', 'stabilityText', 'miscs'],
153+
'packages.md': ['introduced_in', 'meta', 'miscs'],
154+
'process.md': ['globals'],
155+
'report.md': ['introduced_in', 'meta', 'stability', 'stabilityText', 'miscs'],
156+
'synopsis.md': ['introduced_in', 'miscs'],
157+
}[dirent.name] ?? ['modules'])]);
196158

197159
assert.partialDeepStrictEqual(allExpectedKeys, findAllKeys(json));
198160
}

0 commit comments

Comments
 (0)