GitHub/storybook
1
0
Fork 0
mirror of https://github.com/storybookjs/storybook.git synced 2025-03-19 05:02:40 +08:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #12492 from AndrewLeedham/next

Browse Source 
React: Fix reactDocgen option when false
This commit is contained in:
Michael Shilman 2020-09-16 08:52:57 +08:00 committed by GitHub
commit cb87bc19cc
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 54 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

45
app/react/src/server/framework-preset-react-docgen.test.ts
View File

@ -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: [],
});
});
});

4
app/react/src/server/framework-preset-react-docgen.ts
View File

@ -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: [

12
docs/configure/typescript.md
View File

@ -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) |