gorig-cli 1.0.24 → 1.0.25

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.
Files changed (73) hide show
  1. package/README.md +112 -22
  2. package/commands/create.js +267 -112
  3. package/commands/doc.js +21 -8
  4. package/commands/init.js +316 -255
  5. package/commands/skill.js +55 -17
  6. package/package.json +1 -1
  7. package/templates/config.go.ejs +6 -5
  8. package/templates/config.yaml.ejs +3 -38
  9. package/templates/controller.go.ejs +11 -42
  10. package/templates/crud.controller.go.ejs +71 -0
  11. package/templates/crud.doc.md.ejs +60 -0
  12. package/templates/crud.dto.go.ejs +103 -0
  13. package/templates/crud.integration.init_test.go.ejs +17 -0
  14. package/templates/crud.integration_test.go.ejs +66 -0
  15. package/templates/crud.model.go.ejs +25 -0
  16. package/templates/crud.module.README.md.ejs +70 -0
  17. package/templates/crud.mongo.config.yaml.ejs +19 -0
  18. package/templates/crud.mysql.config.yaml.ejs +14 -0
  19. package/templates/crud.router.go.ejs +18 -0
  20. package/templates/crud.service.go.ejs +179 -0
  21. package/templates/crud.test.go.ejs +52 -0
  22. package/templates/dto.go.ejs +16 -0
  23. package/templates/gitignore.ejs +18 -49
  24. package/templates/hello.controller.go.ejs +19 -0
  25. package/templates/hello.router.go.ejs +12 -0
  26. package/templates/hello.service.go.ejs +31 -0
  27. package/templates/hello.test.go.ejs +34 -0
  28. package/templates/init.go.ejs +1 -27
  29. package/templates/main.go.ejs +2 -5
  30. package/templates/model.go.ejs +3 -4
  31. package/templates/project.README.md.ejs +35 -0
  32. package/templates/router.go.ejs +4 -8
  33. package/templates/service.go.ejs +25 -77
  34. package/templates/skills/gorig-backend/SKILL.md +89 -0
  35. package/templates/skills/gorig-backend/agents/openai.yaml +4 -0
  36. package/templates/skills/gorig-backend/assets/api-doc-template.md +59 -0
  37. package/templates/skills/gorig-backend/assets/gorig.gitignore +65 -0
  38. package/templates/skills/gorig-backend/assets/module-readme-template.md +58 -0
  39. package/templates/skills/gorig-backend/references/advanced-data-access.md +275 -0
  40. package/templates/skills/gorig-backend/references/auth-security.md +194 -0
  41. package/templates/skills/gorig-backend/references/business-scenarios.md +155 -0
  42. package/templates/skills/gorig-backend/references/cache.md +301 -0
  43. package/templates/skills/gorig-backend/references/capability-matrix.md +37 -0
  44. package/templates/skills/gorig-backend/references/configuration.md +48 -0
  45. package/templates/skills/gorig-backend/references/framework-api.md +190 -0
  46. package/templates/skills/gorig-backend/references/messaging.md +143 -0
  47. package/templates/skills/gorig-backend/references/onboarding-files.md +46 -0
  48. package/templates/skills/gorig-backend/references/outbound-http.md +162 -0
  49. package/templates/skills/gorig-backend/references/persistent-crud.md +332 -0
  50. package/templates/skills/gorig-backend/references/project-bootstrap.md +128 -0
  51. package/templates/skills/gorig-backend/references/scheduled-tasks.md +231 -0
  52. package/templates/skills/gorig-backend/references/service-lifecycle.md +51 -0
  53. package/templates/skills/gorig-backend/references/source-map.md +43 -0
  54. package/templates/skills/gorig-backend/references/source-policy.md +58 -0
  55. package/templates/skills/gorig-backend/references/sse.md +121 -0
  56. package/templates/skills/gorig-backend/references/testing.md +171 -0
  57. package/templates/skills/gorig-backend/scripts/check-source-links.sh +48 -0
  58. package/templates/skills/gorig-backend/scripts/detect-gorig-context.sh +67 -0
  59. package/templates/skills/gorig-backend/scripts/verify-basic-project.sh +108 -0
  60. package/npm_publish copy.sh +0 -65
  61. package/templates/internal.go.ejs +0 -49
  62. package/templates/req.go.ejs +0 -8
  63. package/templates/resp.go.ejs +0 -8
  64. package/templates/service.pub.go.ejs +0 -22
  65. package/templates/skills/claude/gorig-backend/SKILL.md +0 -766
  66. package/templates/skills/claude/gorig-backend/assets/api-doc-template.md +0 -50
  67. package/templates/skills/claude/gorig-backend/assets/module-readme-template.md +0 -46
  68. package/templates/skills/claude/gorig-backend/references/onboarding-files.md +0 -44
  69. package/templates/skills/codex/gorig-backend/SKILL.md +0 -766
  70. package/templates/skills/codex/gorig-backend/agents/openai.yaml +0 -4
  71. package/templates/skills/codex/gorig-backend/assets/api-doc-template.md +0 -50
  72. package/templates/skills/codex/gorig-backend/assets/module-readme-template.md +0 -46
  73. package/templates/skills/codex/gorig-backend/references/onboarding-files.md +0 -44
@@ -1,50 +0,0 @@
1
- # <module> API 文档
2
-
3
- ## 1. 模块说明
4
- - 模块名:
5
- - 业务目标:
6
- - 依赖服务/存储:
7
-
8
- ## 2. 接口清单
9
- | 名称 | 方法 | 路径 | 鉴权 | 说明 |
10
- | --- | --- | --- | --- | --- |
11
- | | | | | |
12
-
13
- ## 3. 接口详情
14
-
15
- ### 3.1 <接口名>
16
- - 方法与路径:
17
- - Controller:
18
- - Service:
19
- - 说明:
20
-
21
- #### 请求参数
22
- | 字段 | 类型 | 必填 | 说明 |
23
- | --- | --- | --- | --- |
24
- | | | | |
25
-
26
- #### 响应示例
27
- ```json
28
- {
29
- "code": 0,
30
- "msg": "ok",
31
- "data": {}
32
- }
33
- ```
34
-
35
- #### 错误码
36
- | code | 含义 | 触发场景 |
37
- | --- | --- | --- |
38
- | | | |
39
-
40
- ## 4. 调用样例
41
- ```bash
42
- curl -X POST 'http://<host>/<path>' \
43
- -H 'Content-Type: application/json' \
44
- -d '{}'
45
- ```
46
-
47
- ## 5. 变更记录
48
- | 日期 | 变更人 | 说明 |
49
- | --- | --- | --- |
50
- | | | |
@@ -1,46 +0,0 @@
1
- # <module> 模块说明
2
-
3
- ## 1. 模块职责
4
- - 目标:
5
- - 边界:
6
- - 非目标:
7
-
8
- ## 2. 目录结构
9
- ```text
10
- domain/<module>/
11
- ├── router.go
12
- ├── controller.go
13
- ├── service.go
14
- └── model/
15
- ```
16
-
17
- ## 3. 请求处理流程
18
- 1. Router 注册入口与中间件。
19
- 2. Controller 参数处理、panic 保护、返回封装。
20
- 3. Service 业务逻辑与错误处理。
21
- 4. Model 或 dx 数据访问。
22
-
23
- ## 4. 数据模型
24
- | 结构体 | 说明 | 关键字段 |
25
- | --- | --- | --- |
26
- | | | |
27
-
28
- ## 5. 对外接口
29
- | 名称 | 方法 | 路径 | 说明 |
30
- | --- | --- | --- | --- |
31
- | | | | |
32
-
33
- ## 6. 错误与日志
34
- - 错误定义位置:
35
- - 常见错误码:
36
- - 日志关键字段:
37
-
38
- ## 7. 测试与验证
39
- - 单测:
40
- - 集成测试:
41
- - 手工验证步骤:
42
-
43
- ## 8. 维护约定
44
- - 命名:
45
- - 兼容性:
46
- - 文档更新规则:
@@ -1,44 +0,0 @@
1
- # Onboarding File Checklist
2
-
3
- Read these files before implementation.
4
-
5
- ## gorig framework files
6
- - `AGENTS.md`
7
- - `README.md`
8
- - `bootstrap/startup.go`
9
- - `httpx/serv.go`
10
- - `httpx/tool.go`
11
- - `apix/handle.go`
12
- - `apix/params.go`
13
- - `domainx/*`
14
- - `domainx/dx/*`
15
- - `serv/serv.go`
16
- - `utils/errors/*`
17
- - `utils/logger/*`
18
- - `cache/cache.go`
19
- - `cronx/cron.go`
20
- - `mid/messagex/broker.go`
21
- - `mid/messagex/serv.go`
22
- - `httpx/mid.sse.go`
23
- - `test/dx_test.go`
24
- - `test/cache_test.go`
25
- - `test/cron_test.go`
26
- - `test/message_test.go`
27
- - `test/ssex_test.go`
28
- - `test/gin_mid_test.go`
29
-
30
- ## User project files
31
- Read the user's own project before implementation. Look for:
32
- - Entry point: `_cmd/api/main.go` or `simple/main.go`
33
- - Domain init: `domain/init.go`
34
- - Existing modules: `domain/**/router.go`, `domain/**/controller.go`, `domain/**/service.go`, `domain/**/model/*.go`
35
- - Existing tests: `test/*`
36
-
37
- If the project does not follow this layout, ask the user where modules live before proceeding.
38
-
39
- ## Reading Strategy
40
- 1. Trace startup and service registration.
41
- 2. Trace a complete request path: router -> controller -> service -> model/dx.
42
- 3. Confirm panic handling, param binding, and response helpers in real code.
43
- 4. Confirm error and logger usage from existing modules.
44
- 5. Reuse existing patterns before introducing new abstractions.