Skip to content

fix(isTypedList): validate property syntax #414

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
avivkeller merged 3 commits into from
Aug 23, 2025
Merged

fix(isTypedList): validate property syntax #414

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
fcef3a5
fix(isTypedList): validate property syntax
avivkeller Aug 19, 2025
3db7a7a
add tests, fix edge case
avivkeller Aug 20, 2025
a71661d
add .
avivkeller Aug 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
110 changes: 110 additions & 0 deletions src/utils/queries/__tests__/index.test.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,4 +110,114 @@ describe('createQueries', () => {
};
queries.addStabilityMetadata(node, apiEntryMetadata);
});

describe('UNIST', () => {
describe('isTypedList', () => {
it('returns false for non-list nodes', () => {
strictEqual(
createQueries.UNIST.isTypedList({ type: 'paragraph', children: [] }),
false
);
});

it('returns false for empty lists', () => {
strictEqual(
createQueries.UNIST.isTypedList({ type: 'list', children: [] }),
false
);
});

const cases = [
{
name: 'typedListStarters pattern match',
node: {
type: 'list',
children: [
{
children: [
{
children: [{ type: 'text', value: 'Returns: foo' }],
},
],
},
],
},
expected: true,
},
{
name: 'direct type link pattern',
node: {
type: 'list',
children: [
{
children: [
{
children: [
{
type: 'link',
children: [{ type: 'inlineCode', value: '<Type>' }],
},
],
},
],
},
],
},
expected: true,
},
{
name: 'inlineCode + space + type link pattern',
node: {
type: 'list',
children: [
{
children: [
{
children: [
{ type: 'inlineCode', value: 'foo' },
{ type: 'text', value: ' ' },
{
type: 'link',
children: [{ type: 'text', value: '<Bar>' }],
},
],
},
],
},
],
},
expected: true,
},
{
name: 'non-matching content',
node: {
type: 'list',
children: [
{
children: [
{
children: [
{ type: 'inlineCode', value: 'not a valid prop' },
{ type: 'text', value: ' ' },
{
type: 'link',
children: [{ type: 'text', value: '<Bar>' }],
},
],
},
],
},
],
},
expected: false,
},
];

cases.forEach(({ name, node, expected }) => {
it(`returns ${expected} for ${name}`, () => {
strictEqual(createQueries.UNIST.isTypedList(node), expected);
});
});
});
});
});
2 changes: 2 additions & 0 deletions src/utils/queries/constants.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,5 @@
// This is the perma-link within the API docs that reference the Stability Index
export const DOC_API_STABILITY_SECTION_REF_URL =
'documentation.html#stability-index';

export const VALID_JAVASCRIPT_PROPERTY = /^[.a-z0-9$_]+$/i;
16 changes: 10 additions & 6 deletions src/utils/queries/index.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,10 @@
import { u as createTree } from 'unist-builder';
import { SKIP } from 'unist-util-visit';

import { DOC_API_STABILITY_SECTION_REF_URL } from './constants.mjs';
import {
DOC_API_STABILITY_SECTION_REF_URL,
VALID_JAVASCRIPT_PROPERTY,
} from './constants.mjs';
import {
extractYamlContent,
parseHeadingIntoMetadata,
Expand Down Expand Up @@ -278,15 +281,15 @@ createQueries.UNIST = {
const [node, ...contentNodes] =
list?.children?.[0]?.children?.[0]?.children ?? [];

// Exit if no content nodes
// Exit if no node
if (!node) {
return false;
}

const possibleProperty = node?.value?.trimStart();

// Check for other starters
if (
node.value?.trimStart().match(createQueries.QUERIES.typedListStarters)
) {
if (possibleProperty?.match(createQueries.QUERIES.typedListStarters)) {
return true;
}

Expand All @@ -298,7 +301,8 @@ createQueries.UNIST = {
// Check for inline code + space + type link pattern
if (
node.type === 'inlineCode' &&
contentNodes[0]?.value.trim() === '' &&
possibleProperty?.match(VALID_JAVASCRIPT_PROPERTY) &&
contentNodes[0]?.value?.trim() === '' &&
contentNodes[1]?.type === 'link' &&
contentNodes[1]?.children?.[0]?.value?.[0] === '<'
) {
Expand Down
Loading