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

Jump to bottom

Addon-docs: Support story.mdx, stories.mdx #13996

Merged
merged 3 commits into from
Feb 22, 2021
Merged

Addon-docs: Support story.mdx, stories.mdx #13996

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5247988
Addon-docs: Support story.mdx, stories.mdx
shilman Feb 22, 2021
df5291e
Update snapshots
shilman Feb 22, 2021
483ca6b
Update MIGRATION.md
shilman Feb 22, 2021
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 MIGRATION.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
<h1>Migration</h1>

- [From version 6.1.x to 6.2.0](#from-version-61x-to-620)
- [MDX pattern tweaked](#mdx-pattern-tweaked)
- [6.2 Angular overhaul](#62-angular-overhaul)
- [New Angular storyshots format](#new-angular-storyshots-format)
- [Deprecated Angular story component](#deprecated-angular-story-component)
Expand Down Expand Up @@ -149,6 +150,10 @@

## From version 6.1.x to 6.2.0

### MDX pattern tweaked

In 6.2 files ending in `stories.mdx` or `story.mdx` are now processed with Storybook's MDX compiler. Previously it only applied to files ending in `.stories.mdx` or `.story.mdx`. See more here: [#13996](https://github.com/storybookjs/storybook/pull/13996)

### 6.2 Angular overhaul

#### New Angular storyshots format
Expand Down
4 changes: 2 additions & 2 deletions addons/docs/src/frameworks/common/preset.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ export function webpack(webpackConfig: any = {}, options: any = {}) {
],
},
{
test: /\.(stories|story)\.mdx$/,
test: /(stories|story)\.mdx$/,
use: [
{
loader: resolvedBabelLoader,
Expand All @@ -118,7 +118,7 @@ export function webpack(webpackConfig: any = {}, options: any = {}) {
},
{
test: /\.mdx$/,
exclude: /\.(stories|story)\.mdx$/,
exclude: /(stories|story)\.mdx$/,
use: [
{
loader: resolvedBabelLoader,
Expand Down
2 changes: 1 addition & 1 deletion examples/official-storybook/main.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ module.exports = {
// FIXME: Breaks e2e tests './intro.stories.mdx',
'../../lib/ui/src/**/*.stories.@(js|tsx|mdx)',
'../../lib/components/src/**/*.stories.@(js|tsx|mdx)',
'./stories/**/*.stories.@(js|ts|tsx|mdx)',
'./stories/**/*stories.@(js|ts|tsx|mdx)',
'./../../addons/docs/**/*.stories.tsx',
],
reactOptions: {
Expand Down
7 changes: 7 additions & 0 deletions examples/official-storybook/stories/addon-docs/stories.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
import { Meta } from '@storybook/addon-docs/blocks';

<Meta title="Addons/Docs/StoriesFile" />

# Stories

Addon-docs supports `story.mdx` and `stories.mdx` for people who group their components by folder, e.g. `Button/{index.tsx,stories.mdx}`.
4 changes: 2 additions & 2 deletions lib/core-server/src/__snapshots__/cra-ts-essentials_preview-dev
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -315,7 +315,7 @@ Object {
],
},
Object {
"test": "/\\\\.(stories|story)\\\\.mdx$/",
"test": "/(stories|story)\\\\.mdx$/",
"use": Array [
Object {
"loader": "NODE_MODULES/babel-loader/lib/index.js",
Expand Down Expand Up @@ -363,7 +363,7 @@ Object {
],
},
Object {
"exclude": "/\\\\.(stories|story)\\\\.mdx$/",
"exclude": "/(stories|story)\\\\.mdx$/",
"test": "/\\\\.mdx$/",
"use": Array [
Object {
Expand Down
4 changes: 2 additions & 2 deletions lib/core-server/src/__snapshots__/cra-ts-essentials_preview-prod
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -334,7 +334,7 @@ Object {
],
},
Object {
"test": "/\\\\.(stories|story)\\\\.mdx$/",
"test": "/(stories|story)\\\\.mdx$/",
"use": Array [
Object {
"loader": "NODE_MODULES/babel-loader/lib/index.js",
Expand Down Expand Up @@ -382,7 +382,7 @@ Object {
],
},
Object {
"exclude": "/\\\\.(stories|story)\\\\.mdx$/",
"exclude": "/(stories|story)\\\\.mdx$/",
"test": "/\\\\.mdx$/",
"use": Array [
Object {
Expand Down
4 changes: 2 additions & 2 deletions lib/core-server/src/__snapshots__/html-kitchen-sink_preview-dev
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -213,7 +213,7 @@ Object {
],
},
Object {
"test": "/\\\\.(stories|story)\\\\.mdx$/",
"test": "/(stories|story)\\\\.mdx$/",
"use": Array [
Object {
"loader": "NODE_MODULES/babel-loader/lib/index.js",
Expand Down Expand Up @@ -303,7 +303,7 @@ Object {
],
},
Object {
"exclude": "/\\\\.(stories|story)\\\\.mdx$/",
"exclude": "/(stories|story)\\\\.mdx$/",
"test": "/\\\\.mdx$/",
"use": Array [
Object {
Expand Down
4 changes: 2 additions & 2 deletions lib/core-server/src/__snapshots__/html-kitchen-sink_preview-prod
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -212,7 +212,7 @@ Object {
],
},
Object {
"test": "/\\\\.(stories|story)\\\\.mdx$/",
"test": "/(stories|story)\\\\.mdx$/",
"use": Array [
Object {
"loader": "NODE_MODULES/babel-loader/lib/index.js",
Expand Down Expand Up @@ -302,7 +302,7 @@ Object {
],
},
Object {
"exclude": "/\\\\.(stories|story)\\\\.mdx$/",
"exclude": "/(stories|story)\\\\.mdx$/",
"test": "/\\\\.mdx$/",
"use": Array [
Object {
Expand Down
4 changes: 2 additions & 2 deletions lib/core-server/src/__snapshots__/vue-3-cli_preview-dev
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -225,7 +225,7 @@ Object {
],
},
Object {
"test": "/\\\\.(stories|story)\\\\.mdx$/",
"test": "/(stories|story)\\\\.mdx$/",
"use": Array [
Object {
"loader": "NODE_MODULES/babel-loader/lib/index.js",
Expand Down Expand Up @@ -315,7 +315,7 @@ Object {
],
},
Object {
"exclude": "/\\\\.(stories|story)\\\\.mdx$/",
"exclude": "/(stories|story)\\\\.mdx$/",
"test": "/\\\\.mdx$/",
"use": Array [
Object {
Expand Down
4 changes: 2 additions & 2 deletions lib/core-server/src/__snapshots__/vue-3-cli_preview-prod
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -224,7 +224,7 @@ Object {
],
},
Object {
"test": "/\\\\.(stories|story)\\\\.mdx$/",
"test": "/(stories|story)\\\\.mdx$/",
"use": Array [
Object {
"loader": "NODE_MODULES/babel-loader/lib/index.js",
Expand Down Expand Up @@ -314,7 +314,7 @@ Object {
],
},
Object {
"exclude": "/\\\\.(stories|story)\\\\.mdx$/",
"exclude": "/(stories|story)\\\\.mdx$/",
"test": "/\\\\.mdx$/",
"use": Array [
Object {
Expand Down
4 changes: 2 additions & 2 deletions lib/core-server/src/__snapshots__/web-components-kitchen-sink_preview-dev
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -244,7 +244,7 @@ Object {
],
},
Object {
"test": "/\\\\.(stories|story)\\\\.mdx$/",
"test": "/(stories|story)\\\\.mdx$/",
"use": Array [
Object {
"loader": "NODE_MODULES/babel-loader/lib/index.js",
Expand Down Expand Up @@ -334,7 +334,7 @@ Object {
],
},
Object {
"exclude": "/\\\\.(stories|story)\\\\.mdx$/",
"exclude": "/(stories|story)\\\\.mdx$/",
"test": "/\\\\.mdx$/",
"use": Array [
Object {
Expand Down
4 changes: 2 additions & 2 deletions lib/core-server/src/__snapshots__/web-components-kitchen-sink_preview-prod
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -243,7 +243,7 @@ Object {
],
},
Object {
"test": "/\\\\.(stories|story)\\\\.mdx$/",
"test": "/(stories|story)\\\\.mdx$/",
"use": Array [
Object {
"loader": "NODE_MODULES/babel-loader/lib/index.js",
Expand Down Expand Up @@ -333,7 +333,7 @@ Object {
],
},
Object {
"exclude": "/\\\\.(stories|story)\\\\.mdx$/",
"exclude": "/(stories|story)\\\\.mdx$/",
"test": "/\\\\.mdx$/",
"use": Array [
Object {
Expand Down
70 changes: 37 additions & 33 deletions lib/core-server/src/core-presets.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,48 +113,52 @@ describe.each([
['vue-3-cli', vue3Options],
['web-components-kitchen-sink', webComponentsOptions],
['html-kitchen-sink', htmlOptions],
])('%s', (example, frameworkOptions) => {
beforeEach(() => {
jest.clearAllMocks();
cache.clear();
});
])(
'%s',
(example, frameworkOptions) => {
beforeEach(() => {
jest.clearAllMocks();
cache.clear();
});

const options = {
...baseOptions,
...frameworkOptions,
configDir: path.resolve(`${__dirname}/../../../examples/${example}/.storybook`),
};
const options = {
...baseOptions,
...frameworkOptions,
configDir: path.resolve(`${__dirname}/../../../examples/${example}/.storybook`),
};

describe('manager', () => {
it('dev mode', async () => {
await buildDevStandalone({ ...options, ignorePreview: true });
describe('manager', () => {
it('dev mode', async () => {
await buildDevStandalone({ ...options, ignorePreview: true });

const managerConfig = prepareSnap(managerExecutor.get, 'manager');
expect(managerConfig).toMatchSpecificSnapshot(snap(`${example}_manager-dev`));
});
it('production mode', async () => {
await buildStaticStandalone({ ...options, ignorePreview: true });
const managerConfig = prepareSnap(managerExecutor.get, 'manager');
expect(managerConfig).toMatchSpecificSnapshot(snap(`${example}_manager-dev`));
});
it('production mode', async () => {
await buildStaticStandalone({ ...options, ignorePreview: true });

const managerConfig = prepareSnap(managerExecutor.get, 'manager');
expect(managerConfig).toMatchSpecificSnapshot(snap(`${example}_manager-prod`));
const managerConfig = prepareSnap(managerExecutor.get, 'manager');
expect(managerConfig).toMatchSpecificSnapshot(snap(`${example}_manager-prod`));
});
});
});

describe('preview', () => {
it('dev mode', async () => {
await buildDevStandalone({ ...options, managerCache: true });
describe('preview', () => {
it('dev mode', async () => {
await buildDevStandalone({ ...options, managerCache: true });

const previewConfig = prepareSnap(previewExecutor.get, 'preview');
expect(previewConfig).toMatchSpecificSnapshot(snap(`${example}_preview-dev`));
});
it('production mode', async () => {
await buildStaticStandalone({ ...options, managerCache: true });
const previewConfig = prepareSnap(previewExecutor.get, 'preview');
expect(previewConfig).toMatchSpecificSnapshot(snap(`${example}_preview-dev`));
});
it('production mode', async () => {
await buildStaticStandalone({ ...options, managerCache: true });

const previewConfig = prepareSnap(previewExecutor.get, 'preview');
expect(previewConfig).toMatchSpecificSnapshot(snap(`${example}_preview-prod`));
const previewConfig = prepareSnap(previewExecutor.get, 'preview');
expect(previewConfig).toMatchSpecificSnapshot(snap(`${example}_preview-prod`));
});
});
});
});
},
10000
);

const progressPlugin = (config) =>
config.plugins.find((p) => p.constructor.name === 'ProgressPlugin');
Expand Down