{"id":27632120,"url":"https://github.com/hunghg255/rsbuild-react-generate-pages","last_synced_at":"2025-04-23T18:01:53.016Z","repository":{"id":288868054,"uuid":"969417135","full_name":"hunghg255/rsbuild-react-generate-pages","owner":"hunghg255","description":"A rsbuild plugin generates pages for React applications.","archived":false,"fork":false,"pushed_at":"2025-04-20T05:14:17.000Z","size":0,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-20T05:22:25.832Z","etag":null,"topics":["generate-pages","react","react-router-dom","rsbuild"],"latest_commit_sha":null,"homepage":"","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/hunghg255.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","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,"zenodo":null},"funding":{"github":["hunghg255"]}},"created_at":"2025-04-20T05:09:37.000Z","updated_at":"2025-04-20T05:14:20.000Z","dependencies_parsed_at":"2025-04-20T05:32:43.158Z","dependency_job_id":null,"html_url":"https://github.com/hunghg255/rsbuild-react-generate-pages","commit_stats":null,"previous_names":["hunghg255/rsbuild-react-generate-pages"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hunghg255%2Frsbuild-react-generate-pages","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hunghg255%2Frsbuild-react-generate-pages/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hunghg255%2Frsbuild-react-generate-pages/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hunghg255%2Frsbuild-react-generate-pages/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hunghg255","download_url":"https://codeload.github.com/hunghg255/rsbuild-react-generate-pages/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250487526,"owners_count":21438612,"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","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":["generate-pages","react","react-router-dom","rsbuild"],"created_at":"2025-04-23T18:00:43.521Z","updated_at":"2025-04-23T18:01:53.003Z","avatar_url":"https://github.com/hunghg255.png","language":"TypeScript","funding_links":["https://github.com/sponsors/hunghg255"],"categories":["Plugins"],"sub_categories":["Rsbuild Plugins"],"readme":"\u003cp align=\"center\"\u003e\n\u003ca href=\"https://www.npmjs.com/package/rsbuild-react-generate-pages\" target=\"_blank\" rel=\"noopener noreferrer\"\u003e\n\u003cimg src=\"https://api.iconify.design/solar:routing-line-duotone.svg?color=%238a7aff\" alt=\"logo\" width='100'/\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  A rsbuild plugin generates pages for React applications.\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://www.npmjs.com/package/rsbuild-react-generate-pages\" target=\"_blank\" rel=\"noopener noreferrer\"\u003e\u003cimg src=\"https://badge.fury.io/js/rsbuild-react-generate-pages.svg\" alt=\"NPM Version\" /\u003e\u003c/a\u003e\n  \u003ca href=\"https://www.npmjs.com/package/rsbuild-react-generate-pages\" target=\"_blank\" rel=\"noopener noreferrer\"\u003e\u003cimg src=\"https://img.shields.io/npm/dt/rsbuild-react-generate-pages.svg?logo=npm\" alt=\"NPM Downloads\" /\u003e\u003c/a\u003e\n  \u003ca href=\"https://bundlephobia.com/result?p=rsbuild-react-generate-pages\" target=\"_blank\" rel=\"noopener noreferrer\"\u003e\u003cimg src=\"https://img.shields.io/bundlephobia/minzip/rsbuild-react-generate-pages\" alt=\"Minizip\" /\u003e\u003c/a\u003e\n  \u003ca href=\"https://github.com/hunghg255/rsbuild-react-generate-pages/graphs/contributors\" target=\"_blank\" rel=\"noopener noreferrer\"\u003e\u003cimg src=\"https://img.shields.io/badge/all_contributors-1-orange.svg\" alt=\"Contributors\" /\u003e\u003c/a\u003e\n  \u003ca href=\"https://github.com/hunghg255/rsbuild-react-generate-pages/blob/main/LICENSE\" target=\"_blank\" rel=\"noopener noreferrer\"\u003e\u003cimg src=\"https://badgen.net/github/license/hunghg255/rsbuild-react-generate-pages\" alt=\"License\" /\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n## 📦 Installation\n\n```bash\nnpm install rsbuild-react-generate-pages -D\n```\n\n## 🦄 Usage\n\n### Configuration `rsbuild.config.ts`\n\n```ts\nimport { defineConfig } from '@rsbuild/core';\nimport { pluginReact } from '@rsbuild/plugin-react';\nimport { pluginReactGeneratePages} from 'rsbuild-react-generate-pages';\n\nexport default defineConfig({\n  plugins: [pluginReactGeneratePages(), pluginReact()],\n});\n```\n\n## Overview\n\nBy default a page is a\n[React Router lazy component](https://reactrouter.com/en/main/route/lazy)\nexported from a `.tsx`, `.jsx`, `.ts`, `.js` file in the `src/pages` directory.\n\nYou can access the generated routes by importing the `~pages` module in your\napplication.\n\n```tsx\nimport ReactDOM from 'react-dom/client'\nimport { RouterProvider, createBrowserRouter } from 'react-router-dom'\n\nimport routes from '~pages'\n\nReactDOM.createRoot(document.getElementById('root') as HTMLElement).render(\n  \u003cRouterProvider router={createBrowserRouter(routes)} /\u003e\n)\n```\n\n**Type**\n\n```ts\n// env.d.ts\n/// \u003creference types=\"rsbuild-react-generate-pages/client\" /\u003e\n```\n\n## Route Style\n\n- `layout.{tsx,jsx,ts,js}` =\u003e layout page\n- `page.{tsx,jsx,ts,js}` =\u003e index page\n- `404.{tsx,jsx,ts,js}` =\u003e not found page\n- `_lib` =\u003e private folder (underscore prefix)\n- `(layout)` =\u003e\n  [Layout Routes](https://reactrouter.com/en/main/route/route#layout-routes)\n- `[id]` =\u003e `:id`\n  [Dynamic Segments](https://reactrouter.com/en/main/route/route#dynamic-segments)\n- `[[id]]` =\u003e `:id?`\n  [Optional Segments](https://reactrouter.com/en/main/route/route#optional-segments)\n- `[...slug]` =\u003e `*`\n  [Splats](https://reactrouter.com/en/main/route/route#splats)\n- `{task}` =\u003e `task?`\n  [Optional Static Segments](https://reactrouter.com/en/main/route/route#dynamic-segments)\n\n**Example:**\n\n[exmaple](/playground)\n\n```bash\n# folder structure\nsrc/pages/\n├── (dashboard)\n│   ├── [...slug]\n│   │   └── page.tsx\n│   ├── posts\n│   │   ├── [id]\n│   │   │   └── page.tsx\n│   │   └── page.tsx\n│   ├── layout.tsx\n│   └── page.tsx\n├── about\n│   └── [[lang]]\n│       └── page.tsx\n├── 404.tsx\n├── layout.tsx\n└── page.tsx\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhunghg255%2Frsbuild-react-generate-pages","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhunghg255%2Frsbuild-react-generate-pages","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhunghg255%2Frsbuild-react-generate-pages/lists"}