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

Upgrade Storybook to v8.4 #8173

Merged
merged 5 commits into from
Nov 22, 2024
Merged

Upgrade Storybook to v8.4 #8173

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
527a4fa
Update Storybook to latest 8.4
cee-chen Nov 21, 2024
03e514b
Fix typescript linting Storybook's types
cee-chen Nov 21, 2024
b6427dd
Fix invalid control `array` type
cee-chen Nov 21, 2024
ae1cf97
Remove/disable invalid `function` control type
cee-chen Nov 21, 2024
2fe89ed
Fix reused control obj type
cee-chen Nov 21, 2024
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
23 changes: 12 additions & 11 deletions packages/eui/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,16 +113,17 @@
"@loki/create-async-callback": "^0.35.0",
"@loki/is-loki-running": "^0.35.0",
"@pmmmwh/react-refresh-webpack-plugin": "^0.5.3",
"@storybook/addon-essentials": "^8.0.5",
"@storybook/addon-interactions": "^8.0.5",
"@storybook/addon-links": "^8.0.5",
"@storybook/addon-essentials": "^8.4.5",
"@storybook/addon-interactions": "^8.4.5",
"@storybook/addon-links": "^8.4.5",
"@storybook/addon-webpack5-compiler-babel": "^3.0.3",
"@storybook/blocks": "^8.0.5",
"@storybook/manager-api": "^8.1.3",
"@storybook/preview-api": "^8.1.3",
"@storybook/react": "^8.0.5",
"@storybook/react-webpack5": "^8.0.5",
"@storybook/test": "^8.0.5",
"@storybook/blocks": "^8.4.5",
"@storybook/docs-tools": "^8.4.5",
"@storybook/manager-api": "^8.4.5",
"@storybook/preview-api": "^8.4.5",
"@storybook/react": "^8.4.5",
"@storybook/react-webpack5": "^8.4.5",
"@storybook/test": "^8.4.5",
"@svgr/core": "8.0.0",
"@svgr/plugin-jsx": "^8.0.1",
"@svgr/plugin-svgo": "^8.0.1",
Expand Down Expand Up @@ -189,7 +190,7 @@
"eslint-plugin-prettier": "^4.2.1",
"eslint-plugin-react": "^7.32.2",
"eslint-plugin-react-hooks": "^4.6.0",
"eslint-plugin-storybook": "^0.8.0",
"eslint-plugin-storybook": "^0.9.0",
Copy link
Member Author

@cee-chen cee-chen Nov 21, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

I tried updating this to the latest v0.11.1, but it looks like the flat config support they added in v0.10.0 breaks in our version of eslint, so this is likely the highest we can go until we upgrade to eslint v9+

See storybookjs/eslint-plugin-storybook#183

"expose-gc": "^1.0.0",
"file-loader": "^6.1.0",
"findup": "^0.1.5",
Expand Down Expand Up @@ -235,7 +236,7 @@
"sass-loader": "^13.2.0",
"shelljs": "^0.8.4",
"start-server-and-test": "^1.11.3",
"storybook": "^8.0.5",
"storybook": "^8.4.5",
"style-loader": "^3.3.1",
"stylelint": "^15.7.0",
"stylelint-config-prettier-scss": "^1.0.0",
Expand Down
4 changes: 1 addition & 3 deletions packages/eui/src/components/button/button_group/button_group.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,9 +33,6 @@ const meta: Meta<EuiButtonGroupProps> = {
control: 'object',
if: { arg: 'type', eq: 'multi' },
},
options: {
control: 'array',
},
},
args: {
// Component defaults
Expand All @@ -45,6 +42,7 @@ const meta: Meta<EuiButtonGroupProps> = {
isDisabled: false,
isFullWidth: false,
isIconOnly: false,
options: [],
},
};
disableStorybookControls(meta, ['type']);
Expand Down
3 changes: 2 additions & 1 deletion packages/eui/src/components/color_picker/color_picker.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,14 @@ import React, { FunctionComponent, useState, useEffect } from 'react';
import type { Meta, StoryObj } from '@storybook/react';
import { enableFunctionToggleControls } from '../../../.storybook/utils';

import { euiPaletteColorBlind } from '../..//services';
import { EuiColorPicker, EuiColorPickerProps } from './color_picker';

const meta: Meta<EuiColorPickerProps> = {
title: 'Forms/EuiColorPicker/EuiColorPicker',
component: EuiColorPicker,
argTypes: {
color: { control: 'color' },
swatches: { control: 'array' }, // TODO: crashes if clicked in Storybook
append: { control: 'text' },
prepend: { control: 'text' },
},
Expand All @@ -33,6 +33,7 @@ const meta: Meta<EuiColorPickerProps> = {
display: 'default',
mode: 'default',
secondaryInputDisplay: 'none',
swatches: euiPaletteColorBlind(),
Copy link
Contributor

Choose a reason for hiding this comment

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

Borealis mental note: There were changes on the Borealis branch to color palettes and how they update based on theme. These type of calls need to be linked to state to ensure expected updates.

},
};
enableFunctionToggleControls(meta, ['onChange']);
Expand Down
2 changes: 1 addition & 1 deletion packages/eui/src/components/combo_box/combo_box.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ const meta: Meta<EuiComboBoxProps<{}>> = {
// Storybook is skipping the Pick<> props from EuiComboBoxList for some annoying reason
onCreateOption: { control: 'boolean' }, // Set to a true/false for ease of testing
customOptionText: { control: 'text' },
renderOption: { control: 'function' },
renderOption: { control: false }, // Storybook doesn't have a function control type
},
args: {
// Pass options in by default for ease of testing
Expand Down
4 changes: 2 additions & 2 deletions packages/eui/src/components/comment_list/comment.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ export const _eventColorArgType = {
'accent',
],
control: { type: 'radio' },
};
} as const;
export const _actionsExampleArgType = {
control: 'radio',
options: ['Example action', 'No actions'],
Expand All @@ -46,7 +46,7 @@ export const _actionsExampleArgType = {
'No actions': null,
},
defaultValue: 'Example action',
};
} as const;

/**
* Rendered stories
Expand Down
2 changes: 1 addition & 1 deletion packages/eui/src/components/date_picker/date_picker.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ const meta: Meta<EuiDatePickerProps> = {
'Allows customizing the underlying EuiPopover component, of type `Partial<EuiPopoverProps>`',
},
filterDate: {
control: 'function',
control: false, // Storybook doesn't have a function control type
// @ts-ignore - overwriting to match jsdoc info
type: '(date: moment.Moment) => boolean',
},
Expand Down
3 changes: 3 additions & 0 deletions packages/eui/tsconfig.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,9 @@
// same in TypeScript as it does in Node.js.
"moduleResolution": "node",

// Skip type checking node_modules
"skipLibCheck": true,

// Disallow inconsistently-cased references to the same file.
"forceConsistentCasingInFileNames": true,

Expand Down
Loading
Loading