Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

React: Load root tsconfig.json into docgen-typescript if none provided #11184

Merged
merged 2 commits into from
Jun 17, 2020
Merged

React: Load root tsconfig.json into docgen-typescript if none provided #11184

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1105963
load root tsconfig.json into docgen-typescript
hipstersmoothie Jun 16, 2020
482a5a8
update plugin
hipstersmoothie Jun 16, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion app/react/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@
"lodash": "^4.17.15",
"prop-types": "^15.7.2",
"react-dev-utils": "^10.0.0",
"react-docgen-typescript-plugin": "^0.4.0",
"react-docgen-typescript-plugin": "^0.5.0",
"regenerator-runtime": "^0.13.3",
"ts-dedent": "^1.1.1",
"webpack": "^4.43.0"
Expand Down
13 changes: 1 addition & 12 deletions app/react/src/server/framework-preset-react-docgen.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
import fs from 'fs';
import type { TransformOptions } from '@babel/core';
import type { Configuration } from 'webpack';
import type { StorybookOptions } from '@storybook/core/types';
Expand Down Expand Up @@ -29,23 +28,13 @@ export function babel(config: TransformOptions, { typescriptOptions }: Storybook
};
}

const tsconfigPath = './tsconfig.json';

export function webpackFinal(config: Configuration, { typescriptOptions }: StorybookOptions) {
const { reactDocgen, reactDocgenTypescriptOptions = {} } = typescriptOptions;
const { reactDocgen, reactDocgenTypescriptOptions } = typescriptOptions;

if (reactDocgen !== 'react-docgen-typescript') {
return config;
}

if (
!reactDocgenTypescriptOptions.tsconfigPath &&
!reactDocgenTypescriptOptions.compilerOptions &&
fs.existsSync(tsconfigPath)
) {
reactDocgenTypescriptOptions.tsconfigPath = tsconfigPath;
}

return {
...config,
plugins: [...config.plugins, new ReactDocgenTypescriptPlugin(reactDocgenTypescriptOptions)],
Expand Down
2 changes: 1 addition & 1 deletion examples/cra-ts-kitchen-sink/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@
"enzyme-adapter-react-16": "^1.9.1",
"enzyme-to-json": "^3.4.1",
"fork-ts-checker-webpack-plugin": "^4.0.3",
"react-docgen-typescript-plugin": "^0.4.0",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we need this dep at all? i made RDTP a hard dep in the CRA preset because it was breaking with SB 5.3 instances.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

And it's already a dep in @storybook/react

"react-docgen-typescript-plugin": "^0.5.0",
"react-moment-proptypes": "^1.7.0",
"ts-node": "~8.9.1"
},
Expand Down
8 changes: 4 additions & 4 deletions yarn.lock
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26565,10 +26565,10 @@ react-docgen-typescript-loader@^3.7.2:
loader-utils "^1.2.3"
react-docgen-typescript "^1.15.0"

react-docgen-typescript-plugin@^0.4.0:
version "0.4.0"
resolved "https://registry.yarnpkg.com/react-docgen-typescript-plugin/-/react-docgen-typescript-plugin-0.4.0.tgz#79416e040a7e2c8ece49ded538b6e6661462d46a"
integrity sha512-04zRzxpx5BOC0i8QKBH8lNDMuSxZQHH7OVvXwfShaVNd482MnNlf2+MjN6I3vYUhd0X85i3r2KFRFeMS7fOpCA==
react-docgen-typescript-plugin@^0.5.0:
version "0.5.0"
resolved "https://registry.yarnpkg.com/react-docgen-typescript-plugin/-/react-docgen-typescript-plugin-0.5.0.tgz#704733d99be7d41c64ee651240212d7fd6f8edc5"
integrity sha512-7bTj/or5u4UZls7x07MwEFj6Ak9icHwMLSs2mUL5QZON51gDdGCTbbmSR0nKsPISYP+iNqtbsRnlsbvjcM06nw==
dependencies:
debug "^4.1.1"
endent "^2.0.1"
Expand Down