SuperAPI AI 工具集

create-import-module

编程与开发

查看项目

更新于 10-16 08:06

技能介绍

用途:创建 ***plain 导入模块。导入模块是位于 template/ 目录的 .plain 文件,仅包含定义、实现需求和/或测试需求,不含功能规格,且 frontmatter 中不得使用 requires。其他模块通过 YAML frontmatter 的 import 字段引入其内容,从而获得其中的定义与需求。

主要能力:导入模块可用于跨多个模块共享概念定义、提供通用实现需求(如技术栈、编码规范)、提供通用测试需求,以及创建可复用的基础结构模板。若模块需要功能规格(即描述软件应做什么),则它不是导入模块,应改用 create-requires-module 技能。

使用方式:先确定要提供的共享内容;在 template/ 目录创建带 YAML frontmatter 的 .plain 文件,用 required_concepts 声明导入模块必须定义的概念,可选地导入其他模板实现分层复用,但不得使用 requires;添加共享内容(定义、实现需求、测试需求);不要添加功能规格;核查概念可用性,确保引用的所有概念均已在本模块定义、由其自身导入提供、声明为 required_concepts,或属于预定义概念。

格式要点:import 字段是模块路径列表,默认导入目录为 template/,路径中无需 template/ 前缀,省略 .plain 扩展名。示例 frontmatter 含 import、required_concepts、description;正文分 definitions、implementation reqs、test reqs 三段,且不含 functional specs。若被导入模板声明 required_concepts,导入模块必须在其自身定义段中定义这些概念。import 与 requires 的区别:import 会引入定义、实现需求和测试需求,但不引入功能规格、不复制生成代码,典型用于模板与共享定义;requires 不引入定义,但会引入功能规格作为先前需求,并复制生成代码,典型用于构建依赖链。

限制与校验:模块须位于 template/ 目录;不得含功能规格;不得在 frontmatter 使用 requires;至少含定义、实现需求、测试需求之一;自身导入声明的 required_concepts 须被满足;对引用但未定义的概念声明 required_concepts;导入与本模块定义之间不得有概念名冲突;YAML frontmatter 须在 --- 标记间正确格式化。使用前应先用 load-plain-reference 技能获取 ***plain 语法规则(若尚未获取)。