@pennixrv/trellis 0.7.0-beta.46 → 0.7.0-beta.48
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/dist/cli/index.d.ts.map +1 -1
- package/dist/cli/index.js +35 -0
- package/dist/cli/index.js.map +1 -1
- package/dist/commands/backup.d.ts +20 -0
- package/dist/commands/backup.d.ts.map +1 -0
- package/dist/commands/backup.js +122 -0
- package/dist/commands/backup.js.map +1 -0
- package/dist/commands/channel/rm.d.ts.map +1 -1
- package/dist/commands/channel/rm.js +203 -91
- package/dist/commands/channel/rm.js.map +1 -1
- package/dist/commands/update.d.ts.map +1 -1
- package/dist/commands/update.js +10 -4
- package/dist/commands/update.js.map +1 -1
- package/dist/commands/workflow.js +1 -1
- package/dist/commands/workflow.js.map +1 -1
- package/dist/migrations/manifests/0.7.0-beta.47.json +9 -0
- package/dist/migrations/manifests/0.7.0-beta.48.json +9 -0
- package/dist/templates/codex/hooks/session-start.py +6 -6
- package/dist/templates/copilot/hooks/session-start.py +6 -6
- package/dist/templates/markdown/spec/backend/database-guidelines.md.txt +22 -22
- package/dist/templates/markdown/spec/backend/directory-structure.md.txt +20 -20
- package/dist/templates/markdown/spec/backend/error-handling.md.txt +22 -22
- package/dist/templates/markdown/spec/backend/index.md.txt +19 -19
- package/dist/templates/markdown/spec/backend/logging-guidelines.md.txt +22 -22
- package/dist/templates/markdown/spec/backend/quality-guidelines.md.txt +22 -22
- package/dist/templates/markdown/spec/frontend/component-guidelines.md.txt +25 -25
- package/dist/templates/markdown/spec/frontend/directory-structure.md.txt +20 -20
- package/dist/templates/markdown/spec/frontend/hook-guidelines.md.txt +22 -22
- package/dist/templates/markdown/spec/frontend/index.md.txt +20 -20
- package/dist/templates/markdown/spec/frontend/quality-guidelines.md.txt +22 -22
- package/dist/templates/markdown/spec/frontend/state-management.md.txt +22 -22
- package/dist/templates/markdown/spec/frontend/type-safety.md.txt +22 -22
- package/dist/templates/markdown/spec/guides/code-reuse-thinking-guide.md.txt +80 -85
- package/dist/templates/markdown/spec/guides/cross-layer-thinking-guide.md.txt +164 -209
- package/dist/templates/markdown/spec/guides/cross-platform-thinking-guide.md.txt +161 -185
- package/dist/templates/markdown/spec/guides/index.md.txt +51 -51
- package/dist/templates/markdown/workspace-index.md +44 -44
- package/dist/templates/opencode/lib/session-utils.js +2 -2
- package/dist/templates/shared-hooks/session-start.py +7 -7
- package/dist/templates/trellis/scripts/add_session.py +35 -32
- package/dist/templates/trellis/scripts/common/developer.py +18 -18
- package/dist/templates/trellis/scripts/common/task_store.py +11 -11
- package/dist/templates/trellis/scripts/common/workflow_phase.py +4 -3
- package/dist/templates/trellis/workflow.md +403 -458
- package/package.json +2 -2
|
@@ -1,51 +1,51 @@
|
|
|
1
|
-
# Database Guidelines
|
|
1
|
+
# 数据库指南(Database Guidelines)
|
|
2
2
|
|
|
3
|
-
>
|
|
3
|
+
> 本项目的数据库模式与约定。
|
|
4
4
|
|
|
5
5
|
---
|
|
6
6
|
|
|
7
|
-
## Overview
|
|
7
|
+
## 概览(Overview)
|
|
8
8
|
|
|
9
9
|
<!--
|
|
10
|
-
|
|
10
|
+
在此记录项目的数据库约定。
|
|
11
11
|
|
|
12
|
-
|
|
13
|
-
-
|
|
14
|
-
-
|
|
15
|
-
-
|
|
16
|
-
-
|
|
12
|
+
需要回答的问题:
|
|
13
|
+
- 使用什么 ORM/查询库?
|
|
14
|
+
- 如何管理迁移?
|
|
15
|
+
- 表名和列名遵循什么命名约定?
|
|
16
|
+
- 如何处理事务?
|
|
17
17
|
-->
|
|
18
18
|
|
|
19
|
-
|
|
19
|
+
(待团队填写)
|
|
20
20
|
|
|
21
21
|
---
|
|
22
22
|
|
|
23
|
-
## Query Patterns
|
|
23
|
+
## 查询模式(Query Patterns)
|
|
24
24
|
|
|
25
|
-
<!--
|
|
25
|
+
<!-- 查询应如何编写?如何执行批量操作? -->
|
|
26
26
|
|
|
27
|
-
|
|
27
|
+
(待团队填写)
|
|
28
28
|
|
|
29
29
|
---
|
|
30
30
|
|
|
31
|
-
## Migrations
|
|
31
|
+
## 迁移(Migrations)
|
|
32
32
|
|
|
33
|
-
<!--
|
|
33
|
+
<!-- 如何创建和运行迁移 -->
|
|
34
34
|
|
|
35
|
-
|
|
35
|
+
(待团队填写)
|
|
36
36
|
|
|
37
37
|
---
|
|
38
38
|
|
|
39
|
-
## Naming Conventions
|
|
39
|
+
## 命名约定(Naming Conventions)
|
|
40
40
|
|
|
41
|
-
<!--
|
|
41
|
+
<!-- 表名、列名和索引名 -->
|
|
42
42
|
|
|
43
|
-
|
|
43
|
+
(待团队填写)
|
|
44
44
|
|
|
45
45
|
---
|
|
46
46
|
|
|
47
|
-
## Common Mistakes
|
|
47
|
+
## 常见错误(Common Mistakes)
|
|
48
48
|
|
|
49
|
-
<!--
|
|
49
|
+
<!-- 团队曾经出现过的数据库相关错误 -->
|
|
50
50
|
|
|
51
|
-
|
|
51
|
+
(待团队填写)
|
|
@@ -1,26 +1,26 @@
|
|
|
1
|
-
# Directory Structure
|
|
1
|
+
# 目录结构(Directory Structure)
|
|
2
2
|
|
|
3
|
-
>
|
|
3
|
+
> 本项目如何组织后端代码。
|
|
4
4
|
|
|
5
5
|
---
|
|
6
6
|
|
|
7
|
-
## Overview
|
|
7
|
+
## 概览(Overview)
|
|
8
8
|
|
|
9
9
|
<!--
|
|
10
|
-
|
|
10
|
+
在此记录项目的后端目录结构。
|
|
11
11
|
|
|
12
|
-
|
|
13
|
-
-
|
|
14
|
-
-
|
|
15
|
-
-
|
|
16
|
-
-
|
|
12
|
+
需要回答的问题:
|
|
13
|
+
- 模块/包如何组织?
|
|
14
|
+
- 业务逻辑位于何处?
|
|
15
|
+
- API 端点在哪里定义?
|
|
16
|
+
- 工具和辅助函数如何组织?
|
|
17
17
|
-->
|
|
18
18
|
|
|
19
|
-
|
|
19
|
+
(待团队填写)
|
|
20
20
|
|
|
21
21
|
---
|
|
22
22
|
|
|
23
|
-
## Directory Layout
|
|
23
|
+
## 目录布局(Directory Layout)
|
|
24
24
|
|
|
25
25
|
```
|
|
26
26
|
<!-- Replace with your actual structure -->
|
|
@@ -31,24 +31,24 @@ src/
|
|
|
31
31
|
|
|
32
32
|
---
|
|
33
33
|
|
|
34
|
-
## Module Organization
|
|
34
|
+
## 模块组织(Module Organization)
|
|
35
35
|
|
|
36
|
-
<!--
|
|
36
|
+
<!-- 新功能/模块应如何组织? -->
|
|
37
37
|
|
|
38
|
-
|
|
38
|
+
(待团队填写)
|
|
39
39
|
|
|
40
40
|
---
|
|
41
41
|
|
|
42
|
-
## Naming Conventions
|
|
42
|
+
## 命名约定(Naming Conventions)
|
|
43
43
|
|
|
44
|
-
<!--
|
|
44
|
+
<!-- 文件和目录的命名规则 -->
|
|
45
45
|
|
|
46
|
-
|
|
46
|
+
(待团队填写)
|
|
47
47
|
|
|
48
48
|
---
|
|
49
49
|
|
|
50
|
-
## Examples
|
|
50
|
+
## 示例(Examples)
|
|
51
51
|
|
|
52
|
-
<!--
|
|
52
|
+
<!-- 链接到组织良好的模块作为示例 -->
|
|
53
53
|
|
|
54
|
-
|
|
54
|
+
(待团队填写)
|
|
@@ -1,51 +1,51 @@
|
|
|
1
|
-
# Error Handling
|
|
1
|
+
# 错误处理(Error Handling)
|
|
2
2
|
|
|
3
|
-
>
|
|
3
|
+
> 本项目如何处理错误。
|
|
4
4
|
|
|
5
5
|
---
|
|
6
6
|
|
|
7
|
-
## Overview
|
|
7
|
+
## 概览(Overview)
|
|
8
8
|
|
|
9
9
|
<!--
|
|
10
|
-
|
|
10
|
+
在此记录项目的错误处理约定。
|
|
11
11
|
|
|
12
|
-
|
|
13
|
-
-
|
|
14
|
-
-
|
|
15
|
-
-
|
|
16
|
-
-
|
|
12
|
+
需要回答的问题:
|
|
13
|
+
- 定义了哪些错误类型?
|
|
14
|
+
- 错误如何传播?
|
|
15
|
+
- 错误如何记录日志?
|
|
16
|
+
- 如何向客户端返回错误?
|
|
17
17
|
-->
|
|
18
18
|
|
|
19
|
-
|
|
19
|
+
(待团队填写)
|
|
20
20
|
|
|
21
21
|
---
|
|
22
22
|
|
|
23
|
-
## Error Types
|
|
23
|
+
## 错误类型(Error Types)
|
|
24
24
|
|
|
25
|
-
<!--
|
|
25
|
+
<!-- 自定义错误类/类型 -->
|
|
26
26
|
|
|
27
|
-
|
|
27
|
+
(待团队填写)
|
|
28
28
|
|
|
29
29
|
---
|
|
30
30
|
|
|
31
|
-
## Error Handling Patterns
|
|
31
|
+
## 错误处理模式(Error Handling Patterns)
|
|
32
32
|
|
|
33
|
-
<!--
|
|
33
|
+
<!-- try-catch 模式、错误传播方式 -->
|
|
34
34
|
|
|
35
|
-
|
|
35
|
+
(待团队填写)
|
|
36
36
|
|
|
37
37
|
---
|
|
38
38
|
|
|
39
|
-
## API Error Responses
|
|
39
|
+
## API 错误响应(API Error Responses)
|
|
40
40
|
|
|
41
|
-
<!--
|
|
41
|
+
<!-- 标准错误响应格式 -->
|
|
42
42
|
|
|
43
|
-
|
|
43
|
+
(待团队填写)
|
|
44
44
|
|
|
45
45
|
---
|
|
46
46
|
|
|
47
|
-
## Common Mistakes
|
|
47
|
+
## 常见错误(Common Mistakes)
|
|
48
48
|
|
|
49
|
-
<!--
|
|
49
|
+
<!-- 团队曾经出现过的错误处理问题 -->
|
|
50
50
|
|
|
51
|
-
|
|
51
|
+
(待团队填写)
|
|
@@ -1,38 +1,38 @@
|
|
|
1
|
-
# Backend Development Guidelines
|
|
1
|
+
# 后端开发指南(Backend Development Guidelines)
|
|
2
2
|
|
|
3
|
-
>
|
|
3
|
+
> 本项目的后端开发最佳实践。
|
|
4
4
|
|
|
5
5
|
---
|
|
6
6
|
|
|
7
|
-
## Overview
|
|
7
|
+
## 概览(Overview)
|
|
8
8
|
|
|
9
|
-
|
|
9
|
+
本目录包含后端开发指南。请在各文件中填写项目的具体约定。
|
|
10
10
|
|
|
11
11
|
---
|
|
12
12
|
|
|
13
|
-
## Guidelines Index
|
|
13
|
+
## 指南索引(Guidelines Index)
|
|
14
14
|
|
|
15
|
-
| Guide | Description | Status |
|
|
15
|
+
| 指南(Guide) | 说明(Description) | 状态(Status) |
|
|
16
16
|
|-------|-------------|--------|
|
|
17
|
-
| [Directory Structure](./directory-structure.md) |
|
|
18
|
-
| [Database Guidelines](./database-guidelines.md) | ORM
|
|
19
|
-
| [Error Handling](./error-handling.md) |
|
|
20
|
-
| [Quality Guidelines](./quality-guidelines.md) |
|
|
21
|
-
| [Logging Guidelines](./logging-guidelines.md) |
|
|
17
|
+
| [目录结构(Directory Structure)](./directory-structure.md) | 模块组织和文件布局 | 待填写 |
|
|
18
|
+
| [数据库指南(Database Guidelines)](./database-guidelines.md) | ORM 模式、查询和迁移 | 待填写 |
|
|
19
|
+
| [错误处理(Error Handling)](./error-handling.md) | 错误类型和处理策略 | 待填写 |
|
|
20
|
+
| [质量指南(Quality Guidelines)](./quality-guidelines.md) | 代码标准和禁止模式 | 待填写 |
|
|
21
|
+
| [日志指南(Logging Guidelines)](./logging-guidelines.md) | 结构化日志和日志级别 | 待填写 |
|
|
22
22
|
|
|
23
23
|
---
|
|
24
24
|
|
|
25
|
-
## How to Fill These Guidelines
|
|
25
|
+
## 如何填写这些指南(How to Fill These Guidelines)
|
|
26
26
|
|
|
27
|
-
|
|
27
|
+
对于每个指南文件:
|
|
28
28
|
|
|
29
|
-
1.
|
|
30
|
-
2.
|
|
31
|
-
3.
|
|
32
|
-
4.
|
|
29
|
+
1. 记录项目的**实际约定**,而不是理想状态
|
|
30
|
+
2. 包含代码库中的**代码示例**
|
|
31
|
+
3. 列出**禁止模式**及其原因
|
|
32
|
+
4. 补充团队曾经出现过的**常见错误**
|
|
33
33
|
|
|
34
|
-
|
|
34
|
+
目标是帮助 AI 助手和新团队成员理解项目的实际工作方式。
|
|
35
35
|
|
|
36
36
|
---
|
|
37
37
|
|
|
38
|
-
|
|
38
|
+
**语言(Language)**:所有文档默认使用**简体中文**。
|
|
@@ -1,51 +1,51 @@
|
|
|
1
|
-
# Logging Guidelines
|
|
1
|
+
# 日志指南(Logging Guidelines)
|
|
2
2
|
|
|
3
|
-
>
|
|
3
|
+
> 本项目如何记录日志。
|
|
4
4
|
|
|
5
5
|
---
|
|
6
6
|
|
|
7
|
-
## Overview
|
|
7
|
+
## 概览(Overview)
|
|
8
8
|
|
|
9
9
|
<!--
|
|
10
|
-
|
|
10
|
+
在此记录项目的日志约定。
|
|
11
11
|
|
|
12
|
-
|
|
13
|
-
-
|
|
14
|
-
-
|
|
15
|
-
-
|
|
16
|
-
-
|
|
12
|
+
需要回答的问题:
|
|
13
|
+
- 使用什么日志库?
|
|
14
|
+
- 有哪些日志级别,分别何时使用?
|
|
15
|
+
- 应记录哪些内容?
|
|
16
|
+
- 哪些内容不应记录(个人身份信息、密钥)?
|
|
17
17
|
-->
|
|
18
18
|
|
|
19
|
-
|
|
19
|
+
(待团队填写)
|
|
20
20
|
|
|
21
21
|
---
|
|
22
22
|
|
|
23
|
-
## Log Levels
|
|
23
|
+
## 日志级别(Log Levels)
|
|
24
24
|
|
|
25
|
-
<!--
|
|
25
|
+
<!-- 各级别的使用场景:debug、info、warn、error -->
|
|
26
26
|
|
|
27
|
-
|
|
27
|
+
(待团队填写)
|
|
28
28
|
|
|
29
29
|
---
|
|
30
30
|
|
|
31
|
-
## Structured Logging
|
|
31
|
+
## 结构化日志(Structured Logging)
|
|
32
32
|
|
|
33
|
-
<!--
|
|
33
|
+
<!-- 日志格式和必填字段 -->
|
|
34
34
|
|
|
35
|
-
|
|
35
|
+
(待团队填写)
|
|
36
36
|
|
|
37
37
|
---
|
|
38
38
|
|
|
39
|
-
## What to Log
|
|
39
|
+
## 应记录的内容(What to Log)
|
|
40
40
|
|
|
41
|
-
<!--
|
|
41
|
+
<!-- 应记录的重要事件 -->
|
|
42
42
|
|
|
43
|
-
|
|
43
|
+
(待团队填写)
|
|
44
44
|
|
|
45
45
|
---
|
|
46
46
|
|
|
47
|
-
## What NOT to Log
|
|
47
|
+
## 不应记录的内容(What NOT to Log)
|
|
48
48
|
|
|
49
|
-
<!--
|
|
49
|
+
<!-- 敏感数据、个人身份信息和密钥 -->
|
|
50
50
|
|
|
51
|
-
|
|
51
|
+
(待团队填写)
|
|
@@ -1,51 +1,51 @@
|
|
|
1
|
-
# Quality Guidelines
|
|
1
|
+
# 质量指南(Quality Guidelines)
|
|
2
2
|
|
|
3
|
-
>
|
|
3
|
+
> 后端开发的代码质量标准。
|
|
4
4
|
|
|
5
5
|
---
|
|
6
6
|
|
|
7
|
-
## Overview
|
|
7
|
+
## 概览(Overview)
|
|
8
8
|
|
|
9
9
|
<!--
|
|
10
|
-
|
|
10
|
+
在此记录项目的质量标准。
|
|
11
11
|
|
|
12
|
-
|
|
13
|
-
-
|
|
14
|
-
-
|
|
15
|
-
-
|
|
16
|
-
-
|
|
12
|
+
需要回答的问题:
|
|
13
|
+
- 禁止哪些模式?
|
|
14
|
+
- 执行哪些 lint 规则?
|
|
15
|
+
- 有哪些测试要求?
|
|
16
|
+
- 适用哪些代码审查标准?
|
|
17
17
|
-->
|
|
18
18
|
|
|
19
|
-
|
|
19
|
+
(待团队填写)
|
|
20
20
|
|
|
21
21
|
---
|
|
22
22
|
|
|
23
|
-
## Forbidden Patterns
|
|
23
|
+
## 禁止模式(Forbidden Patterns)
|
|
24
24
|
|
|
25
|
-
<!--
|
|
25
|
+
<!-- 永远不应使用的模式及其原因 -->
|
|
26
26
|
|
|
27
|
-
|
|
27
|
+
(待团队填写)
|
|
28
28
|
|
|
29
29
|
---
|
|
30
30
|
|
|
31
|
-
## Required Patterns
|
|
31
|
+
## 必须遵守的模式(Required Patterns)
|
|
32
32
|
|
|
33
|
-
<!--
|
|
33
|
+
<!-- 必须始终使用的模式 -->
|
|
34
34
|
|
|
35
|
-
|
|
35
|
+
(待团队填写)
|
|
36
36
|
|
|
37
37
|
---
|
|
38
38
|
|
|
39
|
-
## Testing Requirements
|
|
39
|
+
## 测试要求(Testing Requirements)
|
|
40
40
|
|
|
41
|
-
<!--
|
|
41
|
+
<!-- 期望达到的测试层级 -->
|
|
42
42
|
|
|
43
|
-
|
|
43
|
+
(待团队填写)
|
|
44
44
|
|
|
45
45
|
---
|
|
46
46
|
|
|
47
|
-
## Code Review Checklist
|
|
47
|
+
## 代码审查清单(Code Review Checklist)
|
|
48
48
|
|
|
49
|
-
<!--
|
|
49
|
+
<!-- 审查者应检查的内容 -->
|
|
50
50
|
|
|
51
|
-
|
|
51
|
+
(待团队填写)
|
|
@@ -1,59 +1,59 @@
|
|
|
1
|
-
# Component Guidelines
|
|
1
|
+
# 组件指南(Component Guidelines)
|
|
2
2
|
|
|
3
|
-
>
|
|
3
|
+
> 本项目如何构建组件。
|
|
4
4
|
|
|
5
5
|
---
|
|
6
6
|
|
|
7
|
-
## Overview
|
|
7
|
+
## 概览(Overview)
|
|
8
8
|
|
|
9
9
|
<!--
|
|
10
|
-
|
|
10
|
+
在此记录项目的组件约定。
|
|
11
11
|
|
|
12
|
-
|
|
13
|
-
-
|
|
14
|
-
-
|
|
15
|
-
-
|
|
16
|
-
-
|
|
12
|
+
需要回答的问题:
|
|
13
|
+
- 使用哪些组件模式?
|
|
14
|
+
- 如何定义 props?
|
|
15
|
+
- 如何处理组合?
|
|
16
|
+
- 适用哪些无障碍标准?
|
|
17
17
|
-->
|
|
18
18
|
|
|
19
|
-
|
|
19
|
+
(待团队填写)
|
|
20
20
|
|
|
21
21
|
---
|
|
22
22
|
|
|
23
|
-
## Component Structure
|
|
23
|
+
## 组件结构(Component Structure)
|
|
24
24
|
|
|
25
|
-
<!--
|
|
25
|
+
<!-- 组件文件的标准结构 -->
|
|
26
26
|
|
|
27
|
-
|
|
27
|
+
(待团队填写)
|
|
28
28
|
|
|
29
29
|
---
|
|
30
30
|
|
|
31
|
-
## Props Conventions
|
|
31
|
+
## Props 约定(Props Conventions)
|
|
32
32
|
|
|
33
|
-
<!--
|
|
33
|
+
<!-- props 应如何定义和声明类型 -->
|
|
34
34
|
|
|
35
|
-
|
|
35
|
+
(待团队填写)
|
|
36
36
|
|
|
37
37
|
---
|
|
38
38
|
|
|
39
|
-
## Styling Patterns
|
|
39
|
+
## 样式模式(Styling Patterns)
|
|
40
40
|
|
|
41
|
-
<!--
|
|
41
|
+
<!-- 如何应用样式(CSS modules、styled-components、Tailwind 等) -->
|
|
42
42
|
|
|
43
|
-
|
|
43
|
+
(待团队填写)
|
|
44
44
|
|
|
45
45
|
---
|
|
46
46
|
|
|
47
|
-
## Accessibility
|
|
47
|
+
## 无障碍(Accessibility)
|
|
48
48
|
|
|
49
|
-
<!-- A11y
|
|
49
|
+
<!-- A11y 要求和模式 -->
|
|
50
50
|
|
|
51
|
-
|
|
51
|
+
(待团队填写)
|
|
52
52
|
|
|
53
53
|
---
|
|
54
54
|
|
|
55
|
-
## Common Mistakes
|
|
55
|
+
## 常见错误(Common Mistakes)
|
|
56
56
|
|
|
57
|
-
<!--
|
|
57
|
+
<!-- 团队曾经出现过的组件相关错误 -->
|
|
58
58
|
|
|
59
|
-
|
|
59
|
+
(待团队填写)
|
|
@@ -1,26 +1,26 @@
|
|
|
1
|
-
# Directory Structure
|
|
1
|
+
# 目录结构(Directory Structure)
|
|
2
2
|
|
|
3
|
-
>
|
|
3
|
+
> 本项目如何组织前端代码。
|
|
4
4
|
|
|
5
5
|
---
|
|
6
6
|
|
|
7
|
-
## Overview
|
|
7
|
+
## 概览(Overview)
|
|
8
8
|
|
|
9
9
|
<!--
|
|
10
|
-
|
|
10
|
+
在此记录项目的前端目录结构。
|
|
11
11
|
|
|
12
|
-
|
|
13
|
-
-
|
|
14
|
-
-
|
|
15
|
-
-
|
|
16
|
-
-
|
|
12
|
+
需要回答的问题:
|
|
13
|
+
- 组件位于何处?
|
|
14
|
+
- 功能/模块如何组织?
|
|
15
|
+
- 共享工具位于何处?
|
|
16
|
+
- 资源如何组织?
|
|
17
17
|
-->
|
|
18
18
|
|
|
19
|
-
|
|
19
|
+
(待团队填写)
|
|
20
20
|
|
|
21
21
|
---
|
|
22
22
|
|
|
23
|
-
## Directory Layout
|
|
23
|
+
## 目录布局(Directory Layout)
|
|
24
24
|
|
|
25
25
|
```
|
|
26
26
|
<!-- Replace with your actual structure -->
|
|
@@ -31,24 +31,24 @@ src/
|
|
|
31
31
|
|
|
32
32
|
---
|
|
33
33
|
|
|
34
|
-
## Module Organization
|
|
34
|
+
## 模块组织(Module Organization)
|
|
35
35
|
|
|
36
|
-
<!--
|
|
36
|
+
<!-- 新功能应如何组织? -->
|
|
37
37
|
|
|
38
|
-
|
|
38
|
+
(待团队填写)
|
|
39
39
|
|
|
40
40
|
---
|
|
41
41
|
|
|
42
|
-
## Naming Conventions
|
|
42
|
+
## 命名约定(Naming Conventions)
|
|
43
43
|
|
|
44
|
-
<!--
|
|
44
|
+
<!-- 文件和目录的命名规则 -->
|
|
45
45
|
|
|
46
|
-
|
|
46
|
+
(待团队填写)
|
|
47
47
|
|
|
48
48
|
---
|
|
49
49
|
|
|
50
|
-
## Examples
|
|
50
|
+
## 示例(Examples)
|
|
51
51
|
|
|
52
|
-
<!--
|
|
52
|
+
<!-- 链接到组织良好的模块作为示例 -->
|
|
53
53
|
|
|
54
|
-
|
|
54
|
+
(待团队填写)
|
|
@@ -1,51 +1,51 @@
|
|
|
1
|
-
# Hook Guidelines
|
|
1
|
+
# Hook 指南(Hook Guidelines)
|
|
2
2
|
|
|
3
|
-
>
|
|
3
|
+
> 本项目如何使用 Hook。
|
|
4
4
|
|
|
5
5
|
---
|
|
6
6
|
|
|
7
|
-
## Overview
|
|
7
|
+
## 概览(Overview)
|
|
8
8
|
|
|
9
9
|
<!--
|
|
10
|
-
|
|
10
|
+
在此记录项目的 Hook 约定。
|
|
11
11
|
|
|
12
|
-
|
|
13
|
-
-
|
|
14
|
-
-
|
|
15
|
-
-
|
|
16
|
-
-
|
|
12
|
+
需要回答的问题:
|
|
13
|
+
- 有哪些自定义 Hook?
|
|
14
|
+
- 如何处理数据获取?
|
|
15
|
+
- 遵循哪些命名约定?
|
|
16
|
+
- 如何共享有状态逻辑?
|
|
17
17
|
-->
|
|
18
18
|
|
|
19
|
-
|
|
19
|
+
(待团队填写)
|
|
20
20
|
|
|
21
21
|
---
|
|
22
22
|
|
|
23
|
-
## Custom Hook Patterns
|
|
23
|
+
## 自定义 Hook 模式(Custom Hook Patterns)
|
|
24
24
|
|
|
25
|
-
<!--
|
|
25
|
+
<!-- 如何创建和组织自定义 Hook -->
|
|
26
26
|
|
|
27
|
-
|
|
27
|
+
(待团队填写)
|
|
28
28
|
|
|
29
29
|
---
|
|
30
30
|
|
|
31
|
-
## Data Fetching
|
|
31
|
+
## 数据获取(Data Fetching)
|
|
32
32
|
|
|
33
|
-
<!--
|
|
33
|
+
<!-- 如何处理数据获取(React Query、SWR 等) -->
|
|
34
34
|
|
|
35
|
-
|
|
35
|
+
(待团队填写)
|
|
36
36
|
|
|
37
37
|
---
|
|
38
38
|
|
|
39
|
-
## Naming Conventions
|
|
39
|
+
## 命名约定(Naming Conventions)
|
|
40
40
|
|
|
41
|
-
<!-- Hook
|
|
41
|
+
<!-- Hook 命名规则(use* 等) -->
|
|
42
42
|
|
|
43
|
-
|
|
43
|
+
(待团队填写)
|
|
44
44
|
|
|
45
45
|
---
|
|
46
46
|
|
|
47
|
-
## Common Mistakes
|
|
47
|
+
## 常见错误(Common Mistakes)
|
|
48
48
|
|
|
49
|
-
<!-- Hook
|
|
49
|
+
<!-- 团队曾经出现过的 Hook 相关错误 -->
|
|
50
50
|
|
|
51
|
-
|
|
51
|
+
(待团队填写)
|