@routerhub/agent-rules 1.5.11 → 1.5.12

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/AGENTS.base.md CHANGED
@@ -19,7 +19,12 @@
19
19
 
20
20
  ## 需求文档
21
21
 
22
- - 新需求先在 `docs/` 写 MD 文档,含:目标、范围、功能要求、验收标准。
22
+ - 新需求先在 `docs/` 写文档,含:目标、范围、功能要求、验收标准。
23
+
24
+ ## 文档格式
25
+
26
+ - 所有新建文档必须使用 HTML 格式(`.html`),禁止使用 Markdown(`.md`)格式。
27
+ - 已有的 `.md` 文件可保留,但新增文档一律使用 HTML。
23
28
 
24
29
  ## 优先级
25
30
 
package/README.md CHANGED
@@ -12,22 +12,26 @@
12
12
  在你的项目里安装:
13
13
 
14
14
  ```bash
15
- pnpm add -D concurrently @routerhub/agent-rules
15
+ pnpm add -D @routerhub/agent-rules
16
16
  ```
17
17
 
18
- ## 使用
19
-
20
- 修改项目package.json中的scripts中的启动命令,改成类似下面这种,
21
-
22
- ```json
23
- {
24
- "scripts": {
25
- "dev": "concurrently \"next dev\" \"agent-rules watch\""
26
- }
27
- }
28
- ```
29
-
30
- 作用:
31
-
32
- - 监听 `AGENTS.private.md` 变更
33
- - 变更后自动重新同步 `AGENTS.md` 和 `.github/copilot-instructions.md`
18
+ 安装完成后会自动:
19
+
20
+ 1. 生成 `AGENTS.md` 和 `.github/copilot-instructions.md`
21
+ 2. 在后台启动 watch 进程,持续监听 `AGENTS.private.md` 变更并自动同步
22
+
23
+ 无需手动执行任何命令,修改 `AGENTS.private.md` 即可自动生效。
24
+
25
+ > **注意:** 后台 watch 进程在重启电脑后会停止。如需每次启动开发时自动恢复监听,可在 `package.json` 中配合 `concurrently` 使用:
26
+ >
27
+ > ```bash
28
+ > pnpm add -D concurrently
29
+ > ```
30
+ >
31
+ > ```json
32
+ > {
33
+ > "scripts": {
34
+ > "dev": "concurrently \"next dev\" \"agent-rules watch\""
35
+ > }
36
+ > }
37
+ > ```
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@routerhub/agent-rules",
3
- "version": "1.5.11",
3
+ "version": "1.5.12",
4
4
  "description": "Shared Copilot agent rules and guidelines for RouterHub projects",
5
5
  "main": "AGENTS.base.md",
6
6
  "bin": {