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.

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

Add support for storybook v8 #855

Merged
merged 7 commits into from
Mar 15, 2024
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
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
6 changes: 5 additions & 1 deletion .github/workflows/integrated_test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,13 +21,17 @@ jobs:
- examples/v6-story-store-v7
- examples/v7-managed-react
- examples/v7-react18
- examples/v8-react18
include:
- example_dir: examples/v8-react18
node-version: 18.x
Comment on lines +26 to +27
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@storybook/react depends on node versions 18 and higher.


steps:
- uses: actions/checkout@v3
- name: Use Node.js
uses: actions/setup-node@v3
with:
node-version: 16.x
node-version: ${{ matrix.node-version || '16.x' }}
cache: 'yarn'
- run: yarn install --frozen-lockfile
- run: yarn bootstrap
Expand Down
23 changes: 23 additions & 0 deletions examples/v8-react18/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.

# dependencies
/node_modules
/.pnp
.pnp.js

# testing
/coverage

# production
/build

# misc
.DS_Store
.env.local
.env.development.local
.env.test.local
.env.production.local

npm-debug.log*
yarn-debug.log*
yarn-error.log*
16 changes: 16 additions & 0 deletions examples/v8-react18/.storybook/main.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
module.exports = {
stories: ['../src/**/*.stories.@(js|jsx|mdx)'],
addons: [
'@storybook/addon-essentials',
'@storybook/addon-links',
'storycap',
'@storybook/preset-create-react-app',
],
framework: {
name: '@storybook/react-webpack5',
options: {}
},
docs: {
autodocs: true
}
};
24 changes: 24 additions & 0 deletions examples/v8-react18/.storybook/preview-head.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
<style>
.button {
border: 1px solid #eee;
border-radius: 3;
background-color: #FFFFFF;
cursor: pointer;
font-size: 15;
padding: 3px 10px;
margin: 10;
}

.my-button {
cursor: pointer;
height: 32px;
padding: 0 16px;
line-height: 32px;
border: 1px solid #ddd;
border-radius: 4px;
}

.my-button:hover {
color: #a0a0a0;
}
</style>
22 changes: 22 additions & 0 deletions examples/v8-react18/.storybook/preview.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
import { withScreenshot } from 'storycap';

export const decorators = [
withScreenshot,
];

export const parameters = {
screenshot: {
viewports: {
LARGE: {
width: 1200,
height: 800,
},
SMALL: {
width: 375,
height: 667,
deviceScaleFactor: 2,
isMobile: true,
},
},
},
};
68 changes: 68 additions & 0 deletions examples/v8-react18/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).

## Available Scripts

In the project directory, you can run:

### `npm start`

Runs the app in the development mode.<br>
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.

The page will reload if you make edits.<br>
You will also see any lint errors in the console.

### `npm test`

Launches the test runner in the interactive watch mode.<br>
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.

### `npm run build`

Builds the app for production to the `build` folder.<br>
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.<br>
Your app is ready to be deployed!

See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.

### `npm run eject`

**Note: this is a one-way operation. Once you `eject`, you can’t go back!**

If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.

Instead, it will copy all the configuration files and the transitive dependencies (Webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.

You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.

## Learn More

You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).

To learn React, check out the [React documentation](https://reactjs.org/).

### Code Splitting

This section has moved here: https://facebook.github.io/create-react-app/docs/code-splitting

### Analyzing the Bundle Size

This section has moved here: https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size

### Making a Progressive Web App

This section has moved here: https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app

### Advanced Configuration

This section has moved here: https://facebook.github.io/create-react-app/docs/advanced-configuration

### Deployment

This section has moved here: https://facebook.github.io/create-react-app/docs/deployment

### `npm run build` fails to minify

This section has moved here: https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify
46 changes: 46 additions & 0 deletions examples/v8-react18/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
{
"name": "v8-react18",
"version": "0.1.0",
"private": true,
"dependencies": {
"react": "^18.2.0",
"react-dom": "^18.2.0",
"react-scripts": "^5.0.0"
},
"scripts": {
"clear": "rimraf __screenshots__",
"start": "react-scripts start",
"build": "react-scripts build",
"test": "react-scripts test --setupFiles ./setupFile.js",
"eject": "react-scripts eject",
"storybook": "storybook dev -p 9009",
"build-storybook": "storybook build",
"prestorybook": "../../scripts/e2e-prestorybook.js .",
"storycap:all": "yarn prestorybook && yarn test && storycap --verbose --server-timeout 100000 --server-cmd \"storybook dev -p 9009\" \"http://localhost:9009\""
},
"eslintConfig": {
"extends": "react-app",
"rules": {
"import/no-anonymous-default-export": "off"
}
},
"browserslist": [
">0.2%",
"not dead",
"not ie <= 11",
"not op_mini all"
],
"devDependencies": {
"@storybook/addon-actions": "^8.0.0",
"@storybook/addon-essentials": "^8.0.0",
"@storybook/addon-links": "^8.0.0",
"@storybook/addons": "^7.6.17",
Copy link
Member

Choose a reason for hiding this comment

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

Is this version intentional ?

    "@storybook/addons": "^8.0.0",

I think the following error is related to this version mismatching 🤔

https://github.com/reg-viz/storycap/actions/runs/8294518431/job/22703172139?pr=855#step:7:88

Copy link

@ajkl2533 ajkl2533 Mar 15, 2024

Choose a reason for hiding this comment

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

The @storybook/addons package has been deprecated since v7 was replaced by @storybook/manager-api and @storybook/preview-api.

https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#new-addons-api

Copy link
Contributor Author

@indigolain indigolain Mar 15, 2024

Choose a reason for hiding this comment

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

Thanks! Yes, the @storybook/addons seems to be replaced, so we need to switch to using @storybook/manager-api and @storybook/preview-api.

However, the following files depend on @storybook/addons.

  • packages/storycap/src/client/register.ts
  • packages/storycap/src/client/with-screenshot.ts

So, I think that if we want to support the older versions of storybook, we might need to do either of the following

  • A: find someway to detect the installed storybook version and maybe dynamically import the corresponding packages
  • B: try to import the @storybook/addons package and fallback to importing @storybook/manager-api or @storybook/preview-api if it's not available

Which way seems better? B may look something like 365331c?

Copy link
Member

Choose a reason for hiding this comment

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

@indigolain Thanks for planning of solution 👍

Your plan B looks good 😸

"@storybook/cli": "^8.0.0",
"@storybook/preset-create-react-app": "^8.0.0",
"@storybook/react": "^8.0.0",
"@storybook/react-webpack5": "^8.0.0",
"@testing-library/react": "^14.0.0",
"rimraf": "^2.6.3",
"storybook": "^8.0.0"
}
}
Binary file added examples/v8-react18/public/favicon.ico
Binary file not shown.
41 changes: 41 additions & 0 deletions examples/v8-react18/public/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<link rel="shortcut icon" href="%PUBLIC_URL%/favicon.ico" />
<meta
name="viewport"
content="width=device-width, initial-scale=1, shrink-to-fit=no"
/>
<meta name="theme-color" content="#000000" />
<!--
manifest.json provides metadata used when your web app is installed on a
user's mobile device or desktop. See https://developers.google.com/web/fundamentals/web-app-manifest/
-->
<link rel="manifest" href="%PUBLIC_URL%/manifest.json" />
<!--
Notice the use of %PUBLIC_URL% in the tags above.
It will be replaced with the URL of the `public` folder during the build.
Only files inside the `public` folder can be referenced from the HTML.

Unlike "/favicon.ico" or "favicon.ico", "%PUBLIC_URL%/favicon.ico" will
work correctly both with client-side routing and a non-root public URL.
Learn how to configure a non-root public URL by running `npm run build`.
-->
<title>React App</title>
</head>
<body>
<noscript>You need to enable JavaScript to run this app.</noscript>
<div id="root"></div>
<!--
This HTML file is a template.
If you open it directly in the browser, you will see an empty page.

You can add webfonts, meta tags, or analytics to this file.
The build step will place the bundled scripts into the <body> tag.

To begin the development, run `npm start` or `yarn start`.
To create a production bundle, use `npm run build` or `yarn build`.
-->
</body>
</html>
15 changes: 15 additions & 0 deletions examples/v8-react18/public/manifest.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
{
"short_name": "React App",
"name": "Create React App Sample",
"icons": [
{
"src": "favicon.ico",
"sizes": "64x64 32x32 24x24 16x16",
"type": "image/x-icon"
}
],
"start_url": ".",
"display": "standalone",
"theme_color": "#000000",
"background_color": "#ffffff"
}
4 changes: 4 additions & 0 deletions examples/v8-react18/setupFile.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
import { setProjectAnnotations } from '@storybook/react';
import * as globalStorybookConfig from './.storybook/preview';

setProjectAnnotations(globalStorybookConfig);
33 changes: 33 additions & 0 deletions examples/v8-react18/src/App.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
.App {
text-align: center;
}

.App-logo {
animation: App-logo-spin infinite 20s linear;
height: 40vmin;
pointer-events: none;
}

.App-header {
background-color: #282c34;
min-height: 100vh;
display: flex;
flex-direction: column;
align-items: center;
justify-content: center;
font-size: calc(10px + 2vmin);
color: white;
}

.App-link {
color: #61dafb;
}

@keyframes App-logo-spin {
from {
transform: rotate(0deg);
}
to {
transform: rotate(360deg);
}
}
28 changes: 28 additions & 0 deletions examples/v8-react18/src/App.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
import React, { Component } from 'react';
import logo from './logo.svg';
import './App.css';

class App extends Component {
render() {
return (
<div className="App">
<header className="App-header">
<img src={logo} className="App-logo" alt="logo" />
<p>
Edit <code>src/App.js</code> and save to reload.
</p>
<a
className="App-link"
href="https://reactjs.org"
target="_blank"
rel="noopener noreferrer"
>
Learn React
</a>
</header>
</div>
);
}
}

export default App;
10 changes: 10 additions & 0 deletions examples/v8-react18/src/App.test.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
import React from 'react';
import ReactDOM from 'react-dom/client';
import App from './App';

it('renders without crashing', () => {
const div = document.createElement('div');
const root = ReactDOM.createRoot(div);
root.render(<App />);
root.unmount();
});
7 changes: 7 additions & 0 deletions examples/v8-react18/src/Button.jsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
import React from 'react';

export const Button = ({ children, onClick }) => (
<button className='button' onClick={onClick} type="button">
{children}
</button>
);
Loading