@rstest/adapter-rsbuild 0.1.0 → 0.2.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023-present ByteDance, Inc. and its affiliates.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -10,6 +10,8 @@ npm install @rstest/adapter-rsbuild -D
 
 ## Usage
 
+### `withRsbuildConfig`
+
 ```ts
 import { defineConfig } from '@rstest/core';
 import { withRsbuildConfig } from '@rstest/adapter-rsbuild';
@@ -20,4 +22,37 @@ export default defineConfig({
 });
 ```
 
+Automatically loads Rsbuild config from the current working directory and converts it to Rstest config.
+
 More advanced usage examples can be found in the [Rsbuild integration guide](https://rstest.rs/guide/integration/rsbuild).
+
+### `toRstestConfig`
+
+You can also use `toRstestConfig` directly when you already have an Rsbuild config object.
+
+```ts
+import { loadConfig } from '@rsbuild/core';
+import { toRstestConfig } from '@rstest/adapter-rsbuild';
+
+const { content: rsbuildConfig } = await loadConfig({
+  cwd: process.cwd(),
+});
+
+const rstestConfig = toRstestConfig({
+  rsbuildConfig,
+  environmentName: 'node',
+  modifyRsbuildConfig: (config) => ({
+    ...config,
+    output: {
+      ...config.output,
+      target: 'node',
+    },
+  }),
+});
+```
+
+### Options
+
+- `rsbuildConfig`: Required. The Rsbuild config object to convert.
+- `environmentName`: Optional. Name of the config in `environments` to merge with the base config.
+- `modifyRsbuildConfig`: Optional. Hook to modify merged Rsbuild config before conversion.

package/dist/index.d.ts

@@ -1,5 +1,6 @@
 import { type RsbuildConfig } from '@rsbuild/core';
 import type { ExtendConfigFn } from '@rstest/core';
+import { toRstestConfig } from './toRstestConfig';
 export interface WithRsbuildConfigOptions {
     /**
      * `cwd` passed to loadConfig of Rsbuild
@@ -23,3 +24,4 @@ export interface WithRsbuildConfigOptions {
     modifyRsbuildConfig?: (buildConfig: RsbuildConfig) => RsbuildConfig;
 }
 export declare function withRsbuildConfig(options?: WithRsbuildConfigOptions): ExtendConfigFn;
+export { toRstestConfig };

package/dist/index.js

@@ -1,42 +1,59 @@
 import { loadConfig, mergeRsbuildConfig } from "@rsbuild/core";
+function toRstestConfig({ environmentName, rsbuildConfig: rawRsbuildConfig, modifyRsbuildConfig }) {
+    const { environments, ...rawBuildConfig } = rawRsbuildConfig;
+    const environmentConfig = environmentName ? environments?.[environmentName] : void 0;
+    const rsbuildConfig = environmentConfig ? mergeRsbuildConfig(rawBuildConfig, environmentConfig) : rawBuildConfig;
+    const finalBuildConfig = modifyRsbuildConfig ? modifyRsbuildConfig(rsbuildConfig) : rsbuildConfig;
+    const { rspack, swc, bundlerChain } = finalBuildConfig.tools || {};
+    const { cssModules, target, module } = finalBuildConfig.output || {};
+    const { decorators, define, include, exclude, tsconfigPath } = finalBuildConfig.source || {};
+    return {
+        root: finalBuildConfig.root,
+        name: environmentName,
+        plugins: [
+            ...finalBuildConfig.plugins || [],
+            {
+                name: 'remove-useless-plugins',
+                remove: [
+                    'rsbuild:type-check'
+                ],
+                setup: ()=>{}
+            }
+        ],
+        source: {
+            decorators,
+            define,
+            include,
+            exclude,
+            tsconfigPath
+        },
+        resolve: finalBuildConfig.resolve,
+        output: {
+            cssModules,
+            module
+        },
+        tools: {
+            rspack,
+            swc,
+            bundlerChain
+        },
+        testEnvironment: 'node' === target ? 'node' : 'happy-dom'
+    };
+}
 function withRsbuildConfig(options = {}) {
     return async ()=>{
         const { configPath, modifyRsbuildConfig, environmentName, cwd = process.cwd() } = options;
-        const { content: { environments, ...rawBuildConfig }, filePath } = await loadConfig({
+        const { content: rsbuildConfig, filePath } = await loadConfig({
             cwd,
             path: configPath
         });
         if (!filePath) return {};
-        const environmentConfig = environmentName ? environments?.[environmentName] : void 0;
-        const rsbuildConfig = environmentConfig ? mergeRsbuildConfig(rawBuildConfig, environmentConfig) : rawBuildConfig;
-        const finalBuildConfig = modifyRsbuildConfig ? modifyRsbuildConfig(rsbuildConfig) : rsbuildConfig;
-        const { rspack, swc, bundlerChain } = finalBuildConfig.tools || {};
-        const { cssModules, target, module } = finalBuildConfig.output || {};
-        const { decorators, define, include, exclude, tsconfigPath } = finalBuildConfig.source || {};
-        const rstestConfig = {
-            root: finalBuildConfig.root,
-            name: environmentName,
-            plugins: finalBuildConfig.plugins,
-            source: {
-                decorators,
-                define,
-                include,
-                exclude,
-                tsconfigPath
-            },
-            resolve: finalBuildConfig.resolve,
-            output: {
-                cssModules,
-                module
-            },
-            tools: {
-                rspack,
-                swc,
-                bundlerChain
-            },
-            testEnvironment: 'node' === target ? 'node' : 'happy-dom'
-        };
+        const rstestConfig = toRstestConfig({
+            environmentName,
+            rsbuildConfig,
+            modifyRsbuildConfig
+        });
         return rstestConfig;
     };
 }
-export { withRsbuildConfig };
+export { toRstestConfig, withRsbuildConfig };

package/dist/toRstestConfig.d.ts

@@ -0,0 +1,32 @@
+import { type RsbuildConfig } from '@rsbuild/core';
+import type { ExtendConfig } from '@rstest/core';
+export interface WithRsbuildConfigOptions {
+    /**
+     * `cwd` passed to loadConfig of Rsbuild
+     * @default process.cwd()
+     */
+    cwd?: string;
+    /**
+     * Path to rsbuild config file
+     * @default './rsbuild.config.ts'
+     */
+    configPath?: string;
+    /**
+     * The environment name in `environments` field to use, will be merged with the common config.
+     * Set to a string to use the environment config with matching name.
+     * @default undefined
+     */
+    environmentName?: string;
+    /**
+     * Modify rsbuild config before converting to rstest config
+     */
+    modifyRsbuildConfig?: (buildConfig: RsbuildConfig) => RsbuildConfig;
+}
+/**
+ * Convert rsbuild config to rstest config
+ */
+export declare function toRstestConfig({ environmentName, rsbuildConfig: rawRsbuildConfig, modifyRsbuildConfig, }: {
+    environmentName?: string;
+    rsbuildConfig: RsbuildConfig;
+    modifyRsbuildConfig?: (buildConfig: RsbuildConfig) => RsbuildConfig;
+}): ExtendConfig;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rstest/adapter-rsbuild",
-  "version": "0.1.0",
+  "version": "0.2.1",
   "description": "Rstest adapter for rsbuild configuration",
   "type": "module",
   "main": "dist/index.js",
@@ -14,11 +14,6 @@
   "files": [
     "dist"
   ],
-  "scripts": {
-    "build": "rslib build",
-    "dev": "rslib build --watch",
-    "test": "rstest"
-  },
   "keywords": [
     "rstest",
     "rsbuild",
@@ -27,13 +22,14 @@
   ],
   "license": "MIT",
   "peerDependencies": {
-    "@rsbuild/core": "*"
+    "@rsbuild/core": "*",
+    "@rstest/core": ">=0.7.7"
   },
   "devDependencies": {
-    "@rslib/core": "^0.19.0",
-    "@rsbuild/core": "1.7.1",
-    "@rstest/core": "workspace:*",
-    "@rstest/tsconfig": "workspace:*"
+    "@rsbuild/core": "^2.0.0-beta.6",
+    "@rslib/core": "^0.19.6",
+    "@rstest/core": "0.8.5",
+    "@rstest/tsconfig": "0.0.1"
   },
   "publishConfig": {
     "access": "public"
@@ -45,5 +41,10 @@
     "type": "git",
     "url": "https://github.com/web-infra-dev/rstest",
     "directory": "packages/adapter-rsbuild"
+  },
+  "scripts": {
+    "build": "rslib build",
+    "dev": "rslib build --watch",
+    "test": "rstest"
   }
-}
+}