Skip to content

fix(legacy-json): verify list type #322

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.

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
merged 2 commits into from
Jun 27, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
46 changes: 46 additions & 0 deletions src/generators/legacy-json/utils/__tests__/parseList.test.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -123,4 +123,50 @@ describe('parseList', () => {
parseList(section, nodes);
assert.ok(Array.isArray(section.params));
});

it('processes recursive lists', () => {
const section = { type: 'event' };
const nodes = [
{
type: 'list',
children: [
{
children: [
{
type: 'paragraph',
children: [
{ type: 'text', value: 'param1 {string} first parameter' },
],
},
// This is a nested typed list
{
type: 'list',
children: [
{
children: [
{
type: 'paragraph',
children: [
{ type: 'inlineCode', value: 'option' }, // inline code
{ type: 'text', value: ' ' }, // space
{
type: 'link',
children: [{ type: 'text', value: '<boolean>' }], // link with < value
},
{ type: 'text', value: ' option description' },
],
},
],
},
],
},
],
},
],
},
];

parseList(section, nodes);
assert.equal(section.params[0].options.length, 1);
});
});
33 changes: 29 additions & 4 deletions src/generators/legacy-json/utils/parseList.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,30 @@
return text.replace(pattern, '');
};

/**
* Determines if the input List node is a typed list
* @param {import('@types/mdast').List} list
*/
export const isTypedList = list => {
if (list.type !== 'list') {
// Exit early if not a list
return false;
}

const children = list?.children?.[0]?.children?.[0]?.children;

return (
// The first element must be a code block
children?.[0]?.type === 'inlineCode' &&
// Followed by a space
children?.[1]?.value.trim() === '' &&
// Followed by a link (type)
children?.[2]?.type === 'link' &&
// Types start with `<`
children?.[2]?.children?.[0]?.value?.[0] === '<'
);
};

/**
* Parses an individual list item node to extract its properties
*
Expand All @@ -46,11 +70,13 @@
export function parseListItem(child) {
const current = {};

const subList = child.children.find(isTypedList);

// Extract and clean raw text from the node, excluding nested lists
current.textRaw = transformTypeReferences(
transformNodesToString(child.children.filter(node => node.type !== 'list'))
transformNodesToString(child.children.filter(node => node !== subList))
.replace(/\s+/g, ' ')
.replace(/<!--.*?-->/gs, '')

Check failure

Code scanning / CodeQL

Incomplete multi-character sanitization High

This string may still contain
<!--
, which may cause an HTML element injection vulnerability.
);

let text = current.textRaw;
Expand All @@ -70,9 +96,8 @@
current.desc = text.replace(LEADING_HYPHEN, '').trim() || undefined;

// Parse nested lists (options) recursively if present
const optionsNode = child.children.find(node => node.type === 'list');
if (optionsNode) {
current.options = optionsNode.children.map(parseListItem);
if (subList) {
current.options = subList.children.map(parseListItem);
}

return current;
Expand Down
Loading