Add globalSetup and globalTeardown to playwright plugin (closes #1202)

Author: webpro

packages/knip/src/plugins/playwright/index.ts

@@ -1,5 +1,6 @@
 import type { IsPluginEnabled, Plugin, ResolveConfig } from '../../types/config.js';
-import { toDeferResolve, toEntry } from '../../util/input.js';
+import { arrayify } from '../../util/array.js';
+import { type Input, toDeferResolve, toEntry } from '../../util/input.js';
 import { join, relative } from '../../util/path.js';
 import { hasDependency } from '../../util/plugin.js';
 import type { PlaywrightTestConfig } from './types.js';
@@ -33,15 +34,23 @@ const builtinReporters = ['dot', 'line', 'list', 'junit', 'html', 'blob', 'json'
 
 export const resolveConfig: ResolveConfig<PlaywrightTestConfig> = async (localConfig, options) => {
   const { cwd, configFileDir } = options;
+
+  const inputs: Input[] = [];
+  for (const id of arrayify(localConfig.globalSetup)) inputs.push(toEntry(id));
+  for (const id of arrayify(localConfig.globalTeardown)) inputs.push(toEntry(id));
+
   const projects = localConfig.projects ? [localConfig, ...localConfig.projects] : [localConfig];
+
   const reporters = [localConfig.reporter].flat().flatMap(reporter => {
     const name = typeof reporter === 'string' ? reporter : reporter?.[0];
     if (!name || builtinReporters.includes(name)) return [];
     return [name];
   });
+
   return projects
     .flatMap(config => toEntryPatterns(config.testMatch ?? entry, cwd, configFileDir, config, localConfig))
-    .concat(reporters.map(id => toDeferResolve(id)));
+    .concat(reporters.map(id => toDeferResolve(id)))
+    .concat(inputs);
 };
 
 const args = {

packages/knip/src/plugins/playwright/types.ts

@@ -2,29 +2,38 @@
 
 type LiteralUnion<T extends U, U = string> = T | (U & { zz_IGNORE_ME?: never });
 
+type BlobReporterOptions = { outputDir?: string; fileName?: string };
+type ListReporterOptions = { printSteps?: boolean };
+type JUnitReporterOptions = {
+  outputFile?: string;
+  stripANSIControlSequences?: boolean;
+  includeProjectInTestName?: boolean;
+};
+type JsonReporterOptions = { outputFile?: string };
+type HtmlReporterOptions = {
+  outputFolder?: string;
+  open?: 'always' | 'never' | 'on-failure';
+  host?: string;
+  port?: number;
+  attachmentsBaseURL?: string;
+  title?: string;
+  noSnippets?: boolean;
+};
+
 type ReporterDescription = Readonly<
   | ['blob']
-  | ['blob', { outputDir?: string; fileName?: string }]
+  | ['blob', BlobReporterOptions]
   | ['dot']
   | ['line']
   | ['list']
-  | ['list', { printSteps?: boolean }]
+  | ['list', ListReporterOptions]
   | ['github']
   | ['junit']
-  | ['junit', { outputFile?: string; stripANSIControlSequences?: boolean; includeProjectInTestName?: boolean }]
+  | ['junit', JUnitReporterOptions]
   | ['json']
-  | ['json', { outputFile?: string }]
+  | ['json', JsonReporterOptions]
   | ['html']
-  | [
-      'html',
-      {
-        outputFolder?: string;
-        open?: 'always' | 'never' | 'on-failure';
-        host?: string;
-        port?: number;
-        attachmentsBaseURL?: string;
-      },
-    ]
+  | ['html', HtmlReporterOptions]
   | ['null']
   | [string]
   | [string, any]
@@ -43,4 +52,6 @@ export type PlaywrightTestConfig = {
   reporter?:
     | LiteralUnion<'dot' | 'line' | 'list' | 'junit' | 'html' | 'json' | 'github' | 'null', string>
     | ReporterDescription[];
+  globalSetup?: string | Array<string>;
+  globalTeardown?: string | Array<string>;
 };