实现可配置的验证码逻辑
一次性提示词已完成
本提示词已经落实使用,对应的功能已经实现完善。
1. 任务要求
请深度思考。
请为我实现可配置的验证码逻辑。我希望实现通过实现项目级别的配置,实现验证码功能的自由开启。
2. 文件与术语说明
项目配置文件:apps\admin\public\platform-config.jsonPlatformConfigs:项目配置文件对应的类型。类型文件在apps\admin\types\global.d.ts内登录页:apps\admin\src\views\login\index.vue可配置验证码文档目录:apps\admin\src\docs\feat\configurable-verify-code
3. 需求
- 请整体性的阅读项目,思考如何实现该需求。
- 看清楚那些地方强制需要验证码,并用合适的方式实现变量控制。
- 请在
项目配置文件内,增加适当的配置项。默认不需要验证码逻辑。 - 完成改造任务后,将这款新的功能,在
可配置验证码文档目录内编写 md 文档。便于其他人阅读学习使用。 - 将你的改造项,改造方案,也同步在
可配置验证码文档目录内写好,编写另外一份独立的文档说明清楚。
4. 任务详情
4.1 任务 001
请你使用 getConfig 来优化代码写法。我不希望你直接使用 import { useGlobal } from "@pureadmin/utils"; 的方式来完成全局配置的获取和使用。
- 请你先阅读项目代码,看看其他组件是如何使用 getConfig 函数的。
- 我希望你使用
apps\admin\src\config\index.ts内提供的 getConfig 函数,来获取项目配置文件。 - 请你整理优化代码,封装好一个组合式 api 函数,包装这样的逻辑。请在
apps\admin\src\composables\use-configurable-verify-code目录内新建组合式 api。 - 请你在对应的地方使用这个封装好的组合式 api。
- 在
apps\admin\src\docs\feat\configurable-verify-code内编写好该功能的介绍文档。编写功能的使用与介绍文档,而不是技术文档。 - 在
apps\admin\src\composables\use-configurable-verify-code目录内,编写技术文档。编写好改组合式 api 的使用文档,和改造项、改造方案文档。 - 编写的文档满足 vitepress 文档的常见组织方式。没有 index.md 文件,就适当地新建。
- 请你及时的更新已经写好的文档。
4.2 任务 002
- 更改变量的命名风格,返回布尔值的变量或函数,命名风格应该为
isXXX。 - 同步更改
apps\admin\types\global.d.ts的 PlatformConfigs 类型名称。 - 在
apps\admin\types\global.d.ts内,为 PlatformConfigs 新增加的配置项类型,补全 jsdoc 风格的简单说明注释。 - 整理文档。将
apps\admin\src\docs\feat\configurable-verify-code\implementation-plan.md文档的内容,整理到apps\admin\src\composables\use-configurable-verify-code\implementation-plan.md内。将两份文档的内容整合好。 - 删除多余文档。只保留 composables 目录下面的 implementation-plan.md 文档,删除
docs\feat目录下的 implementation-plan.md 文档。 - 涉及到的几个文档,简化代码实例的部分,并同步更改改名后的变量名。
4.3 任务 003
- 同步更改
apps\admin\types\global.d.ts的 PlatformConfigs 类型名称。命名风格也应该改成isXXX风格的。 - 更改对应的文档。
4.4 任务 004
- 删减
apps\admin\src\composables\use-configurable-verify-code\implementation-plan.md文档内内关于useGlobal的内容。我不希望看到对 useGlobal 写法的优化文档。 - 删除上述文档的总结,我不需要看总结。
4.5 任务 005
请增加新的功能。
- 请你先阅读
apps\admin\src\views\login\index.vue文件的这一段代码。
vue
<!-- 业务变更 不使用框架自带的前端验证码 -->
<!-- <ReImageVerify v-model:code="imgCode" /> -->- 请在配置文件内,增加新的配置项,允许开启使用系统自带的验证码系统。该配置项默认为 true,默认开启系统的前端验证码。
- 请更改对应的类型文件,同步更改对应的文档。
4.6 任务 006
请应用新开发的 isSystemCaptchaEnabled 函数。启用框架自带的前端验证码。请在 apps\admin\src\views\login\index.vue 启用该功能。