Skip to content

fix: filter out new keys from legacy JSON generator #595

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

Merged
ovflowd merged 12 commits into from
Feb 9, 2026
Merged

fix: filter out new keys from legacy JSON generator #595

Show file tree
Hide file tree
Changes from 9 commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
aefa413
fix: filter out new keys from legacy JSON generator
aduh95 Feb 7, 2026
704b728
Remove TODO comment for additional JSON keys
aduh95 Feb 7, 2026
bb9559a
readd TODO
aduh95 Feb 7, 2026
b69ded0
add to legacy json-all generator
aduh95 Feb 7, 2026
7078901
Apply suggestion from @aduh95
aduh95 Feb 7, 2026
7da8299
Apply suggestion from @aduh95
aduh95 Feb 7, 2026
488a2a3
move to separate function
aduh95 Feb 7, 2026
a8e1af5
squash!
aduh95 Feb 7, 2026
c231947
fixup! format
avivkeller Feb 7, 2026
870043b
squash! order
aduh95 Feb 9, 2026
236c8b0
fixup! squash! order
aduh95 Feb 9, 2026
632755b
squash! only filter and order top-level keys
aduh95 Feb 9, 2026
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
7 changes: 3 additions & 4 deletions src/generators/legacy-json-all/index.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
import { writeFile } from 'node:fs/promises';
import { join } from 'node:path';

import { legacyToJSON } from '../../utils/generators.mjs';

/**
* This generator consolidates data from the `legacy-json` generator into a single
* JSON file (`all.json`).
Expand Down Expand Up @@ -83,10 +85,7 @@ export default {
}

if (output) {
await writeFile(
join(output, 'all.json'),
JSON.stringify(generatedValue, null, 2)
);
await writeFile(join(output, 'all.json'), legacyToJSON(generatedValue));
}

return generatedValue;
Expand Down
4 changes: 2 additions & 2 deletions src/generators/legacy-json/index.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import { writeFile } from 'node:fs/promises';
import { join } from 'node:path';

import { createSectionBuilder } from './utils/buildSection.mjs';
import { groupNodesByModule } from '../../utils/generators.mjs';
import { groupNodesByModule, legacyToJSON } from '../../utils/generators.mjs';

const buildSection = createSectionBuilder();

Expand Down Expand Up @@ -78,7 +78,7 @@ export default {
for (const section of chunkResult) {
const out = join(output, `${section.api}.json`);

await writeFile(out, JSON.stringify(section, null, 2));
await writeFile(out, legacyToJSON(section));
}
}

Expand Down
49 changes: 49 additions & 0 deletions src/utils/generators.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,3 +109,52 @@ export const sortChanges = (changes, key = 'version') => {
*/
export const leftHandAssign = (target, source) =>
Object.keys(source).forEach(k => k in target || (target[k] = source[k]));

/**
* Transforms an object to JSON output consistent with the JSON version.
* @param {Object} section - The source object
* @returns {string} - The JSON output
*/
export const legacyToJSON = section =>
JSON.stringify(
section,
[
// TODO: remove this array once all the additional keys have been introduced downstream
'added',
'changes',
'classes',
'classMethods',
'commit',
'ctors',
'default',
'deprecated',
'desc',
'description',
'displayName',
'events',
'examples',
'globals',
'introduced_in',
'meta',
'methods',
'miscs',
...(section.api === 'index' ? [] : ['modules']),
'name',
'napiVersion',
'options',
'params',
'pr-url',
'properties',
'removed',
'return',
'shortDesc',
'signatures',
'source',
'stability',
'stabilityText',
'textRaw',
'type',
'version',
],
2
);
Loading