Filip/playwright
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

docs: do not yell at templated types in doc lint (#409)

Browse source
This commit is contained in:
Pavel Feldman 2020-01-07 14:19:58 -08:00 committed by Dmitry Gozman
parent f15abadc9e
commit e0693654b7
1 changed files with 6 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
utils/doclint/check_public_api/index.js
View file

@ -161,8 +161,11 @@ function compareDocumentations(actual, expected) {
const propertyDiff = diff(actualProperties, expectedProperties);
for (const propertyName of propertyDiff.extra)
errors.push(`Non-existing property found: ${className}.${propertyName}`);
for (const propertyName of propertyDiff.missing)
for (const propertyName of propertyDiff.missing) {
if (propertyName === 'T')
continue;
errors.push(`Property not found: ${className}.${propertyName}`);
}
const actualEvents = Array.from(actualClass.events.keys()).sort();
const expectedEvents = Array.from(expectedClass.events.keys()).sort();
@ -192,6 +195,8 @@ function compareDocumentations(actual, expected) {
// TODO(@JoelEinbinder): check functions and Serializable
if (actual.name.includes('unction') || actual.name.includes('Serializable'))
return;
if (expected.name === 'T' || expected.name.includes('[T]'))
return;
// We don't have nullchecks on for TypeScript
const actualName = actual.name.replace(/[\? ]/g, '').replace(/ElementHandle\<Node\>/g, 'ElementHandle');
// TypeScript likes to add some spaces