Merge pull request #18377 from AriPerkkio/fix/builder-stats-typings

Core: Fix builder stats typings to be optional
storybookjs · Jul 6, 2022 · a5762c9 · a5762c9
2 parents 1935e3f + b49b835
commit a5762c9
Show file tree

Hide file tree

Showing 4 changed files with 5 additions and 7 deletions.
diff --git a/docs/snippets/common/storybook-builder-api-interface.ts.mdx b/docs/snippets/common/storybook-builder-api-interface.ts.mdx
@@ -6,7 +6,7 @@ export interface Builder<Config, Stats> {
     router: Router;
     server: Server;
   }) => Promise<void | {
-    stats: Stats;
+    stats?: Stats;
     totalTime: ReturnType<typeof process.hrtime>;
     bail: (e?: Error) => Promise<void>;
   }>;

diff --git a/lib/core-common/src/types.ts b/lib/core-common/src/types.ts
@@ -186,22 +186,22 @@ export interface StorybookConfigOptions {
 
 export type Options = LoadOptions & StorybookConfigOptions & CLIOptions & BuilderOptions;
 
-export interface Builder<Config, Stats> {
+export interface Builder<Config, BuilderStats extends Stats = Stats> {
   getConfig: (options: Options) => Promise<Config>;
   start: (args: {
     options: Options;
     startTime: ReturnType<typeof process.hrtime>;
     router: Router;
     server: Server;
   }) => Promise<void | {
-    stats: Stats;
+    stats?: BuilderStats;
     totalTime: ReturnType<typeof process.hrtime>;
     bail: (e?: Error) => Promise<void>;
   }>;
   build: (arg: {
     options: Options;
     startTime: ReturnType<typeof process.hrtime>;
-  }) => Promise<void | Stats>;
+  }) => Promise<void | BuilderStats>;
   bail: (e?: Error) => Promise<void>;
   corePresets?: string[];
   overridePresets?: string[];

diff --git a/lib/core-server/src/build-dev.ts b/lib/core-server/src/build-dev.ts
@@ -118,9 +118,7 @@ export async function buildDevStandalone(options: CLIOptions & LoadOptions & Bui
 
   if (options.smokeTest) {
     const warnings: Error[] = [];
-    // @ts-ignore
     warnings.push(...((managerStats && managerStats.toJson().warnings) || []));
-    // @ts-ignore
     warnings.push(...((managerStats && previewStats.toJson().warnings) || []));
 
     const problems = warnings

diff --git a/lib/core-server/src/utils/get-builders.ts b/lib/core-server/src/utils/get-builders.ts
@@ -21,7 +21,7 @@ async function getPreviewBuilder(builderName: string, configDir: string) {
 export async function getBuilders({
   presets,
   configDir,
-}: Options): Promise<Builder<unknown, unknown>[]> {
+}: Options): Promise<Builder<unknown>[]> {
   const core = await presets.apply<CoreConfig>('core', undefined);
   const builderName = typeof core?.builder === 'string' ? core.builder : core?.builder?.name;