microsoft/playwright
1
1
Fork 0
mirror of https://github.com/microsoft/playwright.git synced 2024-11-28 09:23:42 +03:00
Code Issues Projects Releases Wiki Activity

Revert "chore: enforce tags format via typescript types (#32384)" (#32431)

Browse Source 
After API review we decided to revert it:
* VSCode extension and UI mode users already get the (runtime) error if
the tag is not prefixed
* The typescript error message is not very nice
* The type change would break those clients that generate tests with
tags passed as string

This reverts commit 90e7b9ebac.
This commit is contained in:
Yury Semikhatsky 2024-09-03 10:07:08 -07:00 committed by GitHub
parent 9f466a1ead
commit 565aed6c39
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 2 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
packages/playwright/types/test.d.ts vendored
View File

@ -1825,10 +1825,8 @@ type TestDetailsAnnotation = {
description?: string;
};
type TestDetailsTag = `@${string}`;
export type TestDetails = {
tag?: TestDetailsTag | TestDetailsTag[];
tag?: string | string[];
annotation?: TestDetailsAnnotation | TestDetailsAnnotation[];
}

12
tests/playwright-test/test-tag.spec.ts
View File

@ -147,18 +147,6 @@ test('should enforce @ symbol', async ({ runInlineTest }) => {
expect(result.output).toContain(`Error: Tag must start with "@" symbol, got "foo" instead.`);
});
test('types should enforce @ symbol', async ({ runTSC }) => {
const result = await runTSC({
'stdio.spec.ts': `
import { test, expect } from '@playwright/test';
test('test1', { tag: 'foo' }, () => {
});
`
});
expect(result.exitCode).toBe(2);
expect(result.output).toContain('error TS2322: Type \'"foo"\' is not assignable to type \'`@${string}` | `@${string}`[] | undefined');
});
test('should be included in testInfo', async ({ runInlineTest }, testInfo) => {
const result = await runInlineTest({
'a.test.ts': `

4
utils/generate_types/overrides-test.d.ts vendored
View File

@ -70,10 +70,8 @@ type TestDetailsAnnotation = {
description?: string;
};
type TestDetailsTag = `@${string}`;
export type TestDetails = {
tag?: TestDetailsTag | TestDetailsTag[];
tag?: string | string[];
annotation?: TestDetailsAnnotation | TestDetailsAnnotation[];
}