refactor: extract plugin setup types to models

Author: hanna-skryl

packages/create-cli/src/lib/setup/types.ts

@@ -1,6 +1,13 @@
-import type { CategoryConfig, PluginMeta } from '@code-pushup/models';
+import type { PluginCodegenResult } from '@code-pushup/models';
 import type { MonorepoTool } from '@code-pushup/utils';
 
+export type {
+  ImportDeclarationStructure,
+  PluginCodegenResult,
+  PluginPromptDescriptor,
+  PluginSetupBinding,
+} from '@code-pushup/models';
+
 export const CI_PROVIDERS = ['github', 'gitlab', 'none'] as const;
 export type CiProvider = (typeof CI_PROVIDERS)[number];
 
@@ -24,50 +31,6 @@ export type CliArgs = {
   [key: string]: unknown;
 };
 
-type PromptBase = {
-  key: string;
-  message: string;
-};
-
-type PromptChoice<T extends string> = { name: string; value: T };
-
-type InputPrompt = PromptBase & {
-  type: 'input';
-  default: string;
-};
-
-type SelectPrompt<T extends string = string> = PromptBase & {
-  type: 'select';
-  choices: PromptChoice<T>[];
-  default: T;
-};
-
-type CheckboxPrompt<T extends string = string> = PromptBase & {
-  type: 'checkbox';
-  choices: PromptChoice<T>[];
-  default: T[];
-};
-
-/** Declarative prompt definition used to collect plugin-specific options. */
-export type PluginPromptDescriptor =
-  | InputPrompt
-  | SelectPrompt
-  | CheckboxPrompt;
-
-export type ImportDeclarationStructure = {
-  moduleSpecifier: string;
-  defaultImport?: string;
-  namedImports?: string[];
-  isTypeOnly?: boolean;
-};
-
-/** Import declarations and plugin initialization code produced by `generateConfig`. */
-export type PluginCodegenResult = {
-  imports: ImportDeclarationStructure[];
-  pluginInit: string;
-  categories?: CategoryConfig[];
-};
-
 export type ScopedPluginResult = {
   scope: PluginScope;
   result: PluginCodegenResult;
@@ -79,27 +42,6 @@ export type ConfigContext = {
   tool: MonorepoTool | null;
 };
 
-/**
- * Defines how a plugin integrates with the setup wizard.
- *
- * Each supported plugin provides a binding that controls:
- * - Pre-selection: `isRecommended` detects if the plugin is relevant for the repository
- * - Configuration: `prompts` collect plugin-specific options interactively
- * - Code generation: `generateConfig` produces the import and initialization code
- */
-export type PluginSetupBinding = {
-  slug: PluginMeta['slug'];
-  title: PluginMeta['title'];
-  packageName: NonNullable<PluginMeta['packageName']>;
-  prompts?: PluginPromptDescriptor[];
-  scope?: PluginScope;
-  isRecommended?: (targetDir: string) => Promise<boolean>;
-  generateConfig: (
-    answers: Record<string, string | string[]>,
-    context: ConfigContext,
-  ) => PluginCodegenResult;
-};
-
 /** A project discovered in a monorepo workspace. */
 export type WizardProject = {
   name: string;

packages/models/src/index.ts

@@ -112,6 +112,12 @@ export {
   type PluginScoreTargets,
   type PluginUrls,
 } from './lib/plugin-config.js';
+export type {
+  ImportDeclarationStructure,
+  PluginCodegenResult,
+  PluginPromptDescriptor,
+  PluginSetupBinding,
+} from './lib/plugin-setup.js';
 export {
   auditReportSchema,
   pluginReportSchema,

packages/models/src/lib/plugin-setup.ts

@@ -0,0 +1,66 @@
+import type { CategoryConfig } from './category-config.js';
+import type { PluginMeta } from './plugin-config.js';
+
+type PromptBase = {
+  key: string;
+  message: string;
+};
+
+type PromptChoice<T extends string> = { name: string; value: T };
+
+type InputPrompt = PromptBase & {
+  type: 'input';
+  default: string;
+};
+
+type SelectPrompt<T extends string = string> = PromptBase & {
+  type: 'select';
+  choices: PromptChoice<T>[];
+  default: T;
+};
+
+type CheckboxPrompt<T extends string = string> = PromptBase & {
+  type: 'checkbox';
+  choices: PromptChoice<T>[];
+  default: T[];
+};
+
+/** Declarative prompt definition used to collect plugin-specific options. */
+export type PluginPromptDescriptor =
+  | InputPrompt
+  | SelectPrompt
+  | CheckboxPrompt;
+
+export type ImportDeclarationStructure = {
+  moduleSpecifier: string;
+  defaultImport?: string;
+  namedImports?: string[];
+  isTypeOnly?: boolean;
+};
+
+/** Import declarations and plugin initialization code produced by `generateConfig`. */
+export type PluginCodegenResult = {
+  imports: ImportDeclarationStructure[];
+  pluginInit: string;
+  categories?: CategoryConfig[];
+};
+
+/**
+ * Defines how a plugin integrates with the setup wizard.
+ *
+ * Each supported plugin provides a binding that controls:
+ * - Pre-selection: `isRecommended` detects if the plugin is relevant for the repository
+ * - Configuration: `prompts` collect plugin-specific options interactively
+ * - Code generation: `generateConfig` produces the import and initialization code
+ */
+export type PluginSetupBinding = {
+  slug: PluginMeta['slug'];
+  title: PluginMeta['title'];
+  packageName: NonNullable<PluginMeta['packageName']>;
+  scope?: 'project' | 'root';
+  prompts?: (targetDir: string) => Promise<PluginPromptDescriptor[]>;
+  isRecommended?: (targetDir: string) => Promise<boolean>;
+  generateConfig: (
+    answers: Record<string, string | string[]>,
+  ) => PluginCodegenResult;
+};