spec.md 4.4 KB
# plugin-lifecycle 规范
目的
定义插件从创建、打包、安装、删除到单插件构建的整个生命周期，包括插件元数据如何影响最终交付产物。
职责边界
本规范覆盖
pluginMaker/index.cjs的create、package、install、remove命令- 新建插件后的脚手架预期
- 源码与公共资源的 ZIP 打包边界
- 插件 ZIP 安装行为
- 单插件构建时的资源保留逻辑
config.require对单插件构建结果的影响
本规范不覆盖
- 插件具体场景或业务语义本身
- 预览中心分类逻辑
- 除生命周期必须遵守之外的路由实现细节
- 宿主应用的集成契约
主要代码依据
pluginMaker/index.cjs.fes.predev.one.jssrc/common/copySelectedPublicDirsPlugin.jssrc/common/utils.js.env.predev.onepackage.json
要求
Requirement: 生命周期命令范围
插件生命周期命令 SHALL 同时面向源码目录与公共资源目录这两个命名空间工作。create、package、install、remove 都属于正式生命周期命令集合。
Scenario: 打包插件
- GIVEN 维护者执行
node pluginMaker/index.cjs package <plugin> - WHEN 插件存在
- THEN 系统 SHALL 以
src/plugins/<plugin>为源码边界进行打包 - AND 若存在
public/plugins/<plugin>，也 SHALL 一并纳入包内容
Scenario: 安装插件
- GIVEN 维护者执行
node pluginMaker/index.cjs install <plugin> - WHEN
pluginMaker/install/<plugin>.zip存在 - THEN 系统 SHALL 将插件安装到当前仓库的正式插件命名空间中
Requirement: ZIP 路径保持正式命名空间
插件生命周期 ZIP 包 SHALL 保持 src/plugins/<plugin> 与可选 public/plugins/<plugin> 这两组正式相对路径。install 命令 SHALL 依赖这组路径直接解压到仓库根目录，而不是在安装时做额外路径重映射。
Scenario: 安装命令依赖规范 ZIP 结构
- GIVEN 一个待安装插件包由既有打包流程生成
- WHEN 维护者执行
node pluginMaker/index.cjs install <plugin> - THEN 该插件包 SHALL 以仓库根目录为解压落点恢复正式插件路径
- AND 不应要求安装命令再额外推断自定义目录映射
Requirement: 模板脚手架地位
template.zip 生成的内容 SHALL 被视为插件初始化便利工具，而不是插件最终结构的全部规范来源。正式插件结构与约束应以 plugin-system 规范为准；脚手架只负责快速起步。
Scenario: 新建插件后继续定制
- GIVEN 维护者执行
node pluginMaker/index.cjs create <plugin> - WHEN 脚手架生成了默认文件
- THEN 这些文件 SHALL 被视为可替换的初始化模板
- AND 维护者后续 SHALL 根据真实插件需求替换和完善实现
Requirement: create 命令初始化边界
create 命令 SHALL 初始化 src/plugins/<plugin> 下的源码模板，并创建 public/plugins/<plugin>/preview 预览资源目录。该命令可以做插件名与日期等基础替换，但 SHALL 不被视为已经完成业务级插件设计。
Scenario: create 只负责起步骨架
- GIVEN 维护者执行
node pluginMaker/index.cjs create <plugin> - WHEN 命令执行成功
- THEN 系统 SHALL 生成插件源码骨架并准备预览资源目录
- AND 维护者后续仍 SHALL 手工完善
config.js、页面实现与预览资源
Requirement: 单插件构建保留规则
单插件构建流程 SHALL 保留目标插件及其显式声明的依赖插件。其资源保留范围以目标插件名和 config.require 为准，而不是全量复制所有插件公共资源。
Scenario: 单插件资源裁剪
- GIVEN 当前单插件构建目标已通过
FES_APP_PLSNAME指定 - WHEN 构建流程复制公共资源
- THEN 系统 SHALL 仅复制目标插件及其
config.require中声明的依赖插件资源
Requirement: remove 命令归属与约束
带破坏性的 remove 命令 SHALL 继续被视为插件生命周期规范的一部分，而不是拆到独立运维规范。由于其会删除源码与公共资源目录，维护者 SHALL 仅在显式确认删除时使用该命令。
Scenario: 删除插件
- GIVEN 维护者执行
node pluginMaker/index.cjs remove <plugin> - WHEN 系统进入删除确认流程
- THEN 只有在维护者显式输入确认后
- 系统 SHALL 删除
src/plugins/<plugin>与public/plugins/<plugin>中存在的对应目录