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

feat(types): autocomplete for default devices (#2198)

Browse source 
* feat(types): autocomplete for default devices

* don't export the extra Device type

Co-authored-by: Joel Einbinder <joel.einbinde@gmail.com>
This commit is contained in:
Joel Einbinder 2020-06-18 12:28:20 -07:00 committed by GitHub
parent b88fabab13
commit fb84e19b6f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 20 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
utils/generate_types/index.js
View file

@ -17,7 +17,7 @@
//@ts-check //@ts-check
const path = require('path'); const path = require('path');
const Source = require('../doclint/Source'); const Source = require('../doclint/Source');
const {chromium} = require('../..'); const {chromium, devices} = require('../..');
const Documentation = require('../doclint/check_public_api/Documentation'); const Documentation = require('../doclint/check_public_api/Documentation');
const PROJECT_DIR = path.join(__dirname, '..', '..'); const PROJECT_DIR = path.join(__dirname, '..', '..');
const fs = require('fs'); const fs = require('fs');
@ -70,6 +70,7 @@ ${overrides}
${classes.map(classDesc => classToString(classDesc)).join('\n')} ${classes.map(classDesc => classToString(classDesc)).join('\n')}
${objectDefinitionsToString()} ${objectDefinitionsToString()}
${generateDevicesTypes()}
`; `;
for (const [key, value] of Object.entries(exported)) for (const [key, value] of Object.entries(exported))
output = output.replace(new RegExp('\\b' + key + '\\b', 'g'), value); output = output.replace(new RegExp('\\b' + key + '\\b', 'g'), value);
@ -77,7 +78,7 @@ ${objectDefinitionsToString()}
})().catch(e => { })().catch(e => {
console.error(e); console.error(e);
process.exit(1); process.exit(1);
}) });
function objectDefinitionsToString() { function objectDefinitionsToString() {
let definition; let definition;
@ -405,3 +406,14 @@ function mergeClasses(mdClass, jsClass) {
member.templates = jsClass.members.get(member.name).templates; member.templates = jsClass.members.get(member.name).templates;
return mdClass; return mdClass;
} }
function generateDevicesTypes() {
const namedDevices =
Object.keys(devices)
.map(name => ` ${JSON.stringify(name)}: DeviceDescriptor;`)
.join('\n');
return `type Devices = {
${namedDevices}
[key: string]: DeviceDescriptor;
}`;
}

2
utils/generate_types/overrides.d.ts vendored
View file

@ -177,7 +177,7 @@ class TimeoutError extends Error {}
} }
export const selectors: Selectors; export const selectors: Selectors;
export const devices: {[name: string]: DeviceDescriptor} & DeviceDescriptor[]; export const devices: Devices & DeviceDescriptor[];
// This is required to not export everything by default. See https://github.com/Microsoft/TypeScript/issues/19545#issuecomment-340490459 // This is required to not export everything by default. See https://github.com/Microsoft/TypeScript/issues/19545#issuecomment-340490459
export {}; export {};

6
utils/generate_types/test/test.ts
View file

@ -715,7 +715,11 @@ playwright.chromium.launch().then(async browser => {
playwright.chromium.connect; playwright.chromium.connect;
playwright.errors.TimeoutError; playwright.errors.TimeoutError;
{ {
const iPhone = playwright.devices['iPhone']; playwright.devices['my device'] = {
userAgent: 'foo',
viewport: {height: 123, width: 456}
};
const iPhone = playwright.devices['iPhone 11'];
const assertion: AssertType<string, typeof iPhone.userAgent> = true; const assertion: AssertType<string, typeof iPhone.userAgent> = true;
const numberAssertion: AssertType<number, typeof iPhone.viewport.width> = true; const numberAssertion: AssertType<number, typeof iPhone.viewport.width> = true;
} }