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

chore: move implementation of Config and Project to TestConfig and TestProject (#30212)

Browse source 
Reference https://github.com/microsoft/playwright/issues/29768
This commit is contained in:
Yury Semikhatsky 2024-04-03 10:47:32 -07:00 committed by GitHub
parent 43745210a5
commit 5c5f0d77e4
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
3 changed files with 553 additions and 637 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1134
packages/playwright/types/test.d.ts vendored
View file

File diff suppressed because it is too large Load diff

43
utils/generate_types/index.js
View file

@ -493,7 +493,14 @@ class TypesGenerator {
const coreDocumentation = parseApi(path.join(PROJECT_DIR, 'docs', 'src', 'api'));
const testDocumentation = parseApi(path.join(PROJECT_DIR, 'docs', 'src', 'test-api'), path.join(PROJECT_DIR, 'docs', 'src', 'api', 'params.md'));
const reporterDocumentation = parseApi(path.join(PROJECT_DIR, 'docs', 'src', 'test-reporter-api'));
const assertionClasses = new Set(['GenericAssertions', 'LocatorAssertions', 'PageAssertions', 'APIResponseAssertions', 'SnapshotAssertions', 'PlaywrightAssertions']);
const assertionClasses = new Set([
'APIResponseAssertions',
'GenericAssertions',
'LocatorAssertions',
'PageAssertions',
'PlaywrightAssertions',
'SnapshotAssertions',
]);
/**
* @param {boolean} includeExperimental
@ -503,7 +510,7 @@ class TypesGenerator {
const documentation = coreDocumentation.clone();
const generator = new TypesGenerator({
documentation,
doNotGenerate: new Set([...assertionClasses]),
doNotGenerate: assertionClasses,
includeExperimental,
});
let types = await generator.generateTypes(path.join(__dirname, 'overrides.d.ts'));
@ -536,12 +543,7 @@ class TypesGenerator {
documentation,
doNotGenerate: new Set([
...coreDocumentation.classesArray.map(cls => cls.name).filter(name => !assertionClasses.has(name)),
'PlaywrightAssertions',
'Test',
'Fixtures',
'TestOptions',
'TestConfig.use',
'TestProject.use',
'GenericAssertions.any',
'GenericAssertions.anything',
'GenericAssertions.arrayContaining',
@ -549,26 +551,29 @@ class TypesGenerator {
'GenericAssertions.objectContaining',
'GenericAssertions.stringContaining',
'GenericAssertions.stringMatching',
'PlaywrightAssertions',
'Test',
'TestOptions',
]),
overridesToDocsClassMapping: new Map([
['TestType', 'Test'],
['Config', 'TestConfig'],
['Project', 'TestProject'],
['PlaywrightWorkerOptions', 'TestOptions'],
['AsymmetricMatchers', 'GenericAssertions'],
['PlaywrightTestArgs', 'Fixtures'],
['PlaywrightTestOptions', 'TestOptions'],
['PlaywrightWorkerArgs', 'Fixtures'],
['PlaywrightTestArgs', 'Fixtures'],
['AsymmetricMatchers', 'GenericAssertions'],
['PlaywrightWorkerOptions', 'TestOptions'],
['TestType', 'Test'],
]),
ignoreMissing: new Set([
'Config',
'ExpectMatcherUtils',
'Matchers',
'PlaywrightWorkerArgs.playwright',
'PlaywrightWorkerOptions.defaultBrowserType',
'Project',
'SuiteFunction',
'TestFunction',
'PlaywrightWorkerOptions.defaultBrowserType',
'PlaywrightWorkerArgs.playwright',
'Matchers',
'ExpectMatcherUtils',
]),
doNotExportClassNames: new Set([...assertionClasses, 'TestProject']),
doNotExportClassNames: assertionClasses,
includeExperimental,
});
return await generator.generateTypes(path.join(__dirname, 'overrides-test.d.ts'));
@ -590,8 +595,8 @@ class TypesGenerator {
'FullResult',
'JSONReport',
'JSONReportError',
'JSONReportSuite',
'JSONReportSpec',
'JSONReportSuite',
'JSONReportTest',
'JSONReportTestResult',
'JSONReportTestStep',

13
utils/generate_types/overrides-test.d.ts vendored
View file

@ -31,24 +31,27 @@ export type ReporterDescription =
type UseOptions<TestArgs, WorkerArgs> = Partial<WorkerArgs> & Partial<TestArgs>;
export interface Project<TestArgs = {}, WorkerArgs = {}> extends TestProject {
interface TestProject<TestArgs = {}, WorkerArgs = {}> {
use?: UseOptions<TestArgs, WorkerArgs>;
}
export interface Project<TestArgs = {}, WorkerArgs = {}> extends TestProject<TestArgs, WorkerArgs> {
}
export interface ProjectInWorker<TestArgs = {}, WorkerArgs = {}> {
use: UseOptions<PlaywrightTestOptions & TestArgs, PlaywrightWorkerOptions & WorkerArgs>;
}
type LiteralUnion<T extends U, U = string> = T | (U & { zz_IGNORE_ME?: never });
interface TestConfig {
interface TestConfig<TestArgs = {}, WorkerArgs = {}> {
projects?: Project<TestArgs, WorkerArgs>[];
reporter?: LiteralUnion<'list'|'dot'|'line'|'github'|'json'|'junit'|'null'|'html', string> | ReporterDescription[];
use?: UseOptions<TestArgs, WorkerArgs>;
webServer?: TestConfigWebServer | TestConfigWebServer[];
}
export interface Config<TestArgs = {}, WorkerArgs = {}> extends TestConfig {
projects?: Project<TestArgs, WorkerArgs>[];
use?: UseOptions<TestArgs, WorkerArgs>;
export interface Config<TestArgs = {}, WorkerArgs = {}> extends TestConfig<TestArgs, WorkerArgs> {
}
export type Metadata = { [key: string]: any };