Skip to content

build: docs incorrectly outputting function parameters with object literal type #29471

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 23, 2024
Merged
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
76 changes: 44 additions & 32 deletions tools/dgeni/common/normalize-function-parameters.ts
Original file line number Diff line number Diff line change
Expand Up @@ -30,41 +30,53 @@ export type DefaultFunctionDoc = NormalizedFunctionParameters & ParameterContain
* an object.
*/
export function normalizeFunctionParameters(doc: DefaultFunctionDoc) {
if (doc.parameters) {
doc.parameters.forEach(parameter => {
let [parameterName, parameterType] = parameter.split(':');
if (!doc.parameters?.length) {
return;
}

// If the parameter is optional, the name here will contain a '?'. We store whether the
// parameter is optional and remove the '?' for comparison.
let isOptional = false;
if (parameterName.includes('?')) {
isOptional = true;
parameterName = parameterName.replace('?', '');
}
doc.parameters.forEach(parameter => {
const colonIndex = parameter.indexOf(':');
let parameterName: string;
let parameterType: string;

doc.params = doc.params || [];
if (colonIndex === -1) {
parameterName = parameter;
parameterType = '';
} else {
parameterName = parameter.slice(0, colonIndex);
parameterType = parameter.slice(colonIndex + 1).trim();
}

if (!parameterType) {
console.warn(
`Missing parameter type information (${parameterName}) in ` +
`${doc.fileInfo.relativePath}:${doc.startingLine}`,
);
return;
}
// If the parameter is optional, the name here will contain a '?'. We store whether the
// parameter is optional and remove the '?' for comparison.
let isOptional = false;
if (parameterName.includes('?')) {
isOptional = true;
parameterName = parameterName.replace('?', '');
}

const existingParameterInfo = doc.params.find(p => p.name == parameterName);
doc.params = doc.params || [];

if (!existingParameterInfo) {
doc.params.push({
name: parameterName,
type: parameterType.trim(),
isOptional: isOptional,
description: '',
});
} else {
existingParameterInfo.type = parameterType.trim();
existingParameterInfo.isOptional = isOptional;
}
});
}
if (!parameterType) {
console.warn(
`Missing parameter type information (${parameterName}) in ` +
`${doc.fileInfo.relativePath}:${doc.startingLine}`,
);
return;
}

const existingParameterInfo = doc.params.find(p => p.name == parameterName);

if (!existingParameterInfo) {
doc.params.push({
name: parameterName,
type: parameterType,
isOptional: isOptional,
description: '',
});
} else {
existingParameterInfo.type = parameterType;
existingParameterInfo.isOptional = isOptional;
}
});
}
Loading