Merge pull request #12492 from AndrewLeedham/next

React: Fix reactDocgen option when false
storybookjs · Sep 16, 2020 · cb87bc1 · cb87bc1
2 parents 9a2ed57 + 3ab18b5
commit cb87bc1
Show file tree

Hide file tree

Showing 3 changed files with 54 additions and 7 deletions.
diff --git a/app/react/src/server/framework-preset-react-docgen.test.ts b/app/react/src/server/framework-preset-react-docgen.test.ts
@@ -1,9 +1,10 @@
+import ReactDocgenTypescriptPlugin from 'react-docgen-typescript-plugin';
 import * as preset from './framework-preset-react-docgen';
 
 describe('framework-preset-react-docgen', () => {
   const babelPluginReactDocgenPath = require.resolve('babel-plugin-react-docgen');
 
-  it('should return the config with the extra plugin', () => {
+  it('should return the babel config with the extra plugin', () => {
     const babelConfig = {
       babelrc: false,
       presets: ['env', 'foo-preset'],
@@ -33,4 +34,46 @@ describe('framework-preset-react-docgen', () => {
       ],
     });
   });
+
+  it('should return the webpack config with the extra plugin', () => {
+    const webpackConfig = {
+      plugins: [],
+    };
+
+    const config = preset.webpackFinal(webpackConfig, {
+      typescriptOptions: { check: false, reactDocgen: 'react-docgen-typescript' },
+    });
+
+    expect(config).toEqual({
+      plugins: [expect.any(ReactDocgenTypescriptPlugin)],
+    });
+  });
+
+  it('should not add any extra plugins', () => {
+    const babelConfig = {
+      babelrc: false,
+      presets: ['env', 'foo-preset'],
+      plugins: ['foo-plugin'],
+    };
+
+    const webpackConfig = {
+      plugins: [],
+    };
+
+    const outputBabelconfig = preset.babel(babelConfig, {
+      typescriptOptions: { check: false, reactDocgen: false },
+    });
+    const outputWebpackconfig = preset.webpackFinal(webpackConfig, {
+      typescriptOptions: { check: false, reactDocgen: false },
+    });
+
+    expect(outputBabelconfig).toEqual({
+      babelrc: false,
+      presets: ['env', 'foo-preset'],
+      plugins: ['foo-plugin'],
+    });
+    expect(outputWebpackconfig).toEqual({
+      plugins: [],
+    });
+  });
 });
diff --git a/app/react/src/server/framework-preset-react-docgen.ts b/app/react/src/server/framework-preset-react-docgen.ts
@@ -6,6 +6,10 @@ import ReactDocgenTypescriptPlugin from 'react-docgen-typescript-plugin';
 export function babel(config: TransformOptions, { typescriptOptions }: StorybookOptions) {
   const { reactDocgen } = typescriptOptions;
 
+  if (reactDocgen === false) {
+    return config;
+  }
+
   return {
     ...config,
     overrides: [

diff --git a/docs/configure/typescript.md b/docs/configure/typescript.md
@@ -30,9 +30,9 @@ The following code snippets shows the fields for you to use with TypeScript:
 
 <!-- prettier-ignore-end -->
 
-| Field                            | Framework | Description                                                                              | Type                                                                          |
-| :------------------------------- | :-------- | :--------------------------------------------------------------------------------------- | :---------------------------------------------------------------------------- |
-| **check**                        | All       | Optionally run fork-ts-checker-webpack-plugin                                            | boolean                                                                       |
-| **checkOptions**                 | All       | Options to pass to fork-ts-checker-webpack-plugin if it's enabled                        | [See docs](https://github.com/TypeStrong/fork-ts-checker-webpack-plugin)      |
-| **reactDocgen**                  | React     | Which react docgen processor to run: `react-docgen-typescript`, `react-docgen`, `none`   | string                                                                        |
-| **reactDocgenTypescriptOptions** | React     | Options to pass to react-docgen-typescript-plugin if react-docgen-typescript is enabled. | [See docs](https://github.com/hipstersmoothie/react-docgen-typescript-plugin) |
+| Field                            | Framework | Description                                                                                   | Type                                                                          |
+| :------------------------------- | :-------- | :-------------------------------------------------------------------------------------------- | :---------------------------------------------------------------------------- |
+| **check**                        | All       | Optionally run fork-ts-checker-webpack-plugin                                                 | boolean                                                                       |
+| **checkOptions**                 | All       | Options to pass to fork-ts-checker-webpack-plugin if it's enabled                             | [See docs](https://github.com/TypeStrong/fork-ts-checker-webpack-plugin)      |
+| **reactDocgen**                  | React     | Which react docgen processor to run: `"react-docgen-typescript"`, `"react-docgen"`, `false`   | string or false                                                               |
+| **reactDocgenTypescriptOptions** | React     | Options to pass to react-docgen-typescript-plugin if react-docgen-typescript is enabled.      | [See docs](https://github.com/hipstersmoothie/react-docgen-typescript-plugin) |