@deepstorm/cli 0.3.1 → 0.3.3

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.js CHANGED
@@ -7285,6 +7285,14 @@ function copyFragmentsForSkill(skillId, srcDir, config, registry2, targetDir) {
7285
7285
  );
7286
7286
  }
7287
7287
  }
7288
+ const allFiles = fs10.readdirSync(srcPath);
7289
+ for (const file of allFiles) {
7290
+ if (file === ".DS_Store") continue;
7291
+ if (file === "quick-reference.md") continue;
7292
+ if (file === "examples") continue;
7293
+ if (!file.endsWith(".md")) continue;
7294
+ fs10.cpSync(path6.join(srcPath, file), path6.join(targetDir, file), { force: true });
7295
+ }
7288
7296
  }
7289
7297
  }
7290
7298
  function copyReferencesForSkill(srcDir, targetDir) {
@@ -0,0 +1,97 @@
1
+ #!/bin/bash
2
+ # reef-code-style-verify.sh.tmpl
3
+ # PostToolUse: 在 Edit/Write 后自动验证代码风格
4
+ #
5
+ # 模板变量(安装时由 wizard 注入):
6
+ # {{reef.backend.java.lintCmd}} — Java lint 命令(默认 checkstyle)
7
+ # {{reef.backend.python.lintCmd}} — Python lint 命令(默认 ruff check)
8
+ # {{reef.frontend.lintCmd}} — 前端 lint 命令(默认 eslint)
9
+
10
+ set -euo pipefail
11
+
12
+ # ── 1. 获取文件路径 ──────────────────────────────────────────────────
13
+ filepath=""
14
+
15
+ if [ -p /dev/stdin ] && command -v jq &>/dev/null; then
16
+ filepath=$(jq -r '.tool_response.filePath // .tool_input.file_path // ""' 2>/dev/null || true)
17
+ fi
18
+
19
+ if [ -z "$filepath" ] || [ "$filepath" = "null" ]; then
20
+ filepath="${CLAUDE_CODE_TOOL_RESULT_FILEPATH:-}"
21
+ fi
22
+
23
+ [ -z "$filepath" ] && exit 0
24
+ [ ! -f "$filepath" ] && exit 0
25
+
26
+ PROJECT_DIR="${CLAUDE_PROJECT_DIR:-$(pwd)}"
27
+
28
+ JAVA_LINT="{{reef.backend.java.lintCmd}}"
29
+ PYTHON_LINT="{{reef.backend.python.lintCmd}}"
30
+ TS_LINT="{{reef.frontend.lintCmd}}"
31
+
32
+ # ── ESLint 配置检测 ───────────────────────────────────────────────────
33
+ has_eslint_config() {
34
+ [ -f "$PROJECT_DIR/eslint.config.js" ] || \
35
+ [ -f "$PROJECT_DIR/eslint.config.mjs" ] || \
36
+ [ -f "$PROJECT_DIR/.eslintrc.js" ] || \
37
+ [ -f "$PROJECT_DIR/.eslintrc.json" ] || \
38
+ [ -f "$PROJECT_DIR/.eslintrc" ]
39
+ }
40
+
41
+ # ── 2. 按文件类型执行验证 ────────────────────────────────────────────
42
+
43
+ case "$filepath" in
44
+ *.java)
45
+ # Java: checkstyle(如果项目配置了 checkstyle.xml)
46
+ if [ "$JAVA_LINT" != "none" ] && command -v "${JAVA_LINT%% *}" &>/dev/null; then
47
+ for conf in "$PROJECT_DIR/checkstyle.xml" "$PROJECT_DIR/config/checkstyle/checkstyle.xml"; do
48
+ if [ -f "$conf" ]; then
49
+ output=$($JAVA_LINT -c "$conf" "$filepath" 2>&1 | grep -iE "error|warning" | head -20 || true)
50
+ if [ -n "$output" ]; then
51
+ echo "[style-verify] ⚠ Java 代码风格问题:"
52
+ echo "$output"
53
+ echo "[style-verify] 运行 $JAVA_LINT -c $conf $filepath 查看完整报告。"
54
+ fi
55
+ fi
56
+ done
57
+ fi
58
+ ;;
59
+
60
+ *.py)
61
+ # Python: ruff check
62
+ if [ "$PYTHON_LINT" != "none" ] && command -v "${PYTHON_LINT%% *}" &>/dev/null; then
63
+ output=$($PYTHON_LINT "$filepath" 2>/dev/null || true)
64
+ if [ -n "$output" ]; then
65
+ echo "[style-verify] ⚠ Python 代码风格问题:"
66
+ echo "$output" | head -20
67
+ echo "[style-verify] 请使用 $PYTHON_LINT $filepath 查看完整报告。"
68
+ fi
69
+ fi
70
+ ;;
71
+
72
+ *.ts|*.tsx|*.js|*.jsx)
73
+ # TypeScript/JavaScript: eslint
74
+ if [ "$TS_LINT" != "none" ] && command -v npx &>/dev/null && has_eslint_config; then
75
+ output=$(cd "$PROJECT_DIR" && npx $TS_LINT "$filepath" 2>/dev/null || true)
76
+ if [ -n "$output" ]; then
77
+ echo "[style-verify] ⚠ TypeScript/JavaScript 代码风格问题:"
78
+ echo "$output" | head -20
79
+ echo "[style-verify] 请运行 npx $TS_LINT $filepath 查看完整报告。"
80
+ fi
81
+ fi
82
+ ;;
83
+
84
+ *.html|*.css|*.scss|*.less)
85
+ # 前端模板/样式文件:eslint(如果项目已配置)
86
+ if [ "$TS_LINT" != "none" ] && command -v npx &>/dev/null && has_eslint_config; then
87
+ output=$(cd "$PROJECT_DIR" && npx $TS_LINT "$filepath" 2>/dev/null || true)
88
+ if [ -n "$output" ]; then
89
+ echo "[style-verify] ⚠ 前端文件代码风格问题:"
90
+ echo "$output" | head -10
91
+ echo "[style-verify] 请运行 npx $TS_LINT $filepath 查看完整报告。"
92
+ fi
93
+ fi
94
+ ;;
95
+ esac
96
+
97
+ exit 0
@@ -30,7 +30,7 @@
30
30
  {
31
31
  "type": "prompt",
32
32
  "timeout": 5,
33
- "prompt": "You are about to write or edit a file. If the target file extension is .java, load reef-style-backend skill for coding standards. If the target is .ts, .html, .css, .scss, or .less, load reef-style-frontend skill for coding standards. Follow the loaded skill's rules in your output."
33
+ "prompt": "You are about to write or edit a source file. The following core rules apply based on the file extension. You MUST follow the relevant rules for your file type.\n\n## 🔴 Core Coding Rules (must follow)\n\n### Java\n1. Use @Getter @AllArgsConstructor for event/POJO classes; NEVER use @Data\n2. NEVER use @Autowired field injection; always use constructor injection (@RequiredArgsConstructor)\n3. Use abstract method instead of instanceof chain for type dispatch\n4. Use formatted() / Text Block for string formatting; never use + concatenation\n5. Use @RequiredArgsConstructor for Service/Controller; @Getter @NoArgsConstructor(access = PROTECTED) for Entity\n\n### Python\n1. Use f-strings; never use % or .format()\n2. snake_case for functions/variables; PascalCase for classes\n3. Always annotate return types and parameter types (mypy must pass)\n4. Use is / is not for None comparison; never use == None\n5. Use Enum / Protocol / abstract method instead of isinstance() chain\n\n### TypeScript\n1. Standalone + OnPush + inject() (Angular) / Function components + hooks (React) / <script setup lang=\"ts\"> (Vue)\n2. Use output() instead of @Output() (Angular) / custom hooks over lifecycle methods (React) / composables (Vue)\n3. Use signal() / computed() for reactive state management\n4. Use loadComponent for lazy-loaded routes\n5. Use interface for Props / Entity types\n\n## 📖 Full Reference\nLoad the reef-style-backend or reef-style-frontend skill for the complete coding standard.\n\n## Self-Verification\nBefore writing code, first output `✅ [STYLE] confirmed {language} rules` to acknowledge you have read and will follow the rules above."
34
34
  }
35
35
  ]
36
36
  }
@@ -45,6 +45,17 @@
45
45
  }
46
46
  ]
47
47
  },
48
+ {
49
+ "matcher": "Edit|Write",
50
+ "hooks": [
51
+ {
52
+ "type": "command",
53
+ "command": "bash .claude/hooks/reef-code-style-verify.sh",
54
+ "async": true,
55
+ "statusMessage": "Verifying code style..."
56
+ }
57
+ ]
58
+ },
48
59
  {
49
60
  "matcher": "Edit|Write",
50
61
  "hooks": [
@@ -562,6 +562,20 @@
562
562
  ]
563
563
  }
564
564
  ]
565
+ },
566
+ {
567
+ "key": "reef.backend.java.formatTool",
568
+ "label": "Java 格式化工具",
569
+ "type": "static",
570
+ "value": "google-java-format",
571
+ "template": {
572
+ "formatCmd": "google-java-format -i",
573
+ "lintCmd": "checkstyle"
574
+ },
575
+ "affectedTemplates": [
576
+ "hooks/reef-auto-format.sh.tmpl",
577
+ "hooks/reef-code-style-verify.sh.tmpl"
578
+ ]
565
579
  }
566
580
  ]
567
581
  },
@@ -951,13 +965,13 @@
951
965
  "hooks": [
952
966
  "reef-auto-format.sh",
953
967
  "reef-block-dangerous.sh",
968
+ "reef-code-style-verify.sh",
954
969
  "reef-intent-detect.sh",
955
970
  "reef-protect-files.sh",
956
971
  "reef-run-tests.sh",
957
972
  "reef-scope-check.sh",
958
973
  "reef-scope-ci.sh",
959
974
  "reef-scope-gate.sh",
960
- "reef-scope-pre-commit.sh",
961
975
  "reef-scope-setup.sh",
962
976
  "reef-scope-split.sh"
963
977
  ]
@@ -122,6 +122,7 @@ deepstorm:
122
122
  | `quick-reference.md` | **编码规范速查**。包含核心规则和约定 |
123
123
  | `{value}.md` | **维度规范**(如 `spring-boot.md`、`hibernate.md`)。按上方链接加载 |
124
124
  | `api-spec.md` | **API 规范**。RESTful 命名、统一响应体、版本策略、OpenAPI |
125
+ | `jackson-polymorphism.md` | **DTO 多态序列化规范**。Jackson `@JsonTypeInfo` + TS Discriminated Union |
125
126
  | `dependency-management.md` | **依赖管理规范**。Version Catalog、版本一致性、CVE |
126
127
  | `exception-handling.md` | **异常处理深度规范**。异常层次、错误码、全局处理 |
127
128
  | `security-redlines.md` | **安全红线**。P0/P1 安全规则及代码示例 |
@@ -0,0 +1,205 @@
1
+ # Jackson 多态序列化与 TypeScript 联合类型
2
+
3
+ > 适用于后端枚举驱动的图表类型分发 → Jackson `@JsonTypeInfo` 多态 + 前端 discriminated union 的模式。
4
+ > 目标:删除后端 `enum` + `chartType` 字段,改用抽象基类 + `@JsonProperty("type")` 实现自动分发。
5
+
6
+ ```mermaid
7
+ flowchart LR
8
+ A["后端 Java<br/>@JsonTypeInfo(property = &quot;type&quot;)<br/>@JsonSubTypes"] -->|"JSON 携带<br/>type 判别值"| B["前端 TypeScript<br/>Discriminated Union"]
9
+ B --> C["@switch(answer.chartView.type)<br/>类型自动窄化"]
10
+ ```
11
+
12
+ ---
13
+
14
+ ## 一、问题场景
15
+
16
+ 后端接口返回 JSON 中包含一个"类型"字段,前端根据该类型渲染不同的组件:
17
+
18
+ ```java
19
+ // ❌ 旧模式:枚举 + switch
20
+ public record MetricAnswer(ChartType chartType, ...) {}
21
+ public enum ChartType { METRIC_CARD, LINE_CHART, BAR_CHART, PIE_CHART }
22
+
23
+ // 前端每次新增类型都需要:
24
+ // 1. 加 enum 值
25
+ // 2. 改 switch
26
+ // 3. 不在同一个地方维护
27
+ ```
28
+
29
+ ## 二、推荐模式:Jackson 多态序列化
30
+
31
+ ### 2.1 后端
32
+
33
+ **步骤 1:定义抽象基类**
34
+
35
+ ```java
36
+ @JsonTypeInfo(use = JsonTypeInfo.Id.SIMPLE_NAME, property = "type")
37
+ @JsonSubTypes({
38
+ @JsonSubTypes.Type(value = MetricCardView.class, name = "MetricCardView"),
39
+ @JsonSubTypes.Type(value = LineChartView.class, name = "LineChartView"),
40
+ @JsonSubTypes.Type(value = BarChartView.class, name = "BarChartView"),
41
+ @JsonSubTypes.Type(value = PieChartView.class, name = "PieChartView"),
42
+ })
43
+ public abstract class ChartView {}
44
+ ```
45
+
46
+ - `property = "type"` — 序列化时自动在 JSON 中写入 `"type": "MetricCardView"` 等 discriminator
47
+ - `name = "..."` — discriminator 的值,应与 TypeScript 端 literal type 保持一致
48
+ - 新增类型只需:新建子类 + 注册到 `@JsonSubTypes`
49
+
50
+ **步骤 2:定义子类**
51
+
52
+ ```java
53
+ @JsonInclude(Include.NON_NULL)
54
+ public class MetricCardView extends ChartView {
55
+ private final String title;
56
+ private final Object value;
57
+ private final String unit;
58
+
59
+ public MetricCardView(String title, Object value, String unit) {
60
+ this.title = title;
61
+ this.value = value;
62
+ this.unit = unit;
63
+ }
64
+ // getters ...
65
+ }
66
+ ```
67
+
68
+ ```java
69
+ public class LineChartView extends ChartView {
70
+ private final String title;
71
+ @JsonProperty("xAxisName") private final String categoryAxisLabel;
72
+ @JsonProperty("yAxisName") private final String valueAxisLabel;
73
+ private final String seriesName;
74
+ private final List<ChartDataPoint> dataPoints;
75
+ // constructor + getters ...
76
+ }
77
+ ```
78
+
79
+ > **💡 Import 说明:**
80
+ > - `@JsonTypeInfo`、`@JsonSubTypes`、`@JsonInclude` 来自 `com.fasterxml.jackson.annotation.*`
81
+ > - `@JsonInclude(Include.NON_NULL)` 需导入 `com.fasterxml.jackson.annotation.JsonInclude.Include`
82
+ > - 或在注解中写全路径 `@JsonInclude(JsonInclude.Include.NON_NULL)`,无需额外 import
83
+
84
+ **步骤 3:替换枚举字段**
85
+
86
+ ```java
87
+ // ❌ 旧
88
+ public record MetricAnswer(ChartType chartType, ...) {}
89
+
90
+ // ✅ 新
91
+ public record MetricAnswer(ChartView chartView, ...) {}
92
+ ```
93
+
94
+ - 业务逻辑构建时直接 `return new PieChartView(...)` 而非 `return ChartType.PIE_CHART`
95
+ - 删除 `ChartType` 枚举文件
96
+
97
+ ### 2.2 前端(TypeScript)
98
+
99
+ **步骤 1:定义 Discriminated Union**
100
+
101
+ ```typescript
102
+ interface BaseChartView {
103
+ type: string;
104
+ }
105
+
106
+ export interface MetricCardView extends BaseChartView {
107
+ type: 'MetricCardView';
108
+ title: string;
109
+ value: unknown;
110
+ unit: string | null;
111
+ }
112
+
113
+ export interface LineChartView extends BaseChartView {
114
+ type: 'LineChartView';
115
+ title: string;
116
+ xAxisName: string;
117
+ yAxisName: string;
118
+ seriesName: string;
119
+ dataPoints: ChartDataPoint[];
120
+ }
121
+
122
+ export type ChartView = MetricCardView | LineChartView | BarChartView | PieChartView;
123
+ ```
124
+
125
+ **步骤 2:MetricAnswer 中使用联合类型**
126
+
127
+ ```typescript
128
+ export interface MetricAnswer {
129
+ // ...
130
+ chartView: ChartView | null; // ✅ 联合类型自动窄化
131
+ }
132
+ ```
133
+
134
+ **步骤 3:模板中使用 @switch**
135
+
136
+ ```html
137
+ @if (answer.chartView) {
138
+ @switch (answer.chartView.type) {
139
+ @case ('MetricCardView') {
140
+ <app-metric-card [answer]="answer" />
141
+ }
142
+ @case ('LineChartView') {
143
+ <app-line-chart [chartData]="answer.chartData" />
144
+ }
145
+ }
146
+ }
147
+ ```
148
+
149
+ ## 三、最佳实践
150
+
151
+ | 要点 | 说明 |
152
+ |------|------|
153
+ | `property = "type"` | discriminator 字段名使用 `"type"`(简短、通用),而非 `"chartType"` |
154
+ | 前后端 value 一致 | `@JsonSubTypes.Type(name = "MetricCardView")` 与 TS `type: 'MetricCardView'` 的值必须一致 |
155
+ | Checkstyle 兼容 | Jackson 字段名与 getter 名可以不同:`@JsonProperty("xAxisName") private String categoryAxisLabel` |
156
+ | 共享 DTO | 子类共享的嵌套类型(如 `ChartDataPoint`)定义为独立 `record` 或类 |
157
+ | 判空安全 | 模板中 `@if (answer.chartView)` 保护空值(如错误响应时 chartView 为 null) |
158
+ | 不删除旧 DTO 层 | `ChartData`、`gridResults`、`singleResults` 等依然存在,chartView 是新增的视图抽象,并非替代所有响应字段 |
159
+ | 删除前确认引用 | 删除旧枚举前 MUST 搜索全项目 Java + TypeScript 引用,确认 0 引用后方可删除 |
160
+
161
+ ## 四、效果对比
162
+
163
+ | 维度 | 旧模式(Enum) | 新模式(Polymorphism) |
164
+ |------|---------------|----------------------|
165
+ | 新增图表类型 | 枚举 + switch + 前端分支 | 新建子类 + 注册 `@JsonSubTypes` + TS 类型 |
166
+ | JSON 结构 | `{"chartType": "METRIC_CARD", ...}` | `{"chartView": {"type": "MetricCardView", ...}}` |
167
+ | TS 类型安全 | 手动维护 | 自动通过 discriminated union 窄化 |
168
+ | 后端字段数 | chartType + 具体数据各自校验 | chartView 自包含 |
169
+
170
+ ## 五、设计决策说明
171
+
172
+ ### 5.1 `property` 选择 `"type"` 而非 `"chartType"`
173
+
174
+ | 候选 | 理由 | 结论 |
175
+ |------|------|------|
176
+ | `"type"` | 简短通用,多态基类职责就是描述"是什么类型",与低代码项目 (`DatasetDto`) 一致 | ✅ |
177
+ | `"chartType"` | 业务含义明确,但限制了基类的可复用性。未来其他多态场景(如 `DataSourceConnector`)需要不同字段名 | ❌ |
178
+ | `"kind"` | Jackson 社区惯例使用 `"type"`,不应引入不必要的差异 | ❌ |
179
+
180
+ ### 5.2 discriminator 策略使用 `SIMPLE_NAME`
181
+
182
+ | 候选 | 理由 | 结论 |
183
+ |------|------|------|
184
+ | `SIMPLE_NAME` | 子类简名自描述,无需额外常量文件 | ✅ |
185
+ | `CLASS_NAME` | 全限定名过长,JSON 中不可读且暴露包结构 | ❌ |
186
+ | `CUSTOM` | 需要 `@JsonTypeIdResolver`,增加复杂度 | ❌ |
187
+
188
+ ### 5.3 使用 `@JsonSubTypes` 而非自定义序列化器
189
+
190
+ `@JsonSubTypes` 是 Jackson 原生支持,注解式声明最直观。`@JsonTypeIdResolver` 或自定义 `JsonSerializer` 提供更灵活的控制但需要大量模板代码,适用于更复杂的动态注册场景而非当前已知类型场景。
191
+
192
+ ### 5.4 前端 Discriminated Union 而非 Enum
193
+
194
+ TypeScript union type + `type` literal 可直接利用 `@switch` 的类型窄化能力,无需手动编写类型守卫函数。这与后端 enum 模式的维护成本形成鲜明对比。
195
+
196
+ ### 5.5 Checkstyle 冲突:`@JsonProperty` 解耦而非禁用规则
197
+
198
+ | 候选 | 理由 | 结论 |
199
+ |------|------|------|
200
+ | `@JsonProperty("xAxisName") private String categoryAxisLabel` | 字段名合规,getter 合规,JSON 输出保留 `xAxisName` | ✅ |
201
+ | 禁用 Checkstyle `ParameterNameCheck` | 全局禁用降低代码规范性 | ❌ |
202
+
203
+ ### 5.6 Decoder 对象保持 record
204
+
205
+ 如 `MetricAnswer` 是 Java record,不能继承。改造方案为直接替换字段类型(`ChartType chartType` → `ChartView chartView`),record 紧凑语法不受影响。构建逻辑从 `determineChartType()` 改为 `buildChartView()` 并返回具体子类。
@@ -146,3 +146,11 @@ MODULE: 2-4 个大写字母标识模块
146
146
  - `_100`-`_199`:资源状态错误(不存在、已存在、冲突)
147
147
  - `_200`-`_299`:权限错误
148
148
  - `_300`-`_399`:系统内部错误
149
+
150
+ ## DTO 多态序列化
151
+
152
+ 当接口中的 DTO 需要根据类型字段分发到不同子类时(如多种图表类型、多种数据源类型),参考 [DTO 多态序列化规范](jackson-polymorphism.md):
153
+
154
+ - 后端使用 Jackson `@JsonTypeInfo` + `@JsonSubTypes` 实现多态序列化
155
+ - 前端使用 TypeScript Discriminated Union 对应消费
156
+ - discriminator value 前后端严格一致
@@ -53,31 +53,8 @@ DTO 继承基类,写请求用独立 CreateRequest/UpdateRequest record。MapSt
53
53
 
54
54
  ### 异常处理
55
55
 
56
- | 异常 | HTTP | 场景 |
57
- | --- | --- | --- |
58
- | `NotFoundException` | 404 | 资源不存在 |
59
- | `AlreadyExistsException` | 409 | 重复创建 |
60
- | `InvalidArgumentException` | 400 | 参数校验失败 |
61
- | `PermissionDeniedException` | 403 | 无权限 |
62
- | `FailedPreconditionException` | 400 | 前置条件不满足 |
63
-
64
- 所有自定义异常通过 `@RestControllerAdvice` `GlobalExceptionHandler` 统一处理,返回 AIP-193 兼容的 `CustomError` 结构:
65
-
66
- ```java
67
- @RestControllerAdvice
68
- public class GlobalExceptionHandler {
69
- @ExceptionHandler(ResourceNotFoundException.class)
70
- public ResponseEntity<ErrorResponse> handleNotFound(ResourceNotFoundException ex) {
71
- return ResponseEntity.status(NOT_FOUND).body(new ErrorResponse(ex.getMessage()));
72
- }
73
- }
74
- ```
56
+ > 异常处理规范(异常继承层次、ErrorCode 枚举、GlobalExceptionHandler)参见 [异常处理规范](../exception-handling/quick-reference.md)。
75
57
 
76
58
  ### 安全编码规范
77
59
 
78
- - Controller 写操作接口必须加 `@PreAuthorize("hasAuthority('PERMISSION_NAME')")`,禁止在方法内硬编码权限字符串
79
- - 请求体参数加 `@Valid`,嵌套对象加 `@Valid`
80
- - DTO 中密码/token 用 `@JsonIgnore` 或从响应 DTO 中排除
81
- - 密码使用 `BCryptPasswordEncoder`
82
- - 禁止 `createNativeQuery`(绕过多租户 + SQL 注入风险)
83
- - `@Query` 始终使用命名参数(`:paramName`),不用 `?1` 位置参数
60
+ > 安全红线(密码存储、SQL 注入、敏感信息脱敏、文件上传等)参见 [安全红线](../security-redlines/quick-reference.md)
@@ -185,7 +185,8 @@ Java 15+ 的 Text Block 用于嵌入 JSON / SQL / XML / 模板等 DSL。缩进
185
185
  ```java
186
186
  // ✅ opening """ 后直接换行,内容相对 opening 行缩进 4 格
187
187
  // ✅ closing """ 决定 stripIndent() 的公共缩进基线
188
- var json = """
188
+ var json =
189
+ """
189
190
  {
190
191
  "name": "example",
191
192
  "value": 42,
@@ -194,7 +195,8 @@ var json = """
194
195
  """;
195
196
 
196
197
  // ✅ 嵌入 SQL:closing """ 与 SQL 内容的公共缩进最左列对齐
197
- var sql = """
198
+ var sql =
199
+ """
198
200
  SELECT u.id, u.name, r.role_name
199
201
  FROM users u
200
202
  JOIN user_roles r ON r.user_id = u.id
@@ -209,7 +211,8 @@ var message = """
209
211
  """.formatted(userName, orderId);
210
212
 
211
213
  // ✅ 空行可用 \s 占位避免 stripIndent 清空:
212
- var json = """
214
+ var json =
215
+ """
213
216
  {
214
217
  "title": "test",
215
218
  \s
@@ -219,9 +222,10 @@ var json = """
219
222
  ```
220
223
 
221
224
  **规范:**
222
- - `"""` 必须后跟换行,**禁止在同行放内容**
223
- - `closing """` 的缩进决定公共缩进基线,放在最后一行内容之下,与之缩进对齐
225
+
226
+ - `"""` **独立占一行**,后跟换行,禁止在同行放内容
227
+ - `closing """` **独立占一行**,其缩进决定公共缩进基线,放在最后一行内容之下与之对齐
224
228
  - 禁止 text block 与 `+` 拼接混用;需要变量替换统一用 `formatted()`
225
229
  - 短字符串(≤ 100 列单行)不使用 text block,直接使用普通字符串
226
230
  - `\s` 用于显式保留 text block 中的空行(避免 `stripIndent()` 把空行清空)
227
- ```
231
+
@@ -22,45 +22,31 @@
22
22
  | 字段注释 | Model/Entity/Event 加 `/** */`,DTO/Record 不加 |
23
23
  | 日志实体 | 继承 `LogEntry`(SINGLE_TABLE),不直接继承基类 |
24
24
  | 弃用 API | 编译警告中的 `@Deprecated` API 在同一次 PR 中替换为新 API |
25
- | 多行字符串 | 用 Text Block `"""..."""` + `formatted()` 嵌入 JSON/SQL/XML,禁止 `+` 拼接;详见 [code-wrapping.md](examples/code-wrapping.md) |
25
+ | 多行字符串 | 用 Text Block `"""..."""` + `formatted()` 嵌入 JSON/SQL/XML,禁止 `+` 拼接 |
26
26
 
27
27
  ## 代码风格
28
28
 
29
- ### 通用约定
30
-
31
- - 变量命名有意义,禁止单字母(循环计数器 `i`/`j`/`k` 除外)
32
- - 局部变量用 `var`
33
- - 字符串格式化用 `formatted()`,不用 `+` 拼接
34
- - 多态替代 `instanceof` 链做类型分发
35
- - 100 列折行,运算符/`.`/`::` 放行首。适用范围如下:
36
- - **代码结构**(方法调用、签名、表达式)严格执行 100 列
37
- - **Javadoc / 注释文本**以可读性优先,不硬断中文句子;仅单行 `/** ... */` 标记超长时拆成多行
38
- - **方法调用参数换行**:所有参数能在列宽内一行放完则一行,放不完则每个参数独立一行(不混合分组);详见 [code-wrapping.md](examples/code-wrapping.md)「方法调用参数换行」
39
- - 类内字段按用途逻辑分组,组间空行分隔,**禁止使用 `// ======`(或其他重复符号装饰)做视觉分隔线注释**。例如应避免 `// ========== 维度信息 ==========` 这种写法
40
- - 注释与代码逻辑块之间:相邻的两个 `// 注释 + 代码块` 之间用空行分隔,使每个逻辑块保持独立。
41
- ```java
42
- // 正确:逻辑块之间有空行
43
- // PROPORTION 饼图
44
- if (queryIntent == QueryIntent.PROPORTION) {
45
- return ChartType.PIE_CHART;
46
- }
47
-
48
- // GROUP_BY 柱状图
49
- if (queryIntent == QueryIntent.GROUP_BY) {
50
- return ChartType.BAR_CHART;
51
- }
52
- ```
53
- ```java
54
- // ❌ 错误:缺少分隔空行,两个逻辑块粘连
55
- // PROPORTION → 饼图
56
- if (queryIntent == QueryIntent.PROPORTION) {
57
- return ChartType.PIE_CHART;
58
- }
59
- // GROUP_BY → 柱状图
60
- if (queryIntent == QueryIntent.GROUP_BY) {
61
- return ChartType.BAR_CHART;
62
- }
63
- ```
29
+ ### LLM 常犯错误
30
+
31
+ > 📌 以下规则仅约束 LLM 容易跑偏的地方。LLM 天然写对的内容(命名、代码空行分隔等)不再列出。
32
+
33
+ - 局部变量优先用 `var`,避免冗余的类型声明
34
+ - 字符串格式化用 `formatted()` / Text Block,不用 `+` 拼接
35
+ - 用多态 / Abstract Method 替代 `instanceof` 链做类型分发
36
+
37
+ ### Lombok 使用规范
38
+
39
+ | 组件类型 | 必用注解 | 说明 |
40
+ |---------|---------|------|
41
+ | 领域事件 / POJO | `@Getter @AllArgsConstructor` | `private final` 不可变,不手写 getter/constructor(见下方示例) |
42
+ | JPA Entity | `@Getter @NoArgsConstructor(access = PROTECTED)` + `@SuperBuilder`(按需) | 详见 [Hibernate 规范](hibernate.md) |
43
+ | Service / Controller | `@AllArgsConstructor` / `@RequiredArgsConstructor` | 构造函数注入,不用 `@Autowired` 字段注入 |
44
+ | 只读 DTO / Record 替代 | `@Value` | 不可变对象,自动生成 equals/hashCode/toString。Record 更简洁时优先用 record |
45
+
46
+ **禁止事项:**
47
+ - `@Data` — 自动生成 `@Setter` 破坏不可变性,且 `@EqualsAndHashCode` 在有 JPA 代理时行为不可预期
48
+ - `@Setter` on Entity — 破坏封装,业务状态变更应通过行为方法表达
49
+ - `@Autowired` 字段注入 必须用构造函数注入
64
50
 
65
51
  ### 控件能力声明模式(Capability Pattern)
66
52
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@deepstorm/cli",
3
- "version": "0.3.1",
3
+ "version": "0.3.3",
4
4
  "description": "DeepStorm CLI — 一键配置项目开发环境",
5
5
  "license": "MIT",
6
6
  "author": "billkang",