From 97e7bd682798e9155ecb0ce4604d1aaf631ba758 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=89=8D=E7=AB=AF=E7=88=B1=E7=A0=81=E5=A3=AB?= Date: Thu, 22 Aug 2024 21:44:54 +0800 Subject: [PATCH 1/4] chore(docs): correct the naming convention typo in the test files (#4216) --- docs/src/guide/project/test.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/src/guide/project/test.md b/docs/src/guide/project/test.md index ed7f7779..abf3c509 100644 --- a/docs/src/guide/project/test.md +++ b/docs/src/guide/project/test.md @@ -4,7 +4,7 @@ ## 编写测试用例 -在项目中，我们约定将测试文件名以 `.test.ts` 结尾，或者存放到`__tests__`目录内。例如，创建一个 `utils.ts` 文件，然后同级目录`utils.spec.ts` 文件， +在项目中，我们约定将测试文件名以 `.test.ts` 结尾，或者存放到`__tests__`目录内。例如，创建一个 `utils.ts` 文件，然后同级目录`utils.test.ts` 文件， ```ts // utils.test.ts From 5b24661b7856290494efe5ab2bebd487be2d1ed6 Mon Sep 17 00:00:00 2001 From: afe1 <56245609+pzzyf@users.noreply.github.com> Date: Thu, 22 Aug 2024 21:48:05 +0800 Subject: [PATCH 2/4] chore(docs): updated title slot description (#4192) * fix: slots * fix: reademe --------- Co-authored-by: afe1 --- packages/effects/layouts/src/basic/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/effects/layouts/src/basic/README.md b/packages/effects/layouts/src/basic/README.md index 6d8140bc..05d7afc8 100644 --- a/packages/effects/layouts/src/basic/README.md +++ b/packages/effects/layouts/src/basic/README.md @@ -3,5 +3,5 @@ ### header - 支持N个自定义插槽，命名方式：header-right-n，header-left-n -- header-left-n ，排序方式：1-5 ,breadcrumb，6-x +- header-left-n ，排序方式：1-4 ,breadcrumb，6-x - header-right-n ，排序方式：1-4，global-search，6-9，theme-toggle，11-14，language-toggle，16-19，fullscreen，21-24，notification，26-29，user-dropdown，30-x From e2732f334c0e24e5258945f20fc8659eefe3e4e7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E8=8B=97=E5=A4=A7?= Date: Thu, 22 Aug 2024 21:51:04 +0800 Subject: [PATCH 3/4] chore: update vscode configuration (#4210) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * chore: vscode 配置package.json默认匹配为json而不是jsonc, 以修复依赖悬浮提示信息 * fix: settings.json eslint --- .vscode/settings.json | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.vscode/settings.json b/.vscode/settings.json index 80950410..cafc2857 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -56,7 +56,8 @@ "*.ejs": "html", "*.art": "html", "**/tsconfig.json": "jsonc", - "*.json": "jsonc" + "*.json": "jsonc", + "package.json": "json" }, "files.exclude": { From d5655f02e3253478e6692dba97ccf1bf073cca02 Mon Sep 17 00:00:00 2001 From: handsomeFu Date: Thu, 22 Aug 2024 21:52:44 +0800 Subject: [PATCH 4/4] chore(docs): update function parameter comments (#4215) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * docs(other): update function parameters jsdoc - 移除`vue-router.d.ts`中`activePath`属性的默认值注释。 - 重构`generateRoutes`函数签名，增加`options`参数。 - 调整`authLogin`函数文档，增加`onSuccess`回调函数的说明。 * docs: 删除 `activePath` 属性的默认值注释 在路线文档中，移除了`activePath`属性的默认值注释，以清晰说明其行为。此更改更新了文档内容，使其更准确地反映代码实现。 --- docs/src/guide/essentials/route.md | 1 - packages/@core/base/typings/src/vue-router.d.ts | 1 - packages/effects/access/src/accessible.ts | 1 + playground/src/store/auth.ts | 1 + 4 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/src/guide/essentials/route.md b/docs/src/guide/essentials/route.md index 29fa298b..51da3d72 100644 --- a/docs/src/guide/essentials/route.md +++ b/docs/src/guide/essentials/route.md @@ -293,7 +293,6 @@ interface RouteMeta { activeIcon?: string; /** * 当前激活的菜单，有时候不想激活现有菜单，需要激活父级菜单时使用 - * @default false */ activePath?: string; /** diff --git a/packages/@core/base/typings/src/vue-router.d.ts b/packages/@core/base/typings/src/vue-router.d.ts index ba6407d7..87349cd7 100644 --- a/packages/@core/base/typings/src/vue-router.d.ts +++ b/packages/@core/base/typings/src/vue-router.d.ts @@ -9,7 +9,6 @@ interface RouteMeta { activeIcon?: string; /** * 当前激活的菜单，有时候不想激活现有菜单，需要激活父级菜单时使用 - * @default false */ activePath?: string; /** diff --git a/packages/effects/access/src/accessible.ts b/packages/effects/access/src/accessible.ts index 289a3bd0..89f3a11c 100644 --- a/packages/effects/access/src/accessible.ts +++ b/packages/effects/access/src/accessible.ts @@ -36,6 +36,7 @@ async function generateAccessible( /** * Generate routes * @param mode + * @param options */ async function generateRoutes( mode: AccessModeType, diff --git a/playground/src/store/auth.ts b/playground/src/store/auth.ts index c21d6b6d..5c50b150 100644 --- a/playground/src/store/auth.ts +++ b/playground/src/store/auth.ts @@ -24,6 +24,7 @@ export const useAuthStore = defineStore('auth', () => { * 异步处理登录操作 * Asynchronously handle the login process * @param params 登录表单数据 + * @param onSuccess 成功之后的回调函数 */ async function authLogin( params: LoginAndRegisterParams,