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

Leverage [template literal
types](https://www.typescriptlang.org/docs/handbook/2/template-literal-types.html).

Fixes https://github.com/microsoft/playwright/issues/32382
This commit is contained in:
Yury Semikhatsky 2024-08-29 14:16:49 -07:00 committed by GitHub
parent 0a40862bc8
commit 90e7b9ebac
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
3 changed files with 18 additions and 2 deletions

View file

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

View file

@ -147,6 +147,18 @@ 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': `

View file

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