Skip to content

fix(legacy-json): more robust signature parsing #347

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 1 commit into from
Jul 9, 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
333 changes: 271 additions & 62 deletions src/generators/legacy-json/utils/__tests__/parseSignature.test.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -5,90 +5,299 @@ import parseSignature, {
parseDefaultValue,
findParameter,
parseParameters,
parseNameAndOptionalStatus,
} from '../parseSignature.mjs';

describe('parseDefaultValue', () => {
it('extracts default value', () => {
const [name, defaultVal] = parseDefaultValue('param=default');
assert.equal(name, 'param');
assert.equal(defaultVal, '=default');
});
describe('parseNameAndOptionalStatus', () => {
const testCases = [
{
name: 'simple parameter names',
input: { paramName: 'param', depth: 0 },
expected: { name: 'param', depth: 0, isOptional: false },
},
{
name: 'optional parameters with brackets',
input: { paramName: '[param]', depth: 0 },
expected: { name: 'param', depth: 0, isOptional: true },
},
{
name: 'partial brackets at beginning',
input: { paramName: '[param', depth: 0 },
expected: { name: 'param', depth: 1, isOptional: true },
},
{
name: 'partial brackets at end',
input: { paramName: 'param]', depth: 1 },
expected: { name: 'param', depth: 0, isOptional: true },
},
{
name: 'complex nested bracket',
input: { paramName: 'b[', depth: 1 },
expected: { name: 'b', depth: 2, isOptional: true },
},
];

it('handles no default value', () => {
const [name, defaultVal] = parseDefaultValue('param');
assert.equal(name, 'param');
assert.equal(defaultVal, undefined);
});
for (const testCase of testCases) {
it(testCase.name, () => {
const { paramName, depth } = testCase.input;
const [name, newDepth, isOptional] = parseNameAndOptionalStatus(
paramName,
depth
);
assert.equal(name, testCase.expected.name);
assert.equal(newDepth, testCase.expected.depth);
assert.equal(isOptional, testCase.expected.isOptional);
});
}
});

describe('findParameter', () => {
it('finds parameter by index', () => {
const params = [{ name: 'first' }, { name: 'second' }];
const result = findParameter('first', 0, params);
assert.equal(result.name, 'first');
});
describe('parseDefaultValue', () => {
const testCases = [
{
name: 'extracts default value',
input: 'param=default',
expected: { name: 'param', defaultVal: '=default' },
},
{
name: 'handles no default value',
input: 'param',
expected: { name: 'param', defaultVal: undefined },
},
{
name: 'handles complex default values',
input: 'param={x: [1,2,3]}',
expected: { name: 'param', defaultVal: '={x: [1,2,3]}' },
},
{
name: 'handles multiple equal signs',
input: 'param=x=y=z',
expected: { name: 'param', defaultVal: '=x=y=z' },
},
];

it('searches by name when index fails', () => {
const params = [{ name: 'first' }, { name: 'second' }];
const result = findParameter('second', 0, params);
assert.equal(result.name, 'second');
});
for (const testCase of testCases) {
it(testCase.name, () => {
const [name, defaultVal] = parseDefaultValue(testCase.input);
assert.equal(name, testCase.expected.name);
assert.equal(defaultVal, testCase.expected.defaultVal);
});
}
});

it('finds in nested options', () => {
const params = [
describe('findParameter', () => {
it('handles various parameter finding scenarios', () => {
const testCases = [
{
name: 'options',
options: [{ name: 'nested' }],
name: 'finds by index',
input: {
paramName: 'first',
index: 0,
params: [{ name: 'first' }, { name: 'second' }],
},
expected: { name: 'first' },
},
{
name: 'searches by name',
input: {
paramName: 'second',
index: 0,
params: [{ name: 'first' }, { name: 'second' }],
},
expected: { name: 'second' },
},
{
name: 'finds in nested options',
input: {
paramName: 'nested',
index: 0,
params: [
{
name: 'options',
options: [
{ name: 'nested', type: 'string', description: 'test' },
],
},
],
},
expected: { name: 'nested', type: 'string', description: 'test' },
},
{
name: 'returns default when not found',
input: {
paramName: 'missing',
index: 0,
params: [],
},
expected: { name: 'missing' },
},
];
const result = findParameter('nested', 0, params);
assert.equal(result.name, 'nested');
});

it('returns default when not found', () => {
const result = findParameter('missing', 0, []);
assert.equal(result.name, 'missing');
for (const testCase of testCases) {
const { paramName, index, params } = testCase.input;
const result = findParameter(paramName, index, params);

// Check all expected properties
for (const key in testCase.expected) {
assert.equal(result[key], testCase.expected[key]);
}
}
});
});

describe('parseParameters', () => {
it('parses simple parameters', () => {
const declared = ['param1', 'param2'];
const markdown = [{ name: 'param1' }, { name: 'param2' }];
const result = parseParameters(declared, markdown);

assert.equal(result.length, 2);
assert.equal(result[0].name, 'param1');
assert.equal(result[1].name, 'param2');
});
const testCases = [
{
name: 'parses simple parameters',
input: {
declared: ['param1', 'param2'],
markdown: [{ name: 'param1' }, { name: 'param2' }],
},
expected: [{ name: 'param1' }, { name: 'param2' }],
},
{
name: 'handles default values',
input: {
declared: ['param=value'],
markdown: [{ name: 'param' }],
},
expected: [{ name: 'param', default: '=value' }],
},
{
name: 'marks optional parameters',
input: {
declared: ['[optional]', 'required'],
markdown: [{ name: 'optional' }, { name: 'required' }],
},
expected: [{ name: 'optional', optional: true }, { name: 'required' }],
},
{
name: 'handles both brackets and default values',
input: {
declared: ['[param=default]'],
markdown: [{ name: 'param' }],
},
expected: [{ name: 'param', optional: true, default: '=default' }],
},
];

it('handles default values', () => {
const declared = ['param=value'];
const markdown = [{ name: 'param' }];
const result = parseParameters(declared, markdown);
for (const testCase of testCases) {
it(testCase.name, () => {
const result = parseParameters(
testCase.input.declared,
testCase.input.markdown
);
assert.equal(result.length, testCase.expected.length);

assert.equal(result[0].default, '=value');
});
for (let i = 0; i < result.length; i++) {
for (const key in testCase.expected[i]) {
assert.deepEqual(result[i][key], testCase.expected[i][key]);
}
}
});
}
});

describe('parseSignature', () => {
it('returns empty signature for no parameters', () => {
const result = parseSignature('`method()`', []);
assert.deepEqual(result.params, []);
});
const testCases = [
{
name: 'returns empty signature for no parameters',
input: {
textRaw: '`method()`',
markdown: [],
},
expected: { params: [] },
},
{
name: 'extracts return value',
input: {
textRaw: '`method()`',
markdown: [{ name: 'return', type: 'string' }],
},
expected: {
params: [],
return: { name: 'return', type: 'string' },
},
},
{
name: 'parses method with parameters',
input: {
textRaw: '`method(param1, param2)`',
markdown: [{ name: 'param1' }, { name: 'param2' }],
},
expected: {
params: [{ name: 'param1' }, { name: 'param2' }],
},
},
{
name: 'parses complex nested optional parameters',
input: {
textRaw: '`new Blob([sources[, options]])`',
markdown: [{ name: 'sources' }, { name: 'options' }],
},
expected: {
params: [
{ name: 'sources', optional: true },
{ name: 'options', optional: true },
],
},
},
{
name: 'handles multiple levels of nested optionals',
input: {
textRaw: '`method(a[, b[, c]])`',
markdown: [{ name: 'a' }, { name: 'b' }, { name: 'c' }],
},
expected: {
params: [
{ name: 'a' },
{ name: 'b', optional: true },
{ name: 'c', optional: true },
],
},
},
{
name: 'handles real-world complex signatures',
input: {
textRaw: '`new Console(stdout[, stderr][, ignoreErrors])`',
markdown: [
{ name: 'stdout' },
{ name: 'stderr' },
{ name: 'ignoreErrors' },
],
},
expected: {
params: [
{ name: 'stdout' },
{ name: 'stderr', optional: true },
{ name: 'ignoreErrors', optional: true },
],
},
},
];

it('extracts return value', () => {
const markdown = [{ name: 'return', type: 'string' }];
const result = parseSignature('`method()`', markdown);
for (const testCase of testCases) {
it(testCase.name, () => {
const result = parseSignature(
testCase.input.textRaw,
testCase.input.markdown
);

assert.equal(result.return.name, 'return');
assert.equal(result.return.type, 'string');
});
if (testCase.expected.return) {
assert.equal(result.return.name, testCase.expected.return.name);
assert.equal(result.return.type, testCase.expected.return.type);
}

it('parses method with parameters', () => {
const markdown = [{ name: 'param1' }, { name: 'param2' }];
const result = parseSignature('`method(param1, param2)`', markdown);
assert.equal(result.params.length, testCase.expected.params.length);

assert.equal(result.params.length, 2);
});
for (let i = 0; i < result.params.length; i++) {
for (const key in testCase.expected.params[i]) {
assert.deepEqual(
result.params[i][key],
testCase.expected.params[i][key],
`Param ${i} property ${key} mismatch`
);
}
}
});
}
});
9 changes: 5 additions & 4 deletions src/generators/legacy-json/utils/parseSignature.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -39,16 +39,17 @@ export function parseNameAndOptionalStatus(parameterName, optionalDepth) {
char => !OPTIONAL_LEVEL_CHANGES[char]
);

// Extract the actual parameter name
const actualName = parameterName.slice(startingIdx, endingIdx + 1);
const isParameterOptional = optionalDepth > 0;

// Update optionalDepth based on trailing brackets
// These apply to the NEXT parameter
optionalDepth = [...parameterName.slice(endingIdx + 1)].reduce(
updateDepth,
optionalDepth
);

// Extract the actual parameter name
const actualName = parameterName.slice(startingIdx, endingIdx + 1);
const isParameterOptional = optionalDepth > 0;

return [actualName, optionalDepth, isParameterOptional];
}

Expand Down
Loading