{"library":"react-docgen-typescript-webpack-plugin","title":"React Docgen TypeScript Webpack Plugin","description":"This Webpack plugin is designed to generate documentation generation (docgen) information specifically for TypeScript React components. It integrates with your Webpack configuration to parse component props and JSDoc comments, primarily intended for use with tools like Storybook's `addon-info` (though `addon-info` itself is now deprecated). The current stable version is 1.1.0. However, the project explicitly states it's experimental, a 'hack job,' and 'not suitable for production.' It has not seen updates since 2019, indicating an abandoned release cadence. Its key differentiator was providing TypeScript support for React docgen at a time when this was less common, but due to its unmaintained status and limitations, it's not recommended for new projects.","language":"javascript","status":"abandoned","last_verified":"Thu Apr 23","install":{"commands":["npm install react-docgen-typescript-webpack-plugin"],"cli":null},"imports":["import TSDocgenPlugin from 'react-docgen-typescript-webpack-plugin';"],"auth":{"required":false,"env_vars":[]},"quickstart":{"code":"const path = require('path');\nconst TSDocgenPlugin = require('react-docgen-typescript-webpack-plugin');\n\n// Assuming a Storybook context, this generates the default Webpack config\n// This path might need adjustment based on your Storybook version\nconst genDefaultConfig = require('@storybook/react/dist/server/config/defaults/webpack.config.js');\n\nmodule.exports = (baseConfig, env) => {\n  const config = genDefaultConfig(baseConfig);\n\n  config.module.rules.push({\n    test: /\\.tsx?$/,\n    include: path.resolve(__dirname, '../src'), // Adjust to your components directory\n    loader: require.resolve('ts-loader'),\n  });\n\n  config.plugins.push(new TSDocgenPlugin());\n\n  config.resolve.extensions.push('.ts', '.tsx');\n\n  return config;\n};\n","lang":"javascript","description":"This Webpack configuration snippet demonstrates how to integrate `react-docgen-typescript-webpack-plugin` into a Storybook setup, adding a TypeScript rule with `ts-loader` and instantiating the plugin to generate docgen information.","tag":null,"tag_description":null,"last_tested":null,"results":[]},"compatibility":null}