soft6096/jee-forge / skill/build-standards
build-standards
Verified约束 AI 生成构建配置的规范集(Maven pom/依赖管理/多模块结构)。编写 pom.xml、添加依赖、设计多模块结构、解决依赖冲突时必须加载本 skill。触发场景:写 pom、加依赖、拆模块、依赖版本管理、依赖冲突、Maven 配置、多模块工程结构、接口模块配 springdoc/knife4j、日志框架 Logback/Log4j2 依赖。代码生成完成后的依赖核对见 check-standards skill(HIGH
| File | Kind | Size |
|---|---|---|
| README.md | markdown | 2.5 KB |
| SKILL.md | skill md | 1.9 KB |
| standards/dependency-standards.md | markdown | 6.9 KB |
| standards/maven-standards.md | markdown | 6.0 KB |
| standards/module-standards.md | markdown | 2.7 KB |
standards/maven-standards.md
View on GitHub# Maven 构建规范 (Maven Standards)
## 适用范围
编写/审查 pom.xml、构建配置、插件管理时加载。面向 Maven 多模块 Java 项目。
## 强制规则
### 1. pom 结构
- 继承统一父 pom(项目父或公司级 parent),版本集中在父 pom `dependencyManagement` 管理
- 子模块 pom 不写版本号(从父 pom 继承),避免版本散落
- 坐标规范:`groupId` 公司域名反写 + 项目名,`artifactId` 模块名,`version` 由父 pom 统一
```xml
<!-- 父 pom:统一版本 -->
<dependencyManagement>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-dependencies</artifactId>
<version>3.2.5</version>
<type>pom</type>
<scope>import</scope>
</dependency>
<dependency>
<groupId>com.example</groupId>
<artifactId>common-core</artifactId>
<version>${revision}</version>
</dependency>
</dependencies>
</dependencyManagement>
```
### 2. 版本管理
- 版本号不硬编码散落各模块 — 集中在父 pom `<properties>`(`${spring-boot.version}`)或 `dependencyManagement`
- 第三方依赖版本用 BOM 导入(Spring Boot BOM、MyBatis-Plus starter BOM),不逐个写版本
- 版本升级:父 pom 单点改,禁止子模块各自升
- 插件版本同样集中在 `pluginManagement`,子模块不重复写版本
### 3. 插件管理
- 常用插件进父 pom `pluginManagement`:`maven-compiler-plugin`、`spring-boot-maven-plugin`;`maven-surefire-plugin`(测试执行插件)**按需引入**——仅当项目已有测试需要执行时才管理
- 统一 Java 版本:`maven.compiler.source/target` 或 `<release>`,全模块一致
```xml
<properties>
<java.version>17</java.version>
<maven.compiler.release>17</maven.compiler.release>
</properties>
```
- 资源过滤/打包插件按需启用,不装无用插件(构建提速 + 维护面小)
> [!NOTE] `maven-surefire-plugin` 为按需项
> 本框架**默认不生成 Java 测试代码**,surefire 只负责执行测试、默认不产生价值——新项目无测试需求时无需在 `pluginManagement` 显式管理它;需要运行时行为验证时用 **test-workflow** 按需生成外部验收工具(不依赖 surefire)。仅当项目已有测试(如存量项目)需要执行时才管理该插件。
### 4. profile 环境
- 环境差异(dev/test/prod)用 `<profile>` + `application-{env}.yml`,不写死构建参数
- profile 内配置:构建资源目录、过滤属性、环境特定依赖
- 默认 profile 为 dev,生产构建显式 `-P prod`
### 5. 禁止事项
- ❌ 子模块各自写版本号(版本散落,升级漏改)
- ❌ 依赖不声明 scope 或默认 compile 乱用
- ❌ 版本冲突不处理直接 `mvn dependency:tree` 排查
- ❌ 重复引入同一依赖不同版本(依赖收敛,见 dependency 规范)
- ❌ 构建产物(target/)提交 git
### 6. 代码格式化(Spotless,推荐)
生成项目如要与团队编码风格(4 空格 / K&R / 120 列)保持一致,推荐引入 **Spotless** + **Eclipse JDT formatter**:一次格式化即可消除大量格式类违规(缩进、空格、空行、行尾、import 顺序 / 未使用 import、花括号风格)。
- 插件版本走父 pom `pluginManagement`;格式化配置随 jee-forge 提供:`java-code-standards/assets/eclipse-formatter.xml`(使用时拷入项目,如 `config/eclipse-formatter.xml`)
- **消除的格式类**:缩进 / 空格 / 空行 / 行尾空白(`trimTrailingWhitespace`)/ import 顺序 / 未使用 import / 花括号风格(Eclipse formatter)
- `<importOrder/>` 用 Spotless 默认顺序;如需严格对齐 jee-forge(static → 自身 → 第三方),改为 `<importOrder><order>…</order></importOrder>`(语法见 Spotless 文档)
- 提交前 / CI:`mvn spotless:apply`(自动修)、`mvn spotless:check`(校验不通过则构建失败)
- 可选 `<ratchetFrom>` 只格式化分支改动文件,避免全量重排
> [!NOTE] 未实测提示
> 本机(维护者环境)未跑 Maven,以上插件片段与 formatter 配置**未在真实项目实测**;接入后请先在项目里跑一次 `mvn spotless:apply` 确认(`eclipse-formatter.xml` 的 `profiles version` 需与本机 Spotless 的 Eclipse 版本兼容)。
```xml
<plugin>
<groupId>com.diffplug.spotless</groupId>
<artifactId>spotless-maven-plugin</artifactId>
<version>${spotless.version}</version>
<configuration>
<java>
<eclipse>
<file>${project.basedir}/config/eclipse-formatter.xml</file>
</eclipse>
<removeUnusedImports/>
<forbidWildcardImports/>
<importOrder/>
<trimTrailingWhitespace/>
</java>
</configuration>
</plugin>
```
> [!NOTE] 许可与分发
> Spotless 为 Apache-2.0;Eclipse JDT formatter 引擎在构建时由 Spotless 拉取。本仓**只提供自写的格式化配置**(`assets/eclipse-formatter.xml`),**不随仓分发任何工具 jar**(Checkstyle / SpotBugs / Eclipse 引擎均不打包),无再分发义务;仅以文字引用规则名称与工具名。
## 反例 / 正例
```xml
<!-- 反例:子模块硬编码版本 + 无版本管理 -->
<dependency>
<groupId>com.google.guava</groupId>
<artifactId>guava</artifactId>
<version>33.0.0-jre</version> <!-- 版本散落 -->
</dependency>
```
```xml
<!-- 正例:版本在父 pom 管理,子模块省略 version -->
<dependency>
<groupId>com.google.guava</groupId>
<artifactId>guava</artifactId>
</dependency>
```
## 自检清单
- [ ] 版本集中在父 pom(properties / dependencyManagement)
- [ ] 第三方版本走 BOM
- [ ] 插件版本统一管理
- [ ] Java 版本全模块一致
- [ ] 环境差异用 profile
- [ ] target/ 未提交 git
- [ ] 如需格式化:已配 Spotless + jee-forge `assets/eclipse-formatter.xml`,`mvn spotless:apply` 通过;未打包任何外部工具 jar
Related skills
| Skill | Stars | Updated | Works with | Status | Install |
|---|---|---|---|---|---|
| reverse-engineer-anythingmorluto/reaReverse engineer native, managed, Electron/JavaScript, packaged, firmware, and browser targets with REA, and build agent environments (AgentEnv bundles) of web applications from a live instance or a capture, and of Linux desktop apps with a task from a request. Use shipped-artifact or requested runtime evidence to explain features, compare versions, decompile code, or guide a reconstruction. Skip REA for ordinary source-repository architecture analysis. | Stars: 472k | Updated | Claude CodeCodex | Verified | Install |
| diagnosing-superpowersobra/superpowersUse when a superpowers session went wrong and your human partner wants to know why — repeated work, ignored plans, stumbles, poor results, a skill that didn't fire, "it took too long", "why is it so expensive", "what is it doing" — or wants to build a bug report for the superpowers maintainers, for the current session or a past one identified by id or path, on any harness. | Stars: 322k | Updated | Claude CodeCodex | Verified | Install |
| dispatching-parallel-agentsobra/superpowersUse when facing 2+ independent tasks that can be worked on without shared state or sequential dependencies | Stars: 322k | Updated | Claude CodeCodex | Verified | Install |
| executing-plansobra/superpowersUse when executing an implementation plan in the current session as the implementer yourself — your human partner chose inline execution, or no subagent tool is available | Stars: 322k | Updated | Claude CodeCodex | Verified | Install |