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

Merge branch 'next' into docs_toc_snapshot_testing_add

Browse Source
This commit is contained in:
jonniebigodes 2023-11-30 15:08:24 +00:00 committed by GitHub
commit 8e285b5ff4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 28 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
code/presets/react-webpack/src/framework-preset-react-docs.test.ts
View File

@ -43,9 +43,9 @@ describe('framework-preset-react-docgen', () => {
module: {
rules: [
{
exclude: /node_modules/,
exclude: /(\.(stories|story)\.(js|jsx|ts|tsx))|(node_modules)/,
loader: '@storybook/preset-react-webpack/dist/loaders/react-docgen-loader',
options: { babelOptions: { plugins: [], presets: [] } },
options: { babelOptions: { plugins: [], presets: [] }, debug: false },
test: /\.(cjs|mjs|tsx?|jsx?)$/,
},
],
@ -88,9 +88,9 @@ describe('framework-preset-react-docgen', () => {
module: {
rules: [
{
exclude: /node_modules/,
exclude: /(\.(stories|story)\.(js|jsx|ts|tsx))|(node_modules)/,
loader: '@storybook/preset-react-webpack/dist/loaders/react-docgen-loader',
options: { babelOptions: { plugins: [], presets: [] } },
options: { babelOptions: { plugins: [], presets: [] }, debug: false },
test: /\.(cjs|mjs|jsx?)$/,
},
],

7
code/presets/react-webpack/src/framework-preset-react-docs.ts
View File

@ -11,6 +11,7 @@ export const webpackFinal: StorybookConfig['webpackFinal'] = async (
if (!hasDocsOrControls(options)) return config;
const typescriptOptions = await options.presets.apply('typescript', {} as any);
const debug = options.loglevel === 'debug';
const { reactDocgen, reactDocgenTypescriptOptions } = typescriptOptions || {};
@ -34,8 +35,9 @@ export const webpackFinal: StorybookConfig['webpackFinal'] = async (
),
options: {
babelOptions,
debug,
},
exclude: /node_modules/,
exclude: /(\.(stories|story)\.(js|jsx|ts|tsx))|(node_modules)/,
},
],
},
@ -60,8 +62,9 @@ export const webpackFinal: StorybookConfig['webpackFinal'] = async (
),
options: {
babelOptions,
debug,
},
exclude: /node_modules/,
exclude: /(\.(stories|story)\.(js|jsx|ts|tsx))|(node_modules)/,
},
],
},

22
code/presets/react-webpack/src/loaders/react-docgen-loader.ts
View File

@ -9,6 +9,8 @@ import {
import MagicString from 'magic-string';
import type { LoaderContext } from 'webpack';
import type { Handler, NodePath, babelTypes as t, Documentation } from 'react-docgen';
import { logger } from '@storybook/node-logger';
import type { TransformOptions } from '@babel/core';
const { getNameOrValue, isReactForwardRefCall } = utils;
@ -56,11 +58,14 @@ const defaultResolver = new docgenResolver.FindExportedDefinitionsResolver();
const defaultImporter = docgenImporters.fsImporter;
const handlers = [...defaultHandlers, actualNameHandler];
export default async function reactDocgenLoader(this: LoaderContext<any>, source: string) {
export default async function reactDocgenLoader(
this: LoaderContext<{ babelOptions: TransformOptions; debug: boolean }>,
source: string
) {
const callback = this.async();
// get options
const options = this.getOptions() || {};
const { babelOptions = {} } = options;
const { babelOptions = {}, debug = false } = options;
const { plugins, presets } = babelOptions;
@ -94,7 +99,18 @@ export default async function reactDocgenLoader(this: LoaderContext<any>, source
if (error.code === ERROR_CODES.MISSING_DEFINITION) {
callback(null, source);
} else {
callback(error);
if (!debug) {
logger.warn(
`Failed to parse ${this.resourcePath} with react-docgen. Rerun Storybook with --loglevel=debug to get more info.`
);
} else {
logger.warn(
`Failed to parse ${this.resourcePath} with react-docgen. Please use the below error message and the content of the file which causes the error to report the issue to the maintainers of react-docgen. https://github.com/reactjs/react-docgen`
);
logger.error(error);
}
callback(null, source);
}
}
}