Skip to content

Replace react-docgen-typescript-plugin with Storybook's reactDocgen option #1594

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

Merged
merged 5 commits into from
Sep 8, 2023
Merged

Replace react-docgen-typescript-plugin with Storybook's reactDocgen option #1594

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
8a3b3ca
fix(storybook): use storybook native reactDocgen option
Dogdriip Sep 5, 2023
265e19d
chore(deps): remove @channel.io/react-docgen-typescript-plugin
Dogdriip Sep 5, 2023
c18187e
chore(storybook): add original comments
Dogdriip Sep 5, 2023
d325305
chore: add changeset
Dogdriip Sep 5, 2023
11a1305
Merge branch 'main' into fix/use-storybook-docgen-plugin
Dogdriip Sep 8, 2023
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
5 changes: 5 additions & 0 deletions .changeset/happy-tools-agree.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@channel.io/bezier-react": patch
---

Replace `@channel.io/react-docgen-typescript-plugin` with Storybook's `reactDocgen` option
28 changes: 8 additions & 20 deletions packages/bezier-react/.storybook/main.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
const ReactDocgenTypescriptPlugin = require('@channel.io/react-docgen-typescript-plugin').default
const TsconfigPathsPlugin = require('tsconfig-paths-webpack-plugin')

module.exports = {
Expand All @@ -23,13 +22,15 @@ module.exports = {
typescript: {
/**
* @note
*
* default `typescript.reactDocgen` option is to use `react-docgen-typescript-plugin`,
* which is not compatible with TS <= 4.3
*
* so we need to disable and override it with our own plugin (@channel-io/react-docgen-typescript-plugin).
*
* `react-docgen-typescript-plugin` introduces significant overhead
* when HMR is enabled, so we enable it only in production.
*/
reactDocgen: false,
reactDocgen: process.env.NODE_ENV === 'production' && 'react-docgen-typescript',
reactDocgenTypescriptOptions: {
shouldExtractLiteralValuesFromEnum: true,
propFilter: (prop) => (prop.parent ? !/node_modules/.test(prop.parent.fileName) : true),
},
},
webpackFinal: async (config) => {
// Apply tsconfig alias path
Expand All @@ -48,19 +49,6 @@ module.exports = {

config.resolve.extensions.push('.ts', '.tsx')

if (process.env.NODE_ENV === 'production') {
/**
* @note
*
* `react-docgen-typescript-plugin` introduces significant overhead
* when HMR is enabled, so we enable it only in production.
*/
config.plugins.push(new ReactDocgenTypescriptPlugin({
shouldExtractLiteralValuesFromEnum: true,
propFilter: (prop) => (prop.parent ? !/node_modules/.test(prop.parent.fileName) : true),
}))
}

return config
}
}
1 change: 0 additions & 1 deletion packages/bezier-react/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,6 @@
"@babel/preset-react": "^7.22.5",
"@babel/preset-typescript": "^7.22.5",
"@channel.io/bezier-icons": "^0.10.0",
"@channel.io/react-docgen-typescript-plugin": "^1.0.0",
"@mdx-js/react": "^1.6.22",
"@rollup/plugin-alias": "^5.0.0",
"@rollup/plugin-babel": "^6.0.3",
Expand Down
Loading