{"id":21049127,"url":"https://github.com/electron-rsbuild/electron-rsbuild","last_synced_at":"2025-07-29T11:32:12.430Z","repository":{"id":262855764,"uuid":"877710599","full_name":"electron-rsbuild/electron-rsbuild","owner":"electron-rsbuild","description":"【WIP】Explore the next generation Electron build tooling based on Rsbuild.","archived":false,"fork":false,"pushed_at":"2024-11-18T09:04:43.000Z","size":943,"stargazers_count":21,"open_issues_count":1,"forks_count":4,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-07-22T21:49:03.389Z","etag":null,"topics":["electron","electron-rsbuild","rsbuild"],"latest_commit_sha":null,"homepage":"https://electron-rsbuild.org","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/electron-rsbuild.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-10-24T05:39:31.000Z","updated_at":"2025-07-20T00:10:04.000Z","dependencies_parsed_at":"2024-11-19T03:53:48.578Z","dependency_job_id":null,"html_url":"https://github.com/electron-rsbuild/electron-rsbuild","commit_stats":null,"previous_names":["veaba/electron-rsbuild","electron-rsbuild/electron-rsbuild"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/electron-rsbuild/electron-rsbuild","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/electron-rsbuild%2Felectron-rsbuild","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/electron-rsbuild%2Felectron-rsbuild/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/electron-rsbuild%2Felectron-rsbuild/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/electron-rsbuild%2Felectron-rsbuild/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/electron-rsbuild","download_url":"https://codeload.github.com/electron-rsbuild/electron-rsbuild/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/electron-rsbuild%2Felectron-rsbuild/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":267213475,"owners_count":24053912,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-07-26T02:00:08.937Z","response_time":62,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["electron","electron-rsbuild","rsbuild"],"created_at":"2024-11-19T15:01:10.435Z","updated_at":"2025-07-29T11:32:12.425Z","avatar_url":"https://github.com/electron-rsbuild.png","language":"TypeScript","funding_links":[],"categories":["Resources"],"sub_categories":["Ecosystem"],"readme":"# electron-rsbuild\n\n\u003e WIP, do not use it directly in the production environment.\n\nExport Next generation Electron build tooling based on Rsbuild.\n\n[![Release](https://github.com/electron-rsbuild/electron-rsbuild/actions/workflows/release.yml/badge.svg)](https://github.com/electron-rsbuild/electron-rsbuild/actions/workflows/release.yml)\n\n- [document](https://electron-rsbuild.org/)\n- [electron-rsbuild](https://github.com/electron-rsbuild/electron-rsbuild/)\n- [electron-rsbuild org](https://github.com/electron-rsbuild/)\n\n## Usage\n\n### by npm package\n\n1. install core package:\n\n```sh\npnpm add @electron-rsbuild/core\n```\n\n2. update `package.json` file like this:\n\n```json\n{\n  \"scripts\": {\n    \"start\": \"electron-rsbuild preview\",\n    \"dev\": \"electron-rsbuild dev\",\n    \"build\": \"electron-rsbuild build\"\n  }\n}\n```\n\n3. create a `electron.rsbuild.config.ts` file to your project root directory:\n\n```ts\nimport { resolve } from 'path';\nimport { defineConfig } from '@rsbuild/core';\nimport { pluginReact } from '@rsbuild/plugin-react';\n\nexport default defineConfig({\n  root: resolve(__dirname, '.'),\n  environments: {\n    // main\n    main: {},\n    // preload\n    preload: {},\n    // renderer\n    renderer: {\n      plugins: [pluginReact()],\n    },\n  },\n});\n```\n\n### by rsbuild plugin\n\n\u003e Note that if you use electron-rsbuild as a plugin, you will be missing a lot of built-in features.\n\n```sh\npnpm add -D @electron-rsbuild/plugin-main @electron-rsbuild/plugin-preload @electron-rsbuild/plugin-renderer\n```\n\nupdate `rsbuild.config.ts`:\n\n```ts\nimport { resolve } from 'path';\nimport { defineConfig } from '@rsbuild/core';\nimport { pluginReact } from '@rsbuild/plugin-react';\nimport { mainPlugin } from '@electron-rsbuild/plugin-main';\nimport { preloadPlugin } from '@electron-rsbuild/plugin-preload';\nimport { rendererPlugin } from '@electron-rsbuild/plugin-renderer';\n\nexport default defineConfig({\n  root: resolve(__dirname, '.'),\n  environments: {\n    // main\n    main: {\n      plugins: [mainPlugin()],\n    },\n    // preload\n    preload: {\n      plugins: [preloadPlugin()],\n    },\n\n    // renderer\n    renderer: {\n      plugins: [pluginReact(), rendererPlugin()],\n    },\n  },\n});\n```\n\n`package.json`:\n\n```json\n  \"scripts\": {\n    \"dev\": \"rsbuild dev\",\n    \"build\": \"rsbuild build\"\n  }\n\n```\n\n## Playground Snapshot\n\nUse `npm create electron-rsbuild@0.0.10` create a electron-rsbuild project:\n\n![playground-install-npm](https://electron-rsbuild.org/playground/playground-install-npm.png)\n\nUse `pnpm run dev` launch electron:\n\n![playground-demo](https://electron-rsbuild.org/playground/playground-demo.png)\n\n## Benchmark TODO\n\n## Reference\n\n- [rsbuild](https://github.com/web-infra-dev/rsbuild)\n- [rspack](https://github.com/web-infra-dev/rspack)\n- [vite](https://github.com/vitejs/vite)\n- [electron-vite](https://github.com/alex8088/electron-vite)\n- [electron](https://github.com/electron/electron)\n\n## 🤝 Contribution\n\n\u003e New contributors welcome!\n\nPlease read the [Contributing Guide](https://github.com/electron-rsbuild/electron-rsbuild/blob/main/CONTRIBUTING.md).\n\n## 📖 License\n\nElectron-Rsbuild is licensed under the MIT License.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Felectron-rsbuild%2Felectron-rsbuild","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Felectron-rsbuild%2Felectron-rsbuild","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Felectron-rsbuild%2Felectron-rsbuild/lists"}