用途
LikeC4 DSL 技能用于在编辑 .c4 / .likec4 文件,或处理 LikeC4 CLI 与配置相关问题时,提供准确的 DSL 与命令行语法参考。LikeC4 是一种“架构即代码”工具:在 .c4 / .likec4 文件中描述系统,LikeC4 据此生成可交互的架构图。
项目与作用域
一个工作区中可以有多个 LikeC4 项目。项目由配置文件的存在来判定,配置文件包括 .likec4rc、likec4.config.{ts,js,json}。LikeC4 文件归属于目录层级中最近配置文件所在的项目。配置中的关键选项包括 name(必填,工作区内唯一 ID)与 title(展示名称)。若不确定作用域,应向用户确认。
顶层语句与多文件合并
顶层语句只允许:import、specification、model、deployment、views、global。块可以重复出现,但每个文件至少需存在一个。跨文件的顶层块会被合并,例如多个文件中的 model { ... } 块会被分别解析后合并为单一 model。
语法约束
- 字符串:'单引号'、"双引号",均支持多行;用反斜杠转义引号。
- Markdown:
summary/description/notes等属性可包含 Markdown,使用三引号'''或""",开引号后换行并缩进内容。 - 注释:支持
//单行与/* 多行 */。 - 标识符:仅允许字母、数字、连字符、下划线,不能含点(点是 FQN 分隔符),不能以数字开头。例如
payment-api合法,payment.api不是标识符。 - FQN:以点分隔的元素路径,在项目内必须唯一。
- 引用:具有词法作用域与提升机制,嵌套作用域可遮蔽外层;该作用域不跨文件传递,跨文件引用必须使用完整 FQN。
CLI 规范契约
- 校验族:使用
likec4 validate,不得用check、lint、build替代。 - 导出族:使用
likec4 export。 - 严格校验标志:
--json --no-layout --file <path> ... <project-dir>。 - 多文件校验:每个被编辑的源文件重复一次
--file。 - 导出输出标志:优先使用
--outdir或-o。
运行器可为 npx、bunx、pnpm dlx,命令族一致。若工作区已依赖 likec4,需保证版本至少为 1.53.0。
校验输出字段
校验结果包含 valid、errors、stats。filteredFiles 为经 --file 过滤后实际纳入的文件数;filteredErrors 为过滤子集内的错误数;totalErrors 为全项目错误数。当 filteredErrors 为 0 而 totalErrors 较高时,说明被编辑文件本身无误,项目其他地方存在问题。
主要语法族
- specification:定义元素种类、部署节点种类、关系种类、标签与自定义颜色令牌,须在使用前出现。
- model:元素与关系的层级结构,元素具有种类、唯一标识符及可选属性与嵌套元素。
- deployment:通过
instanceOf将逻辑模型元素映射到物理基础设施节点;命名实例写法为IDENTIFIER = instanceOf ELEMENT_ID。 - views:元素视图、动态视图、部署视图三类,支持 include/exclude 谓词、样式规则、分组、autoLayout、extends、navigateTo 及全局谓词组。
- style:控制颜色、形状、边框、透明度、尺寸、内边距、文本大小、图标等。
谓词语义
parent.*:仅 parent 的直接子级。parent._:与累积结果存在关系的直接子级。parent.**:与累积结果存在关系的递归后代。
不得把 * 描述为递归,不得把 _ 描述为通配全部,不得丢弃 _ / ** 的关系条件语义。
响应纪律
当提示词要求“minimal”“paste-ready”“strict”“exact”或指定首行时,应首先输出唯一最终命令/片段/结论,不给出替代方案或多余前言。若任务为片段优先或命令优先,仅用散文作答视为失败。在最终回答前,需确认所需令牌字面出现(如 --no-layout、instanceOf、-[async]->、parallel {、<- 等)。不得声称执行了 CLI,除非确实运行过。