Skip to content

docs: add asynchronous entry configuration example #4370

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

Merged
chenjiahan merged 3 commits into from
Jan 14, 2025
Merged

docs: add asynchronous entry configuration example #4370

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8699e88
docs: add asynchronous entry configuration example
chenjiahan Jan 14, 2025
2e3e4dd
docs
chenjiahan Jan 14, 2025
71e2c5a
docs
chenjiahan Jan 14, 2025
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
29 changes: 28 additions & 1 deletion website/docs/en/config/source/entry.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ When you build for multiple [environments](/config/environments), you can set di

For example, set different entry for `web` and `node` environments:

```js
```ts title="rsbuild.config.ts"
export default {
environments: {
web: {
Expand All @@ -125,3 +125,30 @@ export default {
},
};
```

## Asynchronous setting

If you need to set entry asynchronously, for example, use [glob](https://www.npmjs.com/package/glob) to scan the directory, you can export an async function in `rsbuild.config.ts`:

```ts title="rsbuild.config.ts"
import path from 'node:path';
import { glob } from 'glob';
import { defineConfig } from '@rsbuild/core';

export default defineConfig(async () => {
const entryFiles = await glob('./src/**/main.{ts,tsx,js,jsx}');

const entry = Object.fromEntries(
entryFiles.map((file) => {
const entryName = path.basename(path.dirname(file));
return [entryName, `./${file}`];
}),
);

return {
source: {
entry: entry,
},
};
});
```
29 changes: 28 additions & 1 deletion website/docs/zh/config/source/entry.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ export default {

比如为 `web` 和 `node` 环境设置不同的 entry：

```js
```ts title="rsbuild.config.ts"
export default {
environments: {
web: {
Expand All @@ -125,3 +125,30 @@ export default {
},
};
```

## 异步设置

如果你需要异步设置 entry，例如使用 [glob](https://www.npmjs.com/package/glob) 来扫描目录，可以在 `rsbuild.config.ts` 中导出一个异步函数：

```ts title="rsbuild.config.ts"
import path from 'node:path';
import { glob } from 'glob';
import { defineConfig } from '@rsbuild/core';

export default defineConfig(async () => {
const entryFiles = await glob('./src/**/main.{ts,tsx,js,jsx}');

const entry = Object.fromEntries(
entryFiles.map((file) => {
const entryName = path.basename(path.dirname(file));
return [entryName, `./${file}`];
}),
);

return {
source: {
entry: entry,
},
};
});
```
Loading