storybook-builder-rsbuild 0.0.1 → 0.0.2

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2024-present Bytedance, Inc. and its affiliates.
+Copyright (c) 2024 Rspack Contrib
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -1,152 +1,3 @@
 # storybook-builder-rsbuild
 
-Storybook builder powered by Rsbuild.
-
-## Installation
-
-Requirements: `@rsbuild/core >= 0.6.15`, 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.
-
-## Usage
-
-### Use with React
-
-1. Install `storybook-react-rsbuild`.
-2. Change `.storybook/main.js`
-
-   ```js
-   import { StorybookConfig } from 'storybook-react-rsbuild'
-
-   const config: StorybookConfig = {
-     framework: 'storybook-react-rsbuild',
-     rsbuildFinal: (config) => {
-       // Customize the final webpack config here
-       return config;
-     },
-   };
-
-   export default config;
-   ```
-
-Now you're all set.
-
-### Use with Vue3
-
-1. Install `storybook-vue3-rsbuild`.
-2. Change `.storybook/main.js`
-
-   ```js
-   import { StorybookConfig } from 'storybook-vue3-rsbuild'
-
-   const config: StorybookConfig = {
-     framework: 'storybook-vue3-rsbuild',
-     rsbuildFinal: (config) => {
-       // Customize the final webpack config here
-       return config;
-     },
-   };
-
-   export default config;
-   ```
-
-Now you're all set.
-
-### Customize the Rsbuild config
-
-The builder _will_ read your `rsbuild.config.js` file, though it may change some of the options in order to work correctly.
-It looks for the Rsbuild config in the CWD. If your config is located elsewhere, specify the path using the `rsbuildConfigPath` builder option:
-
-```javascript
-// .storybook/main.mjs
-
-const config = {
-  framework: {
-    name: 'storybook-react-rsbuild',
-    options: {
-      builder: {
-        rsbuildConfigPath: '.storybook/customRsbuildConfig.js',
-      },
-    },
-  },
-}
-
-export default config
-```
-
-You can also override the merged Rsbuild config:
-
-```javascript
-// use `mergeRsbuildConfig` to recursively merge Rsbuild options
-import { mergeRsbuildConfig } from '@rsbuild/core'
-
-const config = {
-  async rsbuildFinal(config, { configType }) {
-    // Be sure to return the customized config
-    return mergeRsbuildConfig(config, {
-      // Customize the Rsbuild config for Storybook
-      source: {
-        alias: { foo: 'bar' },
-      },
-    })
-  },
-}
-
-export default config
-```
-
-The `rsbuildFinal` function will give you `config` which is the combination of your project's Rsbuild config and the builder's own Rsbuild config.
-You can tweak this as you want, for example to set up aliases, add new plugins etc.
-
-The `configType` variable will be either `"DEVELOPMENT"` or `"PRODUCTION"`.
-
-The function should return the updated Rsbuild configuration.
-
-## Troubleshooting
-
-### Error caused by bundling unwanted modules
-
-Because Rspack temporarily does not support the `webpackInclude` magic comment, non-story files may be bundled, which could lead to build failures. These files can be ignored using `rspack.IgnorePlugin`.
-
-```js
-import { mergeRsbuildConfig } from '@rsbuild/core'
-
-module.exports = {
-  framework: 'storybook-react-rsbuild',
-  async rsbuildFinal(config) {
-    return mergeRsbuildConfig(config, {
-      tools: {
-        rspack: (config, { addRules, appendPlugins, rspack, mergeConfig }) => {
-          appendPlugins([
-            new rspack.IgnorePlugin({
-              checkResource: (resource, context) => {
-                const absPathHasExt = extname(resource)
-                if (absPathHasExt === '.md') {
-                  return true
-                }
-
-                return false
-              },
-            }),
-          ])
-        },
-      },
-    })
-  },
-}
-```
-
-## Rspack support tasks
-
-- [ ] Support persistent cache
-- [ ] Support lazy compilation
-- [ ] Support virtual modules
-- [ ] Support `module.unknownContextCritical`
-- [ ] Support `webpackInclude` magic comment
-- [ ] Support `compilation.dependencyTemplates.set` for react-docgen-typescript
-
-## Credits
-
-Some codes are copied or modified from [storybookjs/storybook](https://github.com/storybookjs/storybook).
-
-## License
-
-[MIT](./LICENSE)
+Check out [rspack-contrib/storybook-rsbuild](https://github.com/rspack-contrib/storybook-rsbuild) for documentation.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "storybook-builder-rsbuild",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "Rsbuild builder for Storybook",
   "keywords": [
     "storybook",
@@ -8,6 +8,14 @@
     "rspack"
   ],
   "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/rspack-contrib/storybook-rsbuild/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/rspack-contrib/storybook-rsbuild",
+    "directory": "packages/builder-rsbuild"
+  },
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",
@@ -88,8 +96,7 @@
     "typescript": "^5.3.2"
   },
   "peerDependencies": {
-    "@rsbuild/core": ">= 0.6.15",
-    "vite": "^4.0.0 || ^5.0.0"
+    "@rsbuild/core": ">= 0.6.15"
   },
   "peerDependenciesMeta": {
     "typescript": {

package/typings.d.ts

@@ -1,2 +1,2 @@
-declare module 'lazy-universal-dotenv';
-declare module '@storybook/theming/paths';
+declare module 'lazy-universal-dotenv'
+declare module '@storybook/theming/paths'

package/dist/presets/custom-rsbuild-preset.d.ts

@@ -1,2 +0,0 @@
-// dev-mode
-export * from '../../src/presets/custom-rsbuild-preset';

package/dist/presets/preview-preset.d.ts

@@ -1,2 +0,0 @@
-// dev-mode
-export * from '../../src/presets/preview-preset';