feat: improve shared types

storybookjs · May 20, 2020 · ee085e5 · shilman · Nov 1, 2020 · arcanis
1 parent 3f4d4ef
commit ee085e5
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 4 deletions.
diff --git a/examples/official-storybook/main.js → examples/official-storybook/main.ts b/examples/official-storybook/main.js → examples/official-storybook/main.ts
@@ -1,3 +1,5 @@
+import type { StorybookConfig } from '@storybook/core/types';
+
 module.exports = {
   stories: [
     // FIXME: Breaks e2e tests './intro.stories.mdx',
@@ -74,4 +76,4 @@ module.exports = {
       extensions: [...(config.resolve.extensions || []), '.ts', '.tsx'],
     },
   }),
-};
+} as StorybookConfig;
diff --git a/lib/core/types/index.ts b/lib/core/types/index.ts
@@ -1,16 +1,17 @@
 import type ForkTsCheckerWebpackPlugin from 'fork-ts-checker-webpack-plugin';
 import type LoaderOptions from 'react-docgen-typescript-loader/dist/LoaderOptions';
+import { Configuration } from 'webpack';
 
 /**
- * The interface for Storybook configuration in `main.js` files.
+ * The interface for Storybook configuration in `main.ts` files.
  */
 export interface StorybookConfig {
   /**
    * Sets the addons you want to use with Storybook.
    *
    * @example `['@storybook/addon-essentials']`
    */
-  addons: string[];
+  addons?: string[];
   /**
    * Tells Storybook where to find stories.
    *
@@ -21,12 +22,20 @@ export interface StorybookConfig {
    * Controls how Storybook hanldes TypeScript files.
    */
   typescript?: Partial<TypescriptOptions>;
+  /**
+   * Modify or return a custom Webpack config.
+   */
+  webpackFinal?: (
+    config: Configuration,
+    options: StorybookOptions
+  ) => Configuration | Promise<Configuration>;
 }
 
 /**
  * The internal options object, used by Storybook frameworks and adddons.
  */
 export interface StorybookOptions {
+  configType: 'DEVELOPMENT' | 'PRODUCTION';
   typescriptOptions: TypescriptOptions;
 }
 
@@ -42,8 +51,11 @@ export interface TypescriptOptions {
   check: boolean;
   /**
    * Configures `fork-ts-checker-webpack-plugin`
+   *
+   * @default
+   * @see https://github.com/storybookjs/storybook/blob/next/lib/core/src/server/config/defaults.js#L4-L6
    */
-  checkOptions?: ForkTsCheckerWebpackPlugin['options'];
+  checkOptions: ForkTsCheckerWebpackPlugin['options'];
   /**
    * Sets the type of Docgen when working with React and TypeScript
    *