feat!: rebuild Ray Template as a monorepo

Share workspace packages between Ray Admin and the interactive docs.

BREAKING CHANGE: v6 is a new major line. v5 stays on legacy/v5.
This commit is contained in:
XiaoDaiGua-Ray 2026-11-04 14:01:28 +08:00
parent 6f095b763e
commit 403fdd589a
800 changed files with 8303 additions and 1812 deletions

View File

@ -5,3 +5,7 @@ node_modules
dist
.ai-local
.harness-local
**/node_modules
**/.vitepress/cache
**/.vitepress/dist

View File

@ -28,7 +28,7 @@ jobs:
- uses: pnpm/action-setup@v6.1.0
- name: Install dependencies
run: pnpm install --frozen-lockfile
- name: Validate harness, typecheck, lint, format, test and build
- name: Check the app and documentation workspace
run: pnpm check
deploy:
@ -45,10 +45,11 @@ jobs:
node-version-file: .nvmrc
- uses: pnpm/action-setup@v6.1.0
- run: pnpm install --frozen-lockfile
- run: pnpm build
- run: pnpm pages:build
env:
RAY_TEMPLATE_SITE_ORIGIN: ${{ github.repository == 'XiaoDaiGua-Ray/ray-template' && 'https://xiaodaigua-ray.github.io' || vars.RAY_TEMPLATE_SITE_ORIGIN }}
RAY_TEMPLATE_SOURCE_REF: ${{ github.sha }}
- uses: JamesIves/github-pages-deploy-action@v4.9.0
with:
branch: dist
folder: dist/production
folder: dist/pages

1
.gitignore vendored
View File

@ -34,3 +34,4 @@ coverage/
.env.*.local
.ai-local/
.harness-local/
apps/docs/.vitepress/cache/

View File

@ -1,4 +1,6 @@
dist/*
apps/docs/.vitepress/cache/
apps/docs/.vitepress/dist/
node_modules/*
auto-imports.d.ts
components.d.ts
@ -14,5 +16,5 @@ coverage/
.ai-local/
.harness-local/
CHANGELOG.md
src/icons/
src/app-config/echart-themes/
packages/icons/src/
packages/ui/src/RChart/src/themes/

View File

@ -1,4 +1,10 @@
## Unreleased(2026-11-02)
## 6.0.0(待发布)
- **破坏性版本变更**:Ray Admin、官网文档和共享包改为 Monorepo。v6 不提供 v5 的原地升级,旧版代码保留在 [legacy/v5](https://github.com/XiaoDaiGua-Ray/ray-template/tree/legacy/v5)。详见[版本分界](apps/docs/migration.md)。
- 后台迁到 `apps/admin/`,共享组件、Hooks、指令、图标、路由、请求、布局和工具拆成八个 workspace 包。文档通过公共入口复用同一套能力。
- 增加 TablePro、布局、条码、精度、路由校验、防抖和全屏的页内演示。`pnpm pages:build` 组装 Ray Admin 与官网文档。[v6 架构指南](apps/docs/guide/architecture.md)
## v5 主线后续记录(`legacy/v5`)
### Feats

View File

@ -1,8 +1,7 @@
FROM node:26.13.0-bookworm-slim
WORKDIR /app
RUN npm install --global pnpm@12.16.1
COPY package.json pnpm-lock.yaml pnpm-workspace.yaml .npmrc ./
RUN HUSKY=0 pnpm install --frozen-lockfile
COPY . .
RUN HUSKY=0 pnpm install --frozen-lockfile
EXPOSE 9527
CMD ["pnpm", "dev", "--host", "0.0.0.0"]

View File

@ -1,9 +1,13 @@
# Ray Template · Vue 3 Admin Dashboard Template
[简体中文](README.zh-CN.md) · **[Live demo](https://xiaodaigua-ray.github.io/ray-template/)** · **[Documentation](https://xiaodaigua-ray.github.io/ray-template-doc/)** · [Quick start](#quick-start)
[简体中文](README.zh-CN.md) · **[Live demo](https://xiaodaigua-ray.github.io/ray-template/)** · **[Documentation](https://xiaodaigua-ray.github.io/ray-template/docs/)** · [Quick start](#quick-start)
Ray Template is an **open-source, ready-to-run frontend template** for admin dashboards, back-office tools, and internal apps. Run the demo to try a workspace with role-based menus and page tabs, then reuse TablePro list pages, workspace layouts, and route modules in your own app.
**Ray Template 6.0.0 starts a new major version.** It organizes Ray Admin, the documentation site, and reusable packages in one workspace. v6 does not offer an in-place upgrade from v5 or guarantee compatibility with v5 imports, APIs, deployment settings, or browser data. Existing projects can stay on [legacy/v5](https://github.com/XiaoDaiGua-Ray/ray-template/tree/legacy/v5), the final v5 main snapshot at `6f095b7` with manifest version `5.2.5`, or use the existing [v5.2.4 tag](https://github.com/XiaoDaiGua-Ray/ray-template/tree/v5.2.4).
[v6 architecture and adoption guide](apps/docs/guide/architecture.md) · [Version boundaries](apps/docs/migration.md)
**Stack**: Vue 3 · TypeScript / TSX · Naive UI · Vue Router · Pinia · Vue I18n · Vite / Rolldown · Axios · Vitest
[![Ray Template's TablePro people directory with search, pagination, column settings, and sidebar navigation](docs/assets/tablepro-preview.jpg)](https://xiaodaigua-ray.github.io/ray-template/)
@ -20,7 +24,7 @@ Use `RTablePro` with `bare` for a plain table, or add search, pagination, and a
- **Long lists and column controls**: Fill the available workspace and use virtual scrolling for large lists. Users can show, hide, reorder, or pin columns. Set `columnStateKey` to remember hidden columns across reloads.
- **CSV and printing**: Export or print the current page's visible data columns by default. Point printing at a custom region for documents that need their own layout.
[TablePro API and data contract](src/components/RTablePro/README.md)
[TablePro API and data contract](packages/ui/src/RTablePro/README.md)
### A configurable workspace
@ -28,19 +32,19 @@ Switch between sidebar, top, and mixed navigation. Narrow screens use a menu dra
Page tabs keep multiple tasks open, and breadcrumbs show where you are. Find menu items with `⌘/Ctrl + K`, and switch between light and dark themes or English and Simplified Chinese.
[Layout playground source](src/views/demo/layout-demo.tsx) · [Layout configuration and slots](src/layout/README.md)
[Layout playground source](apps/admin/src/views/demo/layout-demo.tsx) · [Layout configuration and slots](apps/admin/src/layout/README.md)
### Route modules connect pages, menus, and permissions
Declare a page in `src/router/modules` to generate its navigation and breadcrumbs. Route metadata controls menu labels and icons, roles, visibility, and `keepAlive`. Detail pages can extend the breadcrumb while keeping the current menu and tab. Role checks cover both menu filtering and direct navigation. Connect your backend to validate sessions and authorize API requests.
Declare a page in `apps/admin/src/router/modules` to generate its navigation and breadcrumbs. Route metadata controls menu labels and icons, roles, visibility, and `keepAlive`. Detail pages can extend the breadcrumb while keeping the current menu and tab. Role checks cover both menu filtering and direct navigation. Connect your backend to validate sessions and authorize API requests.
[Routing guide](src/router/README.md) · [Nested navigation and caching example](src/router/modules/demo/multi-menu.ts)
[Routing guide](apps/admin/src/router/README.md) · [Nested navigation and caching example](apps/admin/src/router/modules/demo/multi-menu.ts)
### Reusable components, composables, and SVG icons
- **Components**: Start with `RForm` and `RModal` for forms and dialogs. `RChart` manages ECharts initialization, resizing, and theme changes. The demo also includes LogicFlow diagrams, barcodes, and draggable cards. [Component guide](src/components/README.md)
- **Composables**: Template hooks cover page refresh, content maximization, menu badges, and watermarks. Web hooks demonstrate screenshots, printing, and element fullscreen. The examples include expandable usage code. [Composables and examples](src/hooks/README.md)
- **SVG icons**: Add an SVG to a group under `src/icons` to generate typed names and sprites. Routes and `RIcon` share names such as `navigation/dashboard`. The icon gallery lets you browse by group and copy TSX usage. [SVG icon workflow](src/icons/A_README.md)
- **Components**: Start with `RForm` and `RModal` for forms and dialogs. `RChart` manages ECharts initialization, resizing, and theme changes. The demo also includes LogicFlow diagrams, barcodes, and draggable cards. [Component guide](apps/admin/src/components/README.md)
- **Composables**: Template hooks cover page refresh, content maximization, menu badges, and watermarks. Web hooks demonstrate screenshots, printing, and element fullscreen. The examples include expandable usage code. [Composables and examples](apps/admin/src/hooks/README.md)
- **SVG icons**: Add an SVG to a group under `packages/icons/src` to generate typed names and sprites. Routes and `RIcon` share names such as `navigation/dashboard`. The icon gallery lets you browse by group and copy TSX usage. [SVG icon workflow](packages/icons/src/A_README.md)
## Quick start
@ -58,46 +62,30 @@ pnpm dev
Open [http://127.0.0.1:9527/ray-template/](http://127.0.0.1:9527/ray-template/) or use the URL printed by Vite. The prefilled demo sign-in and mock data let you run the template before connecting a backend.
Run `pnpm docs:dev` to develop the [documentation and interactive examples](apps/docs/README.md) from the same checkout.
## Project structure
```text
.
├── src/
│ ├── main.ts # Bootstraps the app, router, state, and i18n
│ ├── App.tsx # Root component with global providers and layout
│ ├── views/ # Sign-in, dashboard, business pages, and demos
│ │ └── demo/ # TablePro, layout playground, and hook examples
│ ├── router/
│ │ └── modules/ # Page routes, menu metadata, and roles
│ ├── layout/ # Navigation, page tabs, breadcrumbs, and content
│ ├── components/ # Shared UI exported through @/components
│ ├── app-components/ # App-specific UI and global providers
│ ├── api/ # API functions grouped by feature
│ ├── axios/ # HTTP client, interceptors, and cancellation
│ ├── store/ # Pinia modules and access methods
│ ├── hooks/ # Template, component, and browser composables
│ ├── app-config/ # App, routing, theme, and language settings
│ ├── locales/ # English and Simplified Chinese messages
│ ├── icons/ # Grouped SVG sources and generated manifest
│ ├── styles/ # Global styles, design tokens, and theme overrides
│ ├── directives/ # Global Vue directives
│ ├── types/ # Shared types and declarations
│ ├── utils/ # Shared utility functions
│ └── demo-data/ # Sample data for mock APIs and the static demo
├── mock/ # Mock endpoints for local development
├── public/ # Static assets copied into the build as is
├── vite-helper/ # Build helpers for icons, CDN, and SEO
├── vite.config.ts # Vite entry for development and builds
├── vite.custom.config.ts # Deployment base, dev proxy, and build options
├── tsconfig.json # References the app, Node, and test TS projects
├── package.json # Dependencies, runtime versions, and commands
├── scripts/ # Environment checks and icon generation
├── __test__/ # Vitest suites and test utilities
├── harness/ # Task scopes, targeted checks, and report generation
├── .github/workflows/ # CI checks and GitHub Pages deployment
└── docs/ # Architecture, design, and engineering conventions
ray-template/
├── apps/
│ ├── admin/ # Ray Admin: pages, sessions, permissions, env and mocks
│ └── docs/ # VitePress: guides, API reference and live examples
├── packages/
│ ├── admin-shell/ # Layout, navigation, tabs, settings and transitions
│ ├── ui/ # TablePro, RBarcode, RChart and other shared components
│ ├── composables/ # Reusable Vue composables and browser helpers
│ ├── directives/ # Vue directives
│ ├── icons/ # SVG assets, icon names and manifest
│ ├── routing/ # Route schemas, validation and menu helpers
│ ├── http/ # HTTP clients, interceptors and request cancellation
│ └── utils/ # Precision, object and storage utilities
├── harness/ # Regression checks and local reports
└── pnpm-lock.yaml # Shared workspace lockfile
```
Ray Admin starts in `apps/admin/src/main.ts`. Its `App.tsx` supplies theme, translations, icons, and column preference storage. Shared packages expose public entry points through `exports`. The documentation runs the same packages. The [TablePro demo](apps/docs/reference/table-pro.md) uses simulated requests to show cancellation and retry, while the [layout playground](apps/docs/guide/layout.md) runs with its own in-memory router.
See the [architecture map](docs/architecture.md) for how these modules work together.
## Build your first business page
@ -106,7 +94,7 @@ This small people directory uses the template's mock query function. To adapt it
```tsx
import { getPersonList } from '@/api/demo/mock/person'
import { RTablePro } from '@/components'
import { RTablePro } from '@ray-template/ui/table-pro'
import { defineComponent } from 'vue'
export default defineComponent({
@ -126,9 +114,9 @@ export default defineComponent({
})
```
1. **Build the view.** Add a page in `src/views`. The [remote table example](src/views/demo/tables/remote.tsx) shows sorting, row selection, and toolbar actions.
2. **Connect navigation.** Add a route in `src/router/modules` and give its menu entry English and Simplified Chinese labels. Follow the [routing guide](src/router/README.md) when setting up page caching.
3. **Connect your data.** Define your API in `src/api`, use `src/axios` for interceptors and request cancellation, and connect your real sign-in and session. The people directory uses a mock HTTP endpoint in development and sample data in the static preview. [Request layer guide](src/axios/README.md)
1. **Build the view.** Add a page in `apps/admin/src/views`. The [remote table example](apps/admin/src/views/demo/tables/remote.tsx) shows sorting, row selection, and toolbar actions.
2. **Connect navigation.** Add a route in `apps/admin/src/router/modules` and give its menu entry English and Simplified Chinese labels. Follow the [routing guide](apps/admin/src/router/README.md) when setting up page caching.
3. **Connect your data.** Define your API in `apps/admin/src/api`, use `apps/admin/src/axios` for interceptors and request cancellation, and connect your real sign-in and session. The people directory uses a mock HTTP endpoint in development and sample data in the static preview. [Request layer guide](apps/admin/src/axios/README.md)
## Checks, builds, and deployment
@ -140,6 +128,8 @@ export default defineComponent({
| `pnpm harness verify` | Run the full check and save a local report, or pass a scope to run targeted checks |
| `pnpm build` / `pnpm preview` | Build into `dist/production` or serve the build locally |
`pnpm docs:build` builds the documentation separately. `pnpm pages:build` assembles both builds under `dist/pages` for `/ray-template/` and `/ray-template/docs/`.
Use the [architecture map](docs/architecture.md) to find module and configuration entry points. See the [deployment guide](docs/architecture.md#deployment-and-search-discovery) for root or subpath hosting and search metadata. Contributors and coding agents share the instructions in [AGENTS.md](AGENTS.md) and the [AI Harness](harness/README.md).
[MIT License](LICENSE) · [Changelog](CHANGELOG.md) · [Issues](https://github.com/XiaoDaiGua-Ray/ray-template/issues)

View File

@ -1,9 +1,13 @@
# Ray Template · Vue 3 中后台管理模板
[English](README.md) · **[在线演示](https://xiaodaigua-ray.github.io/ray-template/)** · **[在线文档](https://xiaodaigua-ray.github.io/ray-template-doc/)** · [快速开始](#快速开始)
[English](README.md) · **[在线演示](https://xiaodaigua-ray.github.io/ray-template/)** · **[在线文档](https://xiaodaigua-ray.github.io/ray-template/docs/)** · [快速开始](#快速开始)
Ray Template 是一套**开箱即用的中后台前端模板**,适合搭建管理后台、运营工作台和内部工具。克隆后即可体验带权限菜单和多标签页的工作台,也可以直接把 TablePro 列表页、布局和路由模块用在业务里。
**Ray Template 6.0.0 是新的主版本。** v6 以 Monorepo 组织 Ray Admin、官网文档和共享包。它不承诺兼容 v5 的内部导入、接口、部署配置或浏览器数据,也不提供原地升级。现有 v5 项目可以继续使用 [legacy/v5](https://github.com/XiaoDaiGua-Ray/ray-template/tree/legacy/v5)(最后的 v5 主线快照 `6f095b7`,清单版本 `5.2.5`),或使用已打标签的 [v5.2.4](https://github.com/XiaoDaiGua-Ray/ray-template/tree/v5.2.4)。
[版本分界与接入说明](apps/docs/migration.md) · [v6 架构指南](apps/docs/guide/architecture.md)
**技术栈**:Vue 3 · TypeScript / TSX · Naive UI · Vue Router · Pinia · Vue I18n · Vite / Rolldown · Axios · Vitest
[![Ray Template 的 TablePro 人员列表,展示查询表单、分页、列设置及侧栏导航](docs/assets/tablepro-preview.jpg)](https://xiaodaigua-ray.github.io/ray-template/)
@ -20,7 +24,7 @@ Ray Template 是一套**开箱即用的中后台前端模板**,适合搭建管
- **长列表和列设置**:表格可填充工作区,配合虚拟滚动;用户可调整列的显示、顺序和固定位置,通过 `columnStateKey` 跨刷新记住隐藏列。
- **导出与打印**:默认导出和打印当前页的可见数据列。报表、单据等独立排版可指定自定义打印区域。
[TablePro 用法与数据契约](src/components/RTablePro/README.md)
[TablePro 用法与数据契约](packages/ui/src/RTablePro/README.md)
### 应用外壳:适配不同的后台工作方式
@ -28,19 +32,19 @@ Ray Template 是一套**开箱即用的中后台前端模板**,适合搭建管
标签页可在多个页面之间切换,面包屑标示当前位置,用 `⌘/Ctrl + K` 可以查找菜单。全局提供明暗主题和中英文切换。
[布局实验室源码](src/views/demo/layout-demo.tsx) · [布局配置与插槽](src/layout/README.md)
[布局实验室源码](apps/admin/src/views/demo/layout-demo.tsx) · [布局配置与插槽](apps/admin/src/layout/README.md)
### 路由模块:把页面、菜单与权限放在同一处配置
在 `src/router/modules` 声明页面,模板按路由配置生成菜单和面包屑。路由 `meta` 可以配置菜单文案与图标、角色、显示条件和 `keepAlive`。从列表进入详情时,可以保留当前菜单和标签页,只在面包屑中补充详情层级。角色配置同时用于菜单过滤和直接导航时的守卫。接入业务时,由后端校验会话与接口权限。
在 `apps/admin/src/router/modules` 声明页面,模板按路由配置生成菜单和面包屑。路由 `meta` 可以配置菜单文案与图标、角色、显示条件和 `keepAlive`。从列表进入详情时,可以保留当前菜单和标签页,只在面包屑中补充详情层级。角色配置同时用于菜单过滤和直接导航时的守卫。接入业务时,由后端校验会话与接口权限。
[路由与菜单约定](src/router/README.md) · [多级菜单与缓存示例](src/router/modules/demo/multi-menu.ts)
[路由与菜单约定](apps/admin/src/router/README.md) · [多级菜单与缓存示例](apps/admin/src/router/modules/demo/multi-menu.ts)
### 组件、Hooks 与图标:从可运行的示例里复用
- **组件**:`RForm` 和 `RModal` 用于表单和弹窗场景,`RChart` 封装 ECharts 实例的初始化、尺寸与主题同步;另有 LogicFlow 流程图、条形码和拖拽卡片示例。[组件入口与约定](src/components/README.md)
- **Hooks**:模板 Hooks 处理页面刷新、内容最大化、菜单标记和水印;Web Hooks 展示截图、打印和元素全屏。交互示例提供可展开的用法代码。[Hooks 示例](src/hooks/README.md)
- **SVG**:把文件放入 `src/icons` 的对应分包即可生成类型提示和雪碧图。路由和 `RIcon` 使用同一套完整名称,例如 `navigation/dashboard`,图标库可按分包查找并复制 TSX 用法。[图标生成与使用](src/icons/A_README.md)
- **组件**:`RForm` 和 `RModal` 用于表单和弹窗场景,`RChart` 封装 ECharts 实例的初始化、尺寸与主题同步;另有 LogicFlow 流程图、条形码和拖拽卡片示例。[组件入口与约定](apps/admin/src/components/README.md)
- **Hooks**:模板 Hooks 处理页面刷新、内容最大化、菜单标记和水印;Web Hooks 展示截图、打印和元素全屏。交互示例提供可展开的用法代码。[Hooks 示例](apps/admin/src/hooks/README.md)
- **SVG**:把文件放入 `packages/icons/src` 的对应分包即可生成类型提示和雪碧图。路由和 `RIcon` 使用同一套完整名称,例如 `navigation/dashboard`,图标库可按分包查找并复制 TSX 用法。[图标生成与使用](packages/icons/src/A_README.md)
## 快速开始
@ -58,46 +62,30 @@ pnpm dev
打开 [http://127.0.0.1:9527/ray-template/](http://127.0.0.1:9527/ray-template/),或使用 Vite 输出的地址。预填的演示账号可直接登录,本地开发无需先搭建业务后端。
在同一个仓库运行 `pnpm docs:dev`,可维护[读者文档和页内交互示例](apps/docs/README.md)。
## 工程结构
```text
.
├── src/
│ ├── main.ts # 初始化应用、路由、状态和国际化
│ ├── App.tsx # 根组件,挂载全局 Provider 与布局
│ ├── views/ # 登录页、工作台、业务页面和交互示例
│ │ └── demo/ # TablePro、布局实验室、Hooks 等示例
│ ├── router/
│ │ └── modules/ # 页面路由、菜单元数据与角色配置
│ ├── layout/ # 导航、标签页、面包屑与内容区
│ ├── components/ # 通用组件,统一从 @/components 导入
│ ├── app-components/ # 与应用状态绑定的组件和全局 Provider
│ ├── api/ # 按业务组织的接口函数
│ ├── axios/ # 请求实例、拦截器与取消机制
│ ├── store/ # Pinia 状态模块与访问方法
│ ├── hooks/ # 模板、组件和 Web 相关的组合式函数
│ ├── app-config/ # 应用、路由、主题与语言配置
│ ├── locales/ # 中英文语言包与加载逻辑
│ ├── icons/ # 分包 SVG 源文件与生成清单
│ ├── styles/ # 全局样式、设计变量与主题覆盖
│ ├── directives/ # 全局指令
│ ├── types/ # 共享类型与声明
│ ├── utils/ # 通用工具函数
│ └── demo-data/ # Mock 和静态演示共用的样例数据
├── mock/ # 开发环境 Mock 接口
├── public/ # 构建时原样复制的静态资源
├── vite-helper/ # 图标、CDN 和 SEO 等构建辅助
├── vite.config.ts # Vite 开发与构建入口
├── vite.custom.config.ts # 部署路径、开发代理和构建选项
├── tsconfig.json # 引用应用、Node 与测试的 TS 配置
├── package.json # 依赖、运行时版本与项目命令
├── scripts/ # 环境检查与图标生成
├── __test__/ # Vitest 测试与测试工具
├── harness/ # 任务域说明、定向验证与报告生成
├── .github/workflows/ # CI 检查与 GitHub Pages 部署
└── docs/ # 架构、设计与工程约定
ray-template/
├── apps/
│ ├── admin/ # Ray Admin:业务页面、会话、权限、环境文件和 Mock
│ └── docs/ # VitePress:官网、API 参考和交互示例
├── packages/
│ ├── admin-shell/ # 布局、导航、标签、设置和路由过渡
│ ├── ui/ # TablePro、RBarcode、RChart 等共享组件
│ ├── composables/ # 独立的 Vue Hooks 和浏览器工具
│ ├── directives/ # Vue 指令
│ ├── icons/ # SVG 资源、名称类型和清单
│ ├── routing/ # 路由配置契约、校验和菜单处理
│ ├── http/ # 请求客户端、拦截器和请求取消
│ └── utils/ # 精度运算、对象和存储工具
├── harness/ # 回归检查与报告
└── pnpm-lock.yaml # 工作区共用锁文件
```
Ray Admin 在 `apps/admin/src/main.ts` 初始化应用,在 `App.tsx` 注入主题、翻译、图标和列偏好存储。共享包通过 `exports` 提供入口。文档从相同入口运行真实示例;例如 [TablePro](apps/docs/reference/table-pro.md) 用模拟数据展示请求取消与失败重试,[布局实验](apps/docs/guide/layout.md) 使用独立的内存路由。
模块之间的调用关系见[架构地图](docs/architecture.md)。
## 从示例改出第一个业务页面
@ -106,7 +94,7 @@ pnpm dev
```tsx
import { getPersonList } from '@/api/demo/mock/person'
import { RTablePro } from '@/components'
import { RTablePro } from '@ray-template/ui/table-pro'
import { defineComponent } from 'vue'
export default defineComponent({
@ -126,9 +114,9 @@ export default defineComponent({
})
```
1. **写页面**。在 `src/views` 新建页面,参考[远端查询示例](src/views/demo/tables/remote.tsx)加入排序、行选择和工具栏。
2. **接入导航**。在 `src/router/modules` 添加路由,给菜单配置中英文文案。页面需要缓存时,参考[路由约定](src/router/README.md)配置路由与组件名称。
3. **替换演示数据**。从 `src/api` 接入业务接口,通过 `src/axios` 统一处理拦截与取消,再接入实际登录和会话。人员列表示例在开发时走 Mock HTTP,静态预览使用本地样例数据。[请求层说明](src/axios/README.md)
1. **写页面**。在 `apps/admin/src/views` 新建页面,参考[远端查询示例](apps/admin/src/views/demo/tables/remote.tsx)加入排序、行选择和工具栏。
2. **接入导航**。在 `apps/admin/src/router/modules` 添加路由,给菜单配置中英文文案。页面需要缓存时,参考[路由约定](apps/admin/src/router/README.md)配置路由与组件名称。
3. **替换演示数据**。从 `apps/admin/src/api` 接入业务接口,通过 `apps/admin/src/axios` 统一处理拦截与取消,再接入实际登录和会话。人员列表示例在开发时走 Mock HTTP,静态预览使用本地样例数据。[请求层说明](apps/admin/src/axios/README.md)
## 检查、构建与部署
@ -140,6 +128,8 @@ export default defineComponent({
| `pnpm harness verify` | 执行全量检查并保存本地报告,也可以指定任务域进行定向验证 |
| `pnpm build` / `pnpm preview` | 输出到 `dist/production`,或在本机预览构建 |
`pnpm docs:build` 单独构建文档。`pnpm pages:build` 组装后台与文档到 `dist/pages`,分别服务于 `/ray-template/` 和 `/ray-template/docs/`。
二次开发可从[架构地图](docs/architecture.md)定位配置与模块。部署到域名根目录或子路径、为公开站点启用搜索元数据时,参考[部署指南](docs/architecture.md#deployment-and-search-discovery)。人工和 AI 协作共用 [AGENTS.md](AGENTS.md) 与 [AI Harness](harness/README.md)。
[MIT 许可证](LICENSE) · [更新日志](CHANGELOG.md) · [问题反馈](https://github.com/XiaoDaiGua-Ray/ray-template/issues)

View File

@ -1,8 +1,8 @@
import { mount } from '@vue/test-utils'
import { createPinia, disposePinia, setActivePinia } from 'pinia'
import { nextTick } from 'vue'
import GlobalProvider from '../../src/app-components/provider/AppNaiveGlobalProvider'
import { piniaSettingStore } from '../../src/store/modules/setting'
import GlobalProvider from '../../apps/admin/src/app-components/provider/AppNaiveGlobalProvider'
import { piniaSettingStore } from '../../apps/admin/src/store/modules/setting'
it('reuses the global message instance across themes and removes its host on unmount', async () => {
const pinia = createPinia()

View File

@ -1,4 +1,4 @@
import { prefixCacheKey } from '../../src/utils/app/prefix-cache-key'
import { prefixCacheKey } from '../../apps/admin/src/utils/app/prefix-cache-key'
describe('prefixCacheKey', () => {
it('should return the key with the default prefix', () => {

View File

@ -1,6 +1,6 @@
import { expectTypeOf } from 'vitest'
import request from '../../src/axios/instance'
import type { AppRawRequestConfig } from '../../src/axios/types'
import request from '../../apps/admin/src/axios/instance'
import type { AppRawRequestConfig } from '../../apps/admin/src/axios/types'
const data = { id: 42, name: 'Ray' }
const adapter: AppRawRequestConfig['adapter'] = async (config) => ({

View File

@ -1,4 +1,4 @@
import { arrayBufferToBase64Image } from '../../src/utils/basic'
import { arrayBufferToBase64Image } from '../../apps/admin/src/utils/basic'
describe('arrayBufferToBase64Image', () => {
const arrayBuffer = new ArrayBuffer(8)

View File

@ -1,4 +1,4 @@
import { callWithAsyncErrorHandling } from '../../src/utils/basic'
import { callWithAsyncErrorHandling } from '../../apps/admin/src/utils/basic'
describe('callWithAsyncErrorHandling', () => {
it('should call the function and return the result', async () => {

View File

@ -1,4 +1,4 @@
import { callWithErrorHandling } from '../../src/utils/basic'
import { callWithErrorHandling } from '../../apps/admin/src/utils/basic'
describe('callWithErrorHandling', () => {
it('should call the function and return the result', () => {

View File

@ -1,4 +1,4 @@
import { detectOperatingSystem } from '../../src/utils/basic'
import { detectOperatingSystem } from '../../apps/admin/src/utils/basic'
describe('detectOperatingSystem', () => {
afterEach(() => vi.restoreAllMocks())

View File

@ -1,4 +1,4 @@
import { downloadAnyFile } from '../../src/utils/basic'
import { downloadAnyFile } from '../../apps/admin/src/utils/basic'
describe('downloadAnyFile', () => {
const url = 'blob:test'

View File

@ -1,4 +1,4 @@
import { downloadBase64File } from '../../src/utils/basic'
import { downloadBase64File } from '../../apps/admin/src/utils/basic'
describe('downloadBase64File', () => {
const base64 =

View File

@ -1,4 +1,4 @@
import { equalRouterPath } from '../../src/utils/basic'
import { equalRouterPath } from '../../apps/admin/src/utils/basic'
describe('equalRouterPath', () => {
it('compare paths with parameters', () => {

View File

@ -1,4 +1,4 @@
import { getAppEnvironment } from '../../src/utils/basic'
import { getAppEnvironment } from '../../apps/admin/src/utils/basic'
describe('getAppEnvironment', () => {
it('should return MODE is test', () => {

View File

@ -1,4 +1,4 @@
import { isAsyncFunction } from '../../src/utils/basic'
import { isAsyncFunction } from '../../apps/admin/src/utils/basic'
describe('isAsyncFunction', () => {
it('should return true if the function is async', () => {

View File

@ -1,4 +1,4 @@
import { isPromise } from '../../src/utils/basic'
import { isPromise } from '../../apps/admin/src/utils/basic'
describe('isPromise', () => {
it('should return true if the value is a Promise', () => {

View File

@ -1,4 +1,4 @@
import { isValueType } from '../../src/utils/basic'
import { isValueType } from '../../apps/admin/src/utils/basic'
describe('isValueType', () => {
it('should return true for string', () => {

View File

@ -1,4 +1,4 @@
import { uuid } from '../../src/utils/basic'
import { uuid } from '../../apps/admin/src/utils/basic'
describe('uuid', () => {
it('should return String', () => {

View File

@ -3,7 +3,7 @@ import {
hasStorage,
removeStorage,
setStorage,
} from '../../src/utils/cache'
} from '../../apps/admin/src/utils/cache'
describe('cache utils', () => {
const __DEMO__KEY = '__DEMO__KEY'

View File

@ -1,5 +1,5 @@
import { mount } from '@vue/test-utils'
import { RModal } from '../../src/components/RModal/index'
import { RModal } from '../../apps/admin/src/components/RModal/index'
describe('RModal', () => {
it('should execute the onAfterEnter callback', () => {

View File

@ -1,11 +1,11 @@
import { RTablePro } from '@/components/RTablePro'
import { useColumnVisibility } from '@/components/RTablePro/src/columns'
import ColumnSettings from '@/components/RTablePro/src/components/C'
import { prefixCacheKey } from '@/utils/app/prefix-cache-key'
import { mount } from '@vue/test-utils'
import { NDataTable, NTree } from 'naive-ui'
import type { DataTableColumn } from 'naive-ui'
import { effectScope, nextTick, ref, shallowRef } from 'vue'
import { useColumnVisibility } from '../../packages/ui/src/RTablePro/src/columns'
import ColumnSettings from '../../packages/ui/src/RTablePro/src/components/C'
const name = { key: 'name', title: 'Name' }
const email = { key: 'email', title: 'Email' }

View File

@ -1,9 +1,9 @@
import { RTablePro } from '@/components/RTablePro'
import type { TableProInst } from '@/components/RTablePro'
import { buildTableCsv } from '@/components/RTablePro/src/csv'
import * as printing from '@/components/RTablePro/src/printing'
import { mount } from '@vue/test-utils'
import type { DataTableColumn } from 'naive-ui'
import { buildTableCsv } from '../../packages/ui/src/RTablePro/src/csv'
import * as printing from '../../packages/ui/src/RTablePro/src/printing'
afterEach(() => vi.restoreAllMocks())

View File

@ -1,6 +1,6 @@
import { toJpeg } from 'html-to-image'
import print from 'print-js'
import { printDom } from '../../src/utils/dom'
import { printDom } from '../../apps/admin/src/utils/dom'
vi.mock('html-to-image', () => ({
toSvg: vi.fn(),

View File

@ -1,4 +1,4 @@
import { autoPrefixStyle } from '../../src/utils/element'
import { autoPrefixStyle } from '../../apps/admin/src/utils/element'
describe('autoPrefixStyle', () => {
it('should be defined', () => {

View File

@ -1,4 +1,8 @@
import { hasClass, removeClass, setClass } from '../../src/utils/element'
import {
hasClass,
removeClass,
setClass,
} from '../../apps/admin/src/utils/element'
import createRefElement from '../utils/createRefElement'
describe('setClass', () => {

View File

@ -1,4 +1,4 @@
import { colorToRgba } from '../../src/utils/element'
import { colorToRgba } from '../../apps/admin/src/utils/element'
describe('colorToRgba', () => {
it('should be defined', () => {

View File

@ -1,4 +1,4 @@
import { completeSize } from '../../src/utils/element'
import { completeSize } from '../../apps/admin/src/utils/element'
describe('completeSize', () => {
it('should be defined', () => {

View File

@ -1,4 +1,4 @@
import { queryElements } from '../../src/utils/element'
import { queryElements } from '../../apps/admin/src/utils/element'
describe('queryElements', () => {
const div = document.createElement('div')

View File

@ -1,4 +1,4 @@
import { removeStyle, setStyle } from '../../src/utils/element'
import { removeStyle, setStyle } from '../../apps/admin/src/utils/element'
import createRefElement from '../utils/createRefElement'
describe('setStyle', () => {

View File

@ -1,16 +1,16 @@
import { createMemoryHistory, createRouter } from 'vue-router'
import { useAppNavigation } from '../../src/hooks/template/useAppNavigation'
import type { AppMenuOption } from '../../src/types'
import { useAppNavigation } from '../../apps/admin/src/hooks/template/useAppNavigation'
import type { AppMenuOption } from '../../apps/admin/src/types'
const { state, menus } = vi.hoisted(() => ({
state: { router: void 0 as ReturnType<typeof createRouter> | undefined },
menus: [{ fullPath: '/parent', children: [{ fullPath: '/target' }] }],
}))
vi.mock('../../src/hooks/template/useVueRouter', () => ({
vi.mock('../../apps/admin/src/hooks/template/useVueRouter', () => ({
useVueRouter: () => ({ router: state.router }),
}))
vi.mock('../../src/store', () => ({
vi.mock('../../apps/admin/src/store', () => ({
useMenuGetters: () => ({ getMenuOptions: { value: menus } }),
}))

View File

@ -1,4 +1,4 @@
import { useAppRoot } from '../../src/hooks/template/useAppRoot'
import { useAppRoot } from '../../apps/admin/src/hooks/template/useAppRoot'
import setupMiniApp from '../utils/setupMiniApp'
describe('useAppRoot', async () => {

View File

@ -1,7 +1,7 @@
import { useBadge } from '../../src/hooks/template/useBadge'
import type { AppMenuExtraOptions } from '../../src/router/types'
import { depthSearchAppMenu, useMenuGetters } from '../../src/store'
import type { AppMenuOption } from '../../src/types'
import { useBadge } from '../../apps/admin/src/hooks/template/useBadge'
import type { AppMenuExtraOptions } from '../../apps/admin/src/router/types'
import { depthSearchAppMenu, useMenuGetters } from '../../apps/admin/src/store'
import type { AppMenuOption } from '../../apps/admin/src/types'
import setupMiniApp from '../utils/setupMiniApp'
describe('useBadge', async () => {

View File

@ -1,4 +1,4 @@
import { useContextmenuCoordinate } from '../../src/hooks/components/useContextmenuCoordinate'
import { useContextmenuCoordinate } from '../../apps/admin/src/hooks/components/useContextmenuCoordinate'
import createRefElement from '../utils/createRefElement'
import renderHook from '../utils/renderHook'

View File

@ -1,6 +1,6 @@
import dayjs from 'dayjs'
import { DEFAULT_DAYJS_LOCAL } from '../../src/app-config'
import { useDayjs } from '../../src/hooks/web/useDayjs'
import { DEFAULT_DAYJS_LOCAL } from '../../apps/admin/src/app-config'
import { useDayjs } from '../../apps/admin/src/hooks/web/useDayjs'
describe('useDayjs', () => {
const {

View File

@ -1,4 +1,4 @@
import { useDevice } from '../../src/hooks/web/useDevice'
import { useDevice } from '../../apps/admin/src/hooks/web/useDevice'
describe('useDevice', () => {
const addEventListenerSpy = vi.spyOn(window, 'addEventListener')

View File

@ -1,5 +1,5 @@
import { toBlob, toPng } from 'html-to-image'
import { useDomToImage } from '../../src/hooks/web/useDomToImage'
import { useDomToImage } from '../../apps/admin/src/hooks/web/useDomToImage'
vi.mock('html-to-image', () => ({
toSvg: vi.fn(),

View File

@ -1,4 +1,4 @@
import { useElementFullscreen } from '../../src/hooks/web/useElementFullscreen'
import { useElementFullscreen } from '../../apps/admin/src/hooks/web/useElementFullscreen'
// Happy DOM 验证状态与样式恢复;实际布局和动画仍需在浏览器验收。
describe('useElementFullscreen', () => {

View File

@ -1,6 +1,6 @@
import { ref } from 'vue'
import type { Ref } from 'vue'
import { useI18n } from '../../src/hooks/web/useI18n'
import { useI18n } from '../../apps/admin/src/hooks/web/useI18n'
const { state } = vi.hoisted(() => ({
state: {
@ -16,7 +16,7 @@ const { state } = vi.hoisted(() => ({
},
}))
vi.mock('../../src/locales', () => ({
vi.mock('../../apps/admin/src/locales', () => ({
get i18n() {
return state.instance
},
@ -62,7 +62,7 @@ it('forwards interpolation and leaves plain text and route keys untouched', asyn
state.instance!.global.t = native
const { t: translate } = useI18n()
const { t } = await import('../../src/hooks/template/useI18n')
const { t } = await import('../../apps/admin/src/hooks/template/useI18n')
expect(translate('Already readable')).toBe('Already readable')
expect(t('menu.Dashboard')).toBe('menu.Dashboard')

View File

@ -1,8 +1,11 @@
import type { LayoutInst } from 'naive-ui'
import type { Ref } from 'vue'
import { LAYOUT_CONTENT_REF, LAYOUT_SIDER_REF } from '../../src/app-config'
import { useContentScroll } from '../../src/hooks/template/useContentScroll'
import { useSiderScroll } from '../../src/hooks/template/useSiderScroll'
import {
LAYOUT_CONTENT_REF,
LAYOUT_SIDER_REF,
} from '../../apps/admin/src/app-config'
import { useContentScroll } from '../../apps/admin/src/hooks/template/useContentScroll'
import { useSiderScroll } from '../../apps/admin/src/hooks/template/useSiderScroll'
describe.each([
[useContentScroll, LAYOUT_CONTENT_REF],

View File

@ -1,7 +1,7 @@
import { createPinia, disposePinia, setActivePinia } from 'pinia'
import { nextTick } from 'vue'
import { useMaximize } from '../../src/hooks/template/useMaximize'
import { piniaRuntimeStore } from '../../src/store/modules/runtime'
import { useMaximize } from '../../apps/admin/src/hooks/template/useMaximize'
import { piniaRuntimeStore } from '../../apps/admin/src/store/modules/runtime'
it('shares maximize state across callers and cancels stale completion callbacks', async () => {
const pinia = createPinia()

View File

@ -1,4 +1,4 @@
import { usePagination } from '../../src/hooks/web/usePagination'
import { usePagination } from '../../apps/admin/src/hooks/web/usePagination'
describe('usePagination', () => {
let count = 0

View File

@ -1,5 +1,5 @@
import print from 'print-js'
import { usePrint } from '../../src/hooks/web/usePrint'
import { usePrint } from '../../apps/admin/src/hooks/web/usePrint'
vi.mock('print-js', () => ({ default: vi.fn() }))

View File

@ -1,8 +1,11 @@
import { useAppRoot } from '../../src/hooks/template/useAppRoot'
import { useSiderBar } from '../../src/hooks/template/useSiderBar'
import { useVueRouter } from '../../src/hooks/web/useVueRouter'
import { useMenuActions, useMenuGetters } from '../../src/store'
import type { AppMenuOption, MenuTagOptions } from '../../src/types/modules/app'
import { useAppRoot } from '../../apps/admin/src/hooks/template/useAppRoot'
import { useSiderBar } from '../../apps/admin/src/hooks/template/useSiderBar'
import { useVueRouter } from '../../apps/admin/src/hooks/web/useVueRouter'
import { useMenuActions, useMenuGetters } from '../../apps/admin/src/store'
import type {
AppMenuOption,
MenuTagOptions,
} from '../../apps/admin/src/types/modules/app'
import setupMiniApp from '../utils/setupMiniApp'
describe('useSiderBar', async () => {

View File

@ -1,6 +1,6 @@
import { createPinia, disposePinia, setActivePinia } from 'pinia'
import { useSpinning } from '../../src/hooks/template/useSpinning'
import { piniaRuntimeStore } from '../../src/store/modules/runtime'
import { useSpinning } from '../../apps/admin/src/hooks/template/useSpinning'
import { piniaRuntimeStore } from '../../apps/admin/src/store/modules/runtime'
describe('useSpinning', () => {
let pinia: ReturnType<typeof createPinia>

View File

@ -1,5 +1,5 @@
import { useTheme } from '../../src/hooks/template/useTheme'
import { useSettingGetters } from '../../src/store'
import { useTheme } from '../../apps/admin/src/hooks/template/useTheme'
import { useSettingGetters } from '../../apps/admin/src/store'
import setupMiniApp from '../utils/setupMiniApp'
describe('useTheme', async () => {

View File

@ -1,5 +1,5 @@
import { useVueRouter } from '../../src/hooks/web/useVueRouter'
import { router } from '../../src/router'
import { useVueRouter } from '../../apps/admin/src/hooks/web/useVueRouter'
import { router } from '../../apps/admin/src/router'
it('shares the live router outside setup and exposes the current route after navigation', async () => {
const a = useVueRouter()

View File

@ -1,5 +1,5 @@
import { useWatermark } from '../../src/hooks/template/useWatermark'
import { useSettingGetters } from '../../src/store'
import { useWatermark } from '../../apps/admin/src/hooks/template/useWatermark'
import { useSettingGetters } from '../../apps/admin/src/store'
import setupMiniApp from '../utils/setupMiniApp'
describe('useWatermark', async () => {

View File

@ -16,7 +16,7 @@ import { pathToFileURL } from 'node:url'
it('generates usable types and package imports after additions, moves and deletions', () => {
const root = mkdtempSync(join(tmpdir(), 'ray-icon-generation-'))
const script = join(root, 'scripts/icons.mjs')
const manifest = join(root, 'src/icons/manifest.ts')
const manifest = join(root, 'src/manifest.ts')
const run = (...args: string[]) =>
execFileSync(process.execPath, [script, ...args], {
cwd: root,
@ -38,12 +38,12 @@ it('generates usable types and package imports after additions, moves and deleti
try {
mkdirSync(join(root, 'scripts'), { recursive: true })
mkdirSync(join(root, 'src/icons/action'), { recursive: true })
mkdirSync(join(root, 'src/action'), { recursive: true })
symlinkSync(resolve('node_modules'), join(root, 'node_modules'), 'junction')
copyFileSync('scripts/icons.mjs', script)
copyFileSync('packages/icons/scripts/icons.mjs', script)
copyFileSync('.prettierrc.cjs', join(root, '.prettierrc.cjs'))
writeFileSync(join(root, 'package.json'), '{"type":"module"}')
writeFileSync(join(root, 'src/icons/action/first.svg'), '<svg/>')
writeFileSync(join(root, 'src/action/first.svg'), '<svg/>')
run()
run('--check')
expect(read()).toEqual({
@ -51,18 +51,18 @@ it('generates usable types and package imports after additions, moves and deleti
sprites: { action: '/__spritemap-action' },
})
renameSync(
join(root, 'src/icons/action/first.svg'),
join(root, 'src/icons/action/renamed.svg'),
join(root, 'src/action/first.svg'),
join(root, 'src/action/renamed.svg'),
)
run()
expect(read().names).toEqual(['action/renamed'])
mkdirSync(join(root, 'src/icons/business-tools'), { recursive: true })
writeFileSync(join(root, 'src/icons/business-tools/new.svg'), '<svg/>')
mkdirSync(join(root, 'src/business-tools'), { recursive: true })
writeFileSync(join(root, 'src/business-tools/new.svg'), '<svg/>')
expect(() => run('--check')).toThrow()
run()
expect(read().sprites['business-tools']).toBe('/__spritemap-business-tools')
expect(read().names).toContain('business-tools/new')
rmSync(join(root, 'src/icons/action'), { recursive: true })
rmSync(join(root, 'src/action'), { recursive: true })
run()
expect(read()).toEqual({
names: ['business-tools/new'],

View File

@ -2,10 +2,14 @@
import { mkdirSync, mkdtempSync, rmSync, writeFileSync } from 'node:fs'
import { tmpdir } from 'node:os'
import { join } from 'node:path'
import type { IconProps } from '../../apps/admin/src/components/RIcon'
import {
iconNames,
isIconName,
resolveIconName,
} from '../../apps/admin/src/icons'
import type { IconName } from '../../apps/admin/src/icons'
import { iconNameFromPath, scanIcons } from '../../scripts/icons.mjs'
import type { IconProps } from '../../src/components/RIcon'
import { iconNames, isIconName, resolveIconName } from '../../src/icons'
import type { IconName } from '../../src/icons'
describe('namespaced icons', () => {
it('keeps the generated registry synchronized and exposes strict component props', () => {

View File

@ -1,6 +1,6 @@
import { mount } from '@vue/test-utils'
import GlobalSearch from '../../src/layout/components/Search/GlobalSearch'
import { router } from '../../src/router'
import GlobalSearch from '../../apps/admin/src/layout/components/Search/GlobalSearch'
import { router } from '../../apps/admin/src/router'
import setupMiniApp from '../utils/setupMiniApp'
it('mounts the header search on a narrow viewport and closes it immediately', async () => {

View File

@ -1,15 +1,21 @@
import { createPinia, disposePinia, setActivePinia } from 'pinia'
import piniaPluginPersistedstate from 'pinia-plugin-persistedstate'
import { createApp, nextTick } from 'vue'
import { APP_CATCH_KEY, GLOBAL_CLASS_NAMES } from '../../src/app-config'
import { findMenuRoot, firstMenuLeaf } from '../../src/layout/navigation'
import { piniaLockScreenStore } from '../../src/store/modules/lock-screen'
import { piniaSettingStore } from '../../src/store/modules/setting'
import {
APP_CATCH_KEY,
GLOBAL_CLASS_NAMES,
} from '../../apps/admin/src/app-config'
import {
findMenuRoot,
firstMenuLeaf,
} from '../../apps/admin/src/layout/navigation'
import { piniaLockScreenStore } from '../../apps/admin/src/store/modules/lock-screen'
import { piniaSettingStore } from '../../apps/admin/src/store/modules/setting'
import {
getDefaultSettingConfig,
normalizeLayoutConfig,
} from '../../src/store/modules/setting/constant'
import type { AppMenuOption } from '../../src/types'
} from '../../apps/admin/src/store/modules/setting/constant'
import type { AppMenuOption } from '../../apps/admin/src/types'
const menu = (
fullPath: string,

View File

@ -1,12 +1,12 @@
import { mount } from '@vue/test-utils'
import { createPinia, disposePinia, setActivePinia } from 'pinia'
import { nextTick } from 'vue'
import { useSiderScroll } from '../../src/hooks/template/useSiderScroll'
import Menu from '../../src/layout/components/Menu'
import { router } from '../../src/router'
import { piniaMenuStore } from '../../src/store/modules/menu'
import { piniaSettingStore } from '../../src/store/modules/setting'
import { positionSelectedMenuItem } from '../../src/utils'
import { useSiderScroll } from '../../apps/admin/src/hooks/template/useSiderScroll'
import Menu from '../../apps/admin/src/layout/components/Menu'
import { router } from '../../apps/admin/src/router'
import { piniaMenuStore } from '../../apps/admin/src/store/modules/menu'
import { piniaSettingStore } from '../../apps/admin/src/store/modules/setting'
import { positionSelectedMenuItem } from '../../apps/admin/src/utils'
it.each([
[true, '.n-layout-scroll-container'],

View File

@ -1,10 +1,10 @@
import { shallowMount } from '@vue/test-utils'
import { createPinia, disposePinia, setActivePinia } from 'pinia'
import { h, nextTick } from 'vue'
import Layout from '../../src/layout'
import { router } from '../../src/router'
import { piniaRuntimeStore } from '../../src/store/modules/runtime'
import { piniaSettingStore } from '../../src/store/modules/setting'
import Layout from '../../apps/admin/src/layout'
import { router } from '../../apps/admin/src/router'
import { piniaRuntimeStore } from '../../apps/admin/src/store/modules/runtime'
import { piniaSettingStore } from '../../apps/admin/src/store/modules/setting'
it('lets a custom header replace the complete default header and top navigation', () => {
const pinia = createPinia()
@ -12,7 +12,11 @@ it('lets a custom header replace the complete default header and top navigation'
setActivePinia(pinia)
piniaSettingStore().updateSettingState('layoutConfig', { mode: 'top' })
const options = {
global: { renderStubDefaultSlot: true, plugins: [router, pinia] },
global: {
renderStubDefaultSlot: true,
stubs: { RayAdminShell: false, NLayout: false, NLayoutContent: false },
plugins: [router, pinia],
},
}
const standard = shallowMount(Layout, options)
@ -40,7 +44,11 @@ it('offers a restore button for custom content and also exits with Escape', asyn
setActivePinia(pinia)
const runtime = piniaRuntimeStore()
const wrapper = shallowMount(Layout, {
global: { renderStubDefaultSlot: true, plugins: [router, pinia] },
global: {
renderStubDefaultSlot: true,
stubs: { RayAdminShell: false, NLayout: false, NLayoutContent: false },
plugins: [router, pinia],
},
slots: {
default: () => h('div', { 'data-test': 'custom-content' }, 'Custom'),
},
@ -72,7 +80,11 @@ it('moves the full navigation to the right without adding a second menu', () =>
setActivePinia(pinia)
piniaSettingStore().updateSettingState('layoutConfig', { mode: 'right' })
const wrapper = shallowMount(Layout, {
global: { renderStubDefaultSlot: true, plugins: [router, pinia] },
global: {
renderStubDefaultSlot: true,
stubs: { RayAdminShell: false, NLayout: false, NLayoutContent: false },
plugins: [router, pinia],
},
})
try {

View File

@ -6,7 +6,7 @@ import {
isCurrency,
multiply,
subtract,
} from '../../src/utils/precision'
} from '../../apps/admin/src/utils/precision'
describe('precision', () => {
it('check value is currency object', () => {

View File

@ -1,12 +1,12 @@
import { createMemoryHistory, createRouter } from 'vue-router'
import { APP_CATCH_KEY } from '../../src/app-config'
import { permissionRouter } from '../../src/router/utils/permission'
import { setStorage } from '../../src/utils/cache'
import { APP_CATCH_KEY } from '../../apps/admin/src/app-config'
import { permissionRouter } from '../../apps/admin/src/router/utils/permission'
import { setStorage } from '../../apps/admin/src/utils/cache'
vi.mock('../../src/hooks', () => ({
vi.mock('../../apps/admin/src/hooks', () => ({
useAppRoot: () => ({ getRootPath: { value: '/dashboard' } }),
}))
vi.mock('../../src/router/utils/valid-role', () => ({
vi.mock('../../apps/admin/src/router/utils/valid-role', () => ({
validRole: (meta: { role?: string[] }) =>
!meta.role?.length || meta.role.includes('admin'),
}))

View File

@ -1,4 +1,4 @@
import { fileToBase64 } from '../../src/utils/files'
import { fileToBase64 } from '../../apps/admin/src/utils/files'
it('encodes a file with its MIME type and preserves raw byte values', async () => {
const file = new File([new Uint8Array([0, 128, 255])], 'binary', {

View File

@ -1,5 +1,5 @@
import { AES, enc } from 'crypto-js'
import { decrypt, encrypt } from '../../src/utils/legacy-crypto'
import { decrypt, encrypt } from '../../apps/admin/src/utils/legacy-crypto'
describe('legacy AES JSON format', () => {
afterEach(() => vi.restoreAllMocks())

View File

@ -1,6 +1,6 @@
import { getDateByNaiveDatePicker } from '../../src/utils/get-date-by-naive-date-picker'
import { removeDuplicateKeys } from '../../src/utils/remove-duplicate-keys'
import { updateObjectValue } from '../../src/utils/update-object-value'
import { getDateByNaiveDatePicker } from '../../apps/admin/src/utils/get-date-by-naive-date-picker'
import { removeDuplicateKeys } from '../../apps/admin/src/utils/remove-duplicate-keys'
import { updateObjectValue } from '../../apps/admin/src/utils/update-object-value'
it('copies only own enumerable keys and preserves Symbol and __proto__ data', () => {
const symbol = Symbol('meta')

View File

@ -1,7 +1,7 @@
import { mount } from '@vue/test-utils'
import { effectScope, h, nextTick, ref } from 'vue'
import { unrefElement } from '../../src/utils/vue/unref-element'
import { watchEffectWithTarget } from '../../src/utils/vue/watch-effect-with-target'
import { unrefElement } from '../../apps/admin/src/utils/vue/unref-element'
import { watchEffectWithTarget } from '../../apps/admin/src/utils/vue/watch-effect-with-target'
it('unwraps elements and component roots consistently across refs and getters', () => {
const div = document.createElement('div')

View File

@ -1,6 +1,6 @@
import { setupI18n } from '../../src/locales'
import { setupRouter } from '../../src/router'
import { setupStore } from '../../src/store'
import { setupI18n } from '../../apps/admin/src/locales'
import { setupRouter } from '../../apps/admin/src/router'
import { setupStore } from '../../apps/admin/src/store'
import renderHook from '../utils/renderHook'
/**

View File

@ -1,4 +1,4 @@
import { call } from '../../src/utils/vue/call'
import { call } from '../../apps/admin/src/utils/vue/call'
describe('call', () => {
it('should be executed once', () => {

View File

@ -1,4 +1,4 @@
import { effectDispose } from '../../src/utils/vue/effect-dispose'
import { effectDispose } from '../../apps/admin/src/utils/vue/effect-dispose'
describe('effectDispose', () => {
it('should return false if getCurrentScope is null', () => {

View File

@ -1,4 +1,4 @@
import { renderNode } from '../../src/utils/vue/render-node'
import { renderNode } from '../../apps/admin/src/utils/vue/render-node'
import createRefElement from '../utils/createRefElement'
describe('renderNode', () => {

View File

@ -0,0 +1,40 @@
import { AdminShell } from '@ray-template/admin-shell'
import { RIcon } from '@ray-template/ui/icon'
import { RTablePro } from '@ray-template/ui/table-pro'
import { mount } from '@vue/test-utils'
it('mounts the shared shell, icons and table using only public package entries', async () => {
const wrapper = mount(AdminShell, {
props: {
layout: {
mode: 'right',
contentWidth: 'fluid',
contentMaxWidth: 1200,
contentPadding: 16,
fixedHeader: true,
fixedFooter: true,
},
},
slots: {
sidebar: () => <RIcon name="action/search" />,
default: () => (
<RTablePro
bare
columns={[{ key: 'name', title: 'Name' }]}
data={[{ id: 1, name: 'Workspace consumer' }]}
/>
),
},
})
try {
await vi.waitFor(() => {
expect(
wrapper.get('.r-icon svg').element.childElementCount,
).toBeGreaterThan(0)
})
expect(wrapper.text()).toContain('Workspace consumer')
} finally {
wrapper.unmount()
}
})

View File

@ -0,0 +1,53 @@
import { createHttpClient } from '@ray-template/http'
import { AxiosError } from 'axios'
import type { AxiosAdapter, AxiosResponse } from 'axios'
it('isolates pending requests by client and leaves caller-owned signals intact', async () => {
const pending: Array<{ signal: unknown; finish: () => void }> = []
const adapter: AxiosAdapter = (config) =>
new Promise<AxiosResponse>((resolve, reject) => {
pending.push({
signal: config.signal,
finish: () =>
resolve({
data: 'ok',
status: 200,
statusText: 'OK',
headers: {},
config,
}),
})
config.signal?.addEventListener?.('abort', () =>
reject(new AxiosError('aborted', 'ERR_CANCELED', config)),
)
})
const first = createHttpClient({ axios: { adapter } })
const second = createHttpClient({ axios: { adapter } })
const original = first.request
.get('/same')
.catch((error: AxiosError) => error.code)
const other = second.request.get('/same')
await vi.waitFor(() => expect(pending).toHaveLength(2))
const replacement = first.request.get('/same')
await vi.waitFor(() => expect(pending).toHaveLength(3))
expect(await original).toBe('ERR_CANCELED')
expect(first.canceler.getPendingCount()).toBe(1)
expect(second.canceler.getPendingCount()).toBe(1)
pending[1].finish()
pending[2].finish()
expect(await Promise.all([other, replacement])).toEqual(['ok', 'ok'])
const own = new AbortController()
const supplied = first.request.get('/custom', { signal: own.signal })
await vi.waitFor(() => expect(pending).toHaveLength(4))
expect(pending[3].signal).toBe(own.signal)
first.canceler.cancelAllRequest()
expect(own.signal.aborted).toBe(false)
pending[3].finish()
await expect(supplied).resolves.toBe('ok')
})

41
apps/admin/package.json Normal file
View File

@ -0,0 +1,41 @@
{
"name": "@ray-template/admin",
"private": true,
"type": "module",
"version": "6.0.0",
"dependencies": {
"@faker-js/faker": "10.6.0",
"@logicflow/core": "2.2.5",
"@logicflow/extension": "2.3.1",
"@ray-template/utils": "workspace:*",
"@valibot/to-json-schema": "1.8.0",
"@vueuse/core": "15.0.0",
"axios": "1.21.0",
"clipboard": "2.0.11",
"crypto-js": "4.2.0",
"dayjs": "1.11.23",
"echarts": "6.1.0",
"html-to-image": "1.11.13",
"interactjs": "1.10.28",
"jsbarcode": "3.12.3",
"lodash-es": "4.18.1",
"naive-ui": "2.45.3",
"pinia": "4.1.0",
"pinia-plugin-persistedstate": "4.7.1",
"print-js": "1.6.0",
"valibot": "1.5.0",
"vue": "3.5.44",
"vue-demi": "0.14.10",
"vue-hooks-plus": "2.4.3",
"vue-i18n": "11.4.17",
"vue-router": "5.4.0",
"vue3-next-qrcode": "4.1.1",
"@ray-template/ui": "workspace:*",
"@ray-template/composables": "workspace:*",
"@ray-template/directives": "workspace:*",
"@ray-template/icons": "workspace:*",
"@ray-template/routing": "workspace:*",
"@ray-template/http": "workspace:*",
"@ray-template/admin-shell": "workspace:*"
}
}

View File

Before

Width:  |  Height:  |  Size: 302 KiB

After

Width:  |  Height:  |  Size: 302 KiB

View File

Before

Width:  |  Height:  |  Size: 2.6 KiB

After

Width:  |  Height:  |  Size: 2.6 KiB

View File

Before

Width:  |  Height:  |  Size: 370 B

After

Width:  |  Height:  |  Size: 370 B

View File

@ -4,11 +4,35 @@ import AppNaiveGlobalProvider from '@/app-components/provider/AppNaiveGlobalProv
import AppStyleProvider from '@/app-components/provider/AppStyleProvider'
import AppVersionProvider from '@/app-components/provider/AppVersionProvider'
import AppWatermarkProvider from '@/app-components/provider/AppWatermarkProvider'
import { APP_GLOBAL_LOADING } from '@/app-config'
import {
APP_CATCH_KEY_PREFIX,
APP_GLOBAL_LOADING,
APP_THEME,
} from '@/app-config'
import { useI18n } from '@/hooks/template/useI18n'
import { useSettingGetters } from '@/store'
import type { IconPackage } from '@ray-template/icons'
import { iconSprites } from '@ray-template/icons/manifest'
import { provideUiServices } from '@ray-template/ui/services'
import { createStorage } from '@ray-template/utils/storage'
import { RouterView } from 'vue-router'
export default defineComponent({
name: 'App',
setup() {
const { getAppTheme } = useSettingGetters()
const { t } = useI18n()
provideUiServices({
dark: () => getAppTheme.value,
chartTheme: APP_THEME.echartTheme,
translate: t,
columnStorage: createStorage(window.localStorage, APP_CATCH_KEY_PREFIX),
reportError: (message) => window.$message?.error(message),
iconUrl: (name, prefix) =>
`${iconSprites[name.split('/')[0] as IconPackage]}#${prefix}-${name}`,
})
},
render() {
return (
<AppNaiveGlobalProvider>

View File

@ -14,4 +14,4 @@
- `AppWatermarkProvider` 为全局水印提供入口,显示与内容通过 `useWatermark` 调整。需要限制水印覆盖范围时,调整 Provider 的挂载位置。
- `AppRequestCancelerProvider` 在路由更新前取消旧请求;默认布局内容负责挂载。自定义内容插槽时需保留所需的请求取消行为。
组件介绍放在此类文档中,声明前不再保留大段说明;注释位置与格式遵循 [统一注释规范](../../docs/comment-style.md)。
组件介绍放在此类文档中,声明前不再保留大段说明;注释位置与格式遵循 [统一注释规范](../../../../docs/comment-style.md)。

Some files were not shown because too many files have changed in this diff Show More