wps-cmake-module-analyzer

Files (1)

• SKILL.md

SKILL.md (first lines)

# Skill 概述

本 skill 面向本项目代码仓库 `D:\branch-master\wpsmain` 与 Obsidian 笔记库
`~/Documents/Obsidian-work`。核心目标：

- 如果要求分析模块, 定位并解析 CMake 模块（bundle/子模块），基于 `CMakeLists.txt` 推断模块边界与依赖。
- 如果要求分析类型, 定位模块, 并在模块范围内分析 C++ 类型的继承、接口实现与依赖关系。
- 扫描模块目录下的头/源文件，分析 C++ 类型的继承关系、接口实现以及依赖/所有权关系。
- 通过关键源文件追踪类型生命周期与典型调用流程。
- 按 Obsidian `AGENTS.md` 中的“代码模块相关笔记”模板，将分析结果写入或更新模块笔记。

触发时机示例：

- “分析 Coding/api_bundle/api/jsapi/v8proxy 这个模块，并把结果写到笔记库里”。
- “分析 KxJdeMainWindow 这个类型，并把结果写到笔记库里”。
- “总结某个 CMake 模块的类型结构和生命周期，按模块模板生成 Obsidian 文档”。
- “我想了解某个模块的核心类型和调用流程，帮我分析代码并更新笔记库”。
- "补全笔记 cefipc.md 中对相关类型的分析 "
- "补全笔记 cefipc.md 中对初始化流程的分析 "

> 约束：
> - 遵守仓库 `AGENTS.md` 约定：**优先使用 LSP / AST-grep** 进行代码搜索与分析，避免无目标的大范围 grep。
> - 笔记库根目录固定为 `~/Documents/Obsidian-work`，WPS 相关笔记在 `wps/` 目录下。

---

## 目录与命名约定

### 代码仓库

- 仓库根：`D:\branch-master\wpsmain`
- CMake 根入口：`Coding/CMakeLists.txt`
- bundle 层级结构与说明：参考仓库根目录 `AGENTS.md` 中的 “wpsmain项目目录结构” 与 “Bundle层级架构”。

模块（module / 子模块）定义：

- 至少包含一个 `CMakeLists.txt`，内部使用 `wps_package(...)` 或 `add_library(...)` 等声明目标；
- 配套头/源文件通常在同级或子目录（如 `include/`, `src/`, `office/...`）。

### 笔记库

- 笔记库根：`~/Documents/Obsidian-work`
- WPS 相关笔记：`~/Documents/Obsidian-work/wps/`

模块级笔记推荐路径：

```text
wps/模块/<bundle-name>/<module-name>.md   # 推荐
# 若 bundle 不易确定，可退化为：
wps/模块/<module-name>.md
```

其中：

- `bundle-name`：如 `core_bundle`, `api_bundle` 等；
- `module-name`：默认取 CMake 模块名（如 `jde`, `v8proxy`），可首字母大写。

---

## 笔记模板与 AI 区块

模块文档整体结构遵循 Obsidian `AGENTS.md` 中的“代码模块相关笔记”模板：

```md
# 模块名
- cmake所在目录路径
- 模块的功能简介
## 能力
模块的能力, 作用, 适用场景等
## 依赖关系
模块的依赖关系, 包括依赖的模块, 被哪些模块依赖等, 包括动态链接和静态链接
# 模块细节
## 类型
用plantuml画出模块的类图，主要包含类型间的继承, 依赖, 所有权等关系. 

> [> [!IMPORTANT]
> 由于类型太多, 不生成每个类型的字段和方法. 
> 要区分class和interface和abstract class
> 需要画出接口实现关系, 以及所有权关系(聚合/组合/弱引用)
> 需要画Qt信号槽绑定关系

#### TypeClass (具体的类型)
类型的作用, 字段, 依赖关系, 继承关系等
##### TypeClass.Method (具体的方法)
方法的作用, 参数, 返回值, 依赖关系等

## 流程

### 流程名
用plantuml时序图说明模块的关键执行流程, 以及各类型关系, 各线程关系
#### 调用栈
用代码块说明关键的调用栈, 以及各函数的作用, 参数, 返回值等
```

为便于多次运行本 skill 时安全更新，约定在文件中为 AI 生成内容包裹以下标记区块：

```md
<!-- AI:MODULE-OVERVIEW START -->
... 这里写入/更新模块概览、能力和依赖关系 ...
<!-- AI:MODULE-OVERVIEW END -->

<!-- AI:MODULE-TYPES START -->
... 这里写入/更新类型关系与 PlantUML 类图 ...
<!-- AI:MODULE-TYPES END -->

<!-- AI:MODULE-FLOWS START -->
... 这里写入/更新关键流程、时序图与调用栈 ...
<!-- AI:MODULE-FLOWS END -->
```

后续再次运行该 skill 时，只替换标记内的内容，保留标记外的用户手写内容与结构。

---

## 工作流程

整体分为四个阶段：

1. 定位模块 CMake 目录

From wang-zi-tao/dotfiles, MIT.

More from wang-zi-tao/dotfiles