SuperAPI AI 工具集

nk-livewire-best-practices

编程与开发

查看项目

更新于 10-25 13:58

技能介绍

本技能提供在 Naykel(Gotime)框架上构建 Livewire 组件时使用的模式与约定。

用途:在创建、修改或审查 Naykel 项目中的 Livewire 组件时使用,无需等待显式请求。

配置优先(Config First):构建任何组件前,资源 config 必须已存在并被读取。所有结构(列、字段、按钮)都从 config 派生,绝不从模型、迁移或提示词推断。若 config 已存在,则严格按其所写实现;若与请求冲突,应停止并暴露冲突,不自行解决。

规则文件:构建前需读取相关规则文件,下文摘要仅为默认值,完整规则优先。

  1. 资源 Config(rules/resource-config.md):构建组件前检查 config/resources.php;若不存在先创建;按组件类型表确定按钮,未列出的组合需询问;index 和 form 需要 routePrefix,form-modal 不需要;未经明确指示不得修改现有 config;config 与请求冲突时停止并暴露。

  2. Index 组件(rules/index-component.md):继承 BaseIndex,设置 $modelClass 和 configKey();始终包含排序,添加 Sortable trait 和 applySorting();表列从 index.columns 构建,不从模型推断;严格按 config 渲染 index.buttons;仅在明确要求时增加基础结构外的功能。

  3. Form 组件(rules/form-component.md):继承 BaseForm,声明 ModelFormObject $form 和 $modelClass;路由式表单用 saveAndEdit 保存,通过 $routePrefix 链接回 index;form-modal 需添加 createTitle、editTitlePrefix 和 titleField;按钮用 form 按钮令牌从 config 渲染。

  4. Form Object(rules/form-object.md):使用 Gotime 的 Formable 和 Crudable trait;命名为 ModelFormObject,不用 ModelForm;属性从 form.fields 构建,不从模型、迁移或提示词推断;默认在属性上用 #[Validate(...)];仅唯一约束需要 Rule::unique()->ignore() 时用 rules();required / nullable 验证须与数据库可空性一致,实现前解决冲突;setFormProperties() 会将字符串属性的 null 转为 '',仅在 init() 中为日期字段覆盖。

  5. 文件上传(rules/file-uploads.md):WithFileUploads 加在组件而非 form object;不要在 form object 声明 tmpUpload(由 Crudable 提供);在 form object 添加 $storage 配置磁盘、列和路径;在组件添加 imageUrl() 处理预览与回退。

应用方式:回复前读取相关规则文件,不只依赖摘要;识别正在构建的组件类型(index、form、form-modal、form object、文件上传);先读 rules/resource-config.md,因为 config 驱动一切;再读对应组件的规则文件;检查同级文件既有模式并优先遵循(一致性优先)。

适用场景:Naykel Gotime 项目中 Livewire 组件的开发与审查。限制:规则细节以规则文件为准;关于收费、平台支持范围等其余信息暂未提供。