Skip to content

Commit

Permalink
chore: bump for Rsbuild 1.0
Browse files Browse the repository at this point in the history
  • Loading branch information
fi3ework committed Sep 10, 2024
1 parent b34e5dd commit 0003974
Show file tree
Hide file tree
Showing 8 changed files with 78 additions and 70 deletions.
19 changes: 9 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
<a href="https://github.com/rspack-contrib/storybook-rsbuild/blob/main/LICENSE"><img src="https://img.shields.io/npm/l/storybook-builder-rsbuild?style=flat-square&color=%23ff4785" alt="license" /></a>
</p>

The repository contains the Storybook Rsbuild builder and framework integrations for UI frameworks.
The repository contains the Storybook Rsbuild builder and UI framework integrations.

| package | description |
| ------------------------------------------------------- | ---------------------------------------------------- |
Expand All @@ -21,7 +21,7 @@ The repository contains the Storybook Rsbuild builder and framework integrations
> [!IMPORTANT]
> Peer dependencies requirements:
>
> - **`@rsbuild/core >= 1.0.1-beta.14`**: Rsbuild is about to release version 1.0.0, and the current alpha version is already very reliable. (check out Rsbuild's [1.0.0 breaking changes](https://github.com/web-infra-dev/rsbuild/discussions/2508))
> - **`@rsbuild/core >= 1.0.1`**: The builder relies on Rsbuild's 1.0 stable version. Check out Rsbuild's [1.0](https://rsbuild.dev/community/releases/v1-0) announcement for more details.
> - **`storybook >= 8.2.1`**: Storybook made some internal refactor in major version, 8.2.1 is tested out. (check out Storybook's [release note](https://storybook.js.org/blog/storybook-8/) for migrating from v7)
In Storybook v8, you don't need to manually install storybook-builder-rsbuild, it has been depended by the framework, such as `storybook-react-rsbuild` and `storybook-vue3-rsbuild`.
Expand All @@ -41,11 +41,11 @@ In Storybook v8, you don't need to manually install storybook-builder-rsbuild, i
framework: 'storybook-react-rsbuild',
rsbuildFinal: (config) => {
// Customize the final Rsbuild config here
return config;
return config
},
};
}

export default config;
export default config
```

You're all set now. You could also check out the example in [sandboxes/react-18](./sandboxes/react-18) and use all other features listed in [Storybook site](https://storybook.js.org/docs).
Expand All @@ -65,11 +65,11 @@ You're all set now. You could also check out the example in [sandboxes/react-18]
framework: 'storybook-vue3-rsbuild',
rsbuildFinal: (config) => {
// Customize the final Rsbuild config here
return config;
return config
},
};
}

export default config;
export default config
```

You're all set now. You could also check out the example in [sandboxes/vue3-rsbuild](./sandboxes/vue3-rsbuild) and use all other features listed in [Storybook site](https://storybook.js.org/docs).
Expand Down Expand Up @@ -158,7 +158,7 @@ export default config

```js
// .storybook/main.mjs
import remarkGfm from 'remark-gfm';
import remarkGfm from 'remark-gfm'

const config = {
framework: {
Expand Down Expand Up @@ -228,7 +228,6 @@ const config: StorybookConfig = {
}
```


### Error caused by bundling unexpected files

> [!NOTE]
Expand Down
6 changes: 3 additions & 3 deletions packages/builder-rsbuild/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@
"prepare": "pnpm run build"
},
"dependencies": {
"@rsbuild/plugin-type-check": "1.0.1-rc.5",
"@rsbuild/plugin-type-check": "^1.0.1",
"@storybook/addon-docs": "^8.2.1",
"@storybook/core-webpack": "^8.2.1",
"browser-assert": "^1.2.1",
Expand All @@ -80,7 +80,7 @@
"util-deprecate": "^1.0.2"
},
"devDependencies": {
"@rsbuild/core": "1.0.1-rc.5",
"@rsbuild/core": "1.0.1",
"@types/express": "^4.17.21",
"@types/fs-extra": "^11.0.4",
"@types/node": "^18.0.0",
Expand All @@ -92,7 +92,7 @@
"typescript": "^5.3.2"
},
"peerDependencies": {
"@rsbuild/core": ">= 1.0.1-beta.14 || 1.x",
"@rsbuild/core": "^1.0.1",
"storybook": "^8.2.1"
},
"peerDependenciesMeta": {
Expand Down
4 changes: 2 additions & 2 deletions packages/react-rsbuild/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -56,15 +56,15 @@
"tsconfig-paths": "^4.2.0"
},
"devDependencies": {
"@rsbuild/core": "1.0.1-rc.5",
"@rsbuild/core": "1.0.1",
"@storybook/types": "8.3.0-beta.3",
"@types/resolve": "^1.20.6",
"add": "^2.0.6",
"storybook": "8.3.0-beta.3",
"typescript": "^5.3.2"
},
"peerDependencies": {
"@rsbuild/core": ">= 1.0.1-beta.14 || 1.x",
"@rsbuild/core": "^1.0.1",
"react": "^16.8.0 || ^17.0.0 || ^18.0.0 || ^19.0.0-beta",
"react-dom": "^16.8.0 || ^17.0.0 || ^18.0.0 || ^19.0.0-beta",
"storybook": "^8.2.1",
Expand Down
4 changes: 2 additions & 2 deletions packages/vue3-rsbuild/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -45,13 +45,13 @@
"vue-docgen-loader": "^1.5.1"
},
"devDependencies": {
"@rsbuild/core": "1.0.1-rc.5",
"@rsbuild/core": "1.0.1",
"@types/node": "^18.0.0",
"storybook": "8.3.0-beta.3",
"typescript": "^5.3.2"
},
"peerDependencies": {
"@rsbuild/core": ">= 1.0.1-beta.14 || 1.x",
"@rsbuild/core": "^1.0.1",
"storybook": "^8.2.1"
},
"peerDependenciesMeta": {
Expand Down
103 changes: 56 additions & 47 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit 0003974

Please sign in to comment.