@agentsmd/preset-java 0.1.0 → 0.2.1
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/README.md +5 -4
- package/dist/index.d.ts +8 -8
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +19 -3
- package/dist/index.js.map +1 -1
- package/files/docs/lint-and-ci.md +2 -10
- package/files/docs/project-direction.md +1 -1
- package/package.json +2 -3
- package/files/AGENTS.md +0 -34
- package/files/CLAUDE.md +0 -3
package/README.md
CHANGED
|
@@ -1,11 +1,12 @@
|
|
|
1
1
|
# @agentsmd/preset-java
|
|
2
2
|
|
|
3
|
-
[
|
|
3
|
+
[`@agentsmd/cli`](https://www.npmjs.com/package/@agentsmd/cli)의 Java·Gradle 프리셋입니다.
|
|
4
4
|
|
|
5
5
|
```bash
|
|
6
|
-
npx agentsmd init --preset java
|
|
6
|
+
npx @agentsmd/cli init --preset git,java # Git 작업 규칙과 함께
|
|
7
|
+
npx @agentsmd/cli init --preset java # Java 규칙만
|
|
7
8
|
```
|
|
8
9
|
|
|
9
|
-
-
|
|
10
|
+
- Java 코드 규칙 문서: 코드 스타일, 클린 코드 원칙과 예시, Java 체크리스트
|
|
10
11
|
- palantir-java-format(Spotless) 커밋 검사, Gradle CI
|
|
11
|
-
- [
|
|
12
|
+
- Git 작업 규칙은 [Git 프리셋](https://www.npmjs.com/package/@agentsmd/preset-git)을 함께 고르면 더해집니다. `AGENTS.md`는 고른 프리셋에 맞춰 만들어집니다.
|
package/dist/index.d.ts
CHANGED
|
@@ -2,20 +2,20 @@
|
|
|
2
2
|
* Java·Gradle 프로젝트용 프리셋.
|
|
3
3
|
*
|
|
4
4
|
* Java 코드 규칙 문서, Spotless(palantir-java-format) 커밋 검사, Gradle CI를 담는다.
|
|
5
|
-
* Git 작업 규칙은
|
|
5
|
+
* Git 작업 규칙은 Git 프리셋을 함께 고르면 더해진다.
|
|
6
6
|
* `files/`는 빌드 결과(dist/)와 소스(src/) 어디서 실행해도 패키지 루트 기준으로 같은 위치다.
|
|
7
7
|
*/
|
|
8
8
|
export declare const javaPreset: {
|
|
9
9
|
name: string;
|
|
10
|
-
requires: {
|
|
11
|
-
name: string;
|
|
12
|
-
description: string;
|
|
13
|
-
filesDir: string;
|
|
14
|
-
hooksPath: string;
|
|
15
|
-
nextSteps: string[];
|
|
16
|
-
}[];
|
|
17
10
|
description: string;
|
|
18
11
|
filesDir: string;
|
|
12
|
+
hooksPath: string;
|
|
13
|
+
docs: {
|
|
14
|
+
path: string;
|
|
15
|
+
when: string;
|
|
16
|
+
}[];
|
|
17
|
+
rules: string[];
|
|
18
|
+
verify: string;
|
|
19
19
|
nextSteps: string[];
|
|
20
20
|
};
|
|
21
21
|
//# sourceMappingURL=index.d.ts.map
|
package/dist/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAGA;;;;;;GAMG;AACH,eAAO,MAAM,UAAU;;;;;;;;;;;;CA0BL,CAAC"}
|
package/dist/index.js
CHANGED
|
@@ -1,17 +1,33 @@
|
|
|
1
1
|
import { fileURLToPath } from "node:url";
|
|
2
|
-
import { gitPreset } from "@agentsmd/preset-git";
|
|
3
2
|
/**
|
|
4
3
|
* Java·Gradle 프로젝트용 프리셋.
|
|
5
4
|
*
|
|
6
5
|
* Java 코드 규칙 문서, Spotless(palantir-java-format) 커밋 검사, Gradle CI를 담는다.
|
|
7
|
-
* Git 작업 규칙은
|
|
6
|
+
* Git 작업 규칙은 Git 프리셋을 함께 고르면 더해진다.
|
|
8
7
|
* `files/`는 빌드 결과(dist/)와 소스(src/) 어디서 실행해도 패키지 루트 기준으로 같은 위치다.
|
|
9
8
|
*/
|
|
10
9
|
export const javaPreset = {
|
|
11
10
|
name: "java",
|
|
12
|
-
requires: [gitPreset],
|
|
13
11
|
description: "Java·Gradle 프로젝트용 지침, 커밋 훅, Spotless·Gradle CI",
|
|
14
12
|
filesDir: fileURLToPath(new URL("../files", import.meta.url)),
|
|
13
|
+
// Spotless 검사(pre-commit.d/spotless)를 연결한다.
|
|
14
|
+
hooksPath: ".githooks",
|
|
15
|
+
docs: [
|
|
16
|
+
{
|
|
17
|
+
path: "docs/project-direction.md",
|
|
18
|
+
when: "모든 작업 시작 전 (필수). 범위 밖 작업이면 먼저 질문",
|
|
19
|
+
},
|
|
20
|
+
{ path: "docs/code-style.md", when: "코드 작성, 주석" },
|
|
21
|
+
{ path: "docs/clean-code.md", when: "코드 작성, 설계" },
|
|
22
|
+
{ path: "docs/clean-code-examples.md", when: "코드 작성 시 참고 예시" },
|
|
23
|
+
{ path: "docs/java-checklist.md", when: "Java 코드 작성·리뷰" },
|
|
24
|
+
{ path: "docs/lint-and-ci.md", when: "훅·린트·CI 설정" },
|
|
25
|
+
],
|
|
26
|
+
rules: [
|
|
27
|
+
"코드에는 의도를 설명하는 주석을 적극적으로 단다.",
|
|
28
|
+
"포맷은 손으로 맞추지 않는다. 커밋 전 `./gradlew spotlessApply`.",
|
|
29
|
+
],
|
|
30
|
+
verify: "./gradlew spotlessCheck build",
|
|
15
31
|
nextSteps: [
|
|
16
32
|
"docs/project-direction.md 에 프로젝트 목표와 범위를 채우세요.",
|
|
17
33
|
"Gradle 프로젝트라면 docs/lint-and-ci.md 의 Spotless 설정을 build.gradle.kts 에 추가하세요.",
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAGzC;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG;IACxB,IAAI,EAAE,MAAM;IACZ,WAAW,EAAE,gDAAgD;IAC7D,QAAQ,EAAE,aAAa,CAAC,IAAI,GAAG,CAAC,UAAU,EAAE,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC7D,4CAA4C;IAC5C,SAAS,EAAE,WAAW;IACtB,IAAI,EAAE;QACJ;YACE,IAAI,EAAE,2BAA2B;YACjC,IAAI,EAAE,kCAAkC;SACzC;QACD,EAAE,IAAI,EAAE,oBAAoB,EAAE,IAAI,EAAE,WAAW,EAAE;QACjD,EAAE,IAAI,EAAE,oBAAoB,EAAE,IAAI,EAAE,WAAW,EAAE;QACjD,EAAE,IAAI,EAAE,6BAA6B,EAAE,IAAI,EAAE,eAAe,EAAE;QAC9D,EAAE,IAAI,EAAE,wBAAwB,EAAE,IAAI,EAAE,eAAe,EAAE;QACzD,EAAE,IAAI,EAAE,qBAAqB,EAAE,IAAI,EAAE,YAAY,EAAE;KACpD;IACD,KAAK,EAAE;QACL,6BAA6B;QAC7B,kDAAkD;KACnD;IACD,MAAM,EAAE,+BAA+B;IACvC,SAAS,EAAE;QACT,gDAAgD;QAChD,4EAA4E;KAC7E;CACe,CAAC"}
|
|
@@ -2,14 +2,13 @@
|
|
|
2
2
|
|
|
3
3
|
## Git 훅
|
|
4
4
|
|
|
5
|
-
|
|
6
|
-
Java 프리셋은 포맷
|
|
5
|
+
`.githooks/pre-commit` 이 `.githooks/pre-commit.d/` 의 검사를 이름 순서로 실행한다.
|
|
6
|
+
Java 프리셋은 포맷 검사를 넣는다. Git 프리셋을 함께 설치했다면 커밋 형식·파일 수 검사도 같이 돈다.
|
|
7
7
|
|
|
8
8
|
| 파일 | 검사 |
|
|
9
9
|
| --- | --- |
|
|
10
10
|
| `.githooks/pre-commit.d/spotless` | `gradlew` 가 있고 `.java` 가 스테이징됐으면 `spotlessCheck` |
|
|
11
11
|
|
|
12
|
-
- 공통 `pre-commit` 훅이 파일 수를 검사한 뒤 이 스크립트를 실행한다.
|
|
13
12
|
- 클론한 뒤 훅이 동작하지 않으면 `git config core.hooksPath .githooks` 로 연결한다.
|
|
14
13
|
- `--no-verify` 금지.
|
|
15
14
|
|
|
@@ -51,10 +50,3 @@ spotless {
|
|
|
51
50
|
|
|
52
51
|
- 커밋 규칙(파일 수, 메시지 형식)은 CI 에서 검사하지 않는다. 로컬 훅만 검사한다.
|
|
53
52
|
- 버전을 올릴 때는 이 문서의 스니펫과 CI 를 같이 고친다.
|
|
54
|
-
|
|
55
|
-
## 에이전트 설정
|
|
56
|
-
|
|
57
|
-
[.claude/settings.json](../.claude/settings.json)
|
|
58
|
-
|
|
59
|
-
- 커밋·PR 의 AI 서명(Co-Authored-By 등) 비활성화
|
|
60
|
-
- 훅 우회, force push, main 직접 push 명령 차단
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@agentsmd/preset-java",
|
|
3
|
-
"version": "0.1
|
|
3
|
+
"version": "0.2.1",
|
|
4
4
|
"description": "Java·Gradle 프로젝트용 AI 작업 지침 프리셋 (코드 규칙 문서, Spotless 커밋 검사, Gradle CI)",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"agents.md",
|
|
@@ -36,8 +36,7 @@
|
|
|
36
36
|
"access": "public"
|
|
37
37
|
},
|
|
38
38
|
"dependencies": {
|
|
39
|
-
"@agentsmd/core": "0.1
|
|
40
|
-
"@agentsmd/preset-git": "0.1.0"
|
|
39
|
+
"@agentsmd/core": "0.2.1"
|
|
41
40
|
},
|
|
42
41
|
"scripts": {
|
|
43
42
|
"build": "tsc -p tsconfig.build.json",
|
package/files/AGENTS.md
DELETED
|
@@ -1,34 +0,0 @@
|
|
|
1
|
-
# AGENTS.md
|
|
2
|
-
|
|
3
|
-
에이전트 작업 지침의 진입점. 작업 전 이 파일을 읽고, 작업 종류에 맞는 문서를 연다.
|
|
4
|
-
|
|
5
|
-
## 문서 지도
|
|
6
|
-
|
|
7
|
-
| 문서 | 읽는 시점 |
|
|
8
|
-
| --- | --- |
|
|
9
|
-
| [docs/project-direction.md](docs/project-direction.md) | 모든 작업 시작 전 (필수). 범위 밖 작업이면 먼저 질문 |
|
|
10
|
-
| [docs/workflow.md](docs/workflow.md) | 모든 작업 시작 전 (필수) |
|
|
11
|
-
| [docs/git-conventions.md](docs/git-conventions.md) | 이슈·브랜치·커밋·PR·머지 |
|
|
12
|
-
| [docs/code-review.md](docs/code-review.md) | PR 리뷰 확인·반영 |
|
|
13
|
-
| [docs/code-style.md](docs/code-style.md) | 코드 작성, 주석 |
|
|
14
|
-
| [docs/clean-code.md](docs/clean-code.md) | 코드 작성, 설계 |
|
|
15
|
-
| [docs/clean-code-examples.md](docs/clean-code-examples.md) | 코드 작성 시 참고 예시 |
|
|
16
|
-
| [docs/java-checklist.md](docs/java-checklist.md) | Java 코드 작성·리뷰 |
|
|
17
|
-
| [docs/lint-and-ci.md](docs/lint-and-ci.md) | 훅·린트·CI 설정 |
|
|
18
|
-
| [docs/writing-style.md](docs/writing-style.md) | md 문서, 커밋·PR 메시지 작성 |
|
|
19
|
-
|
|
20
|
-
## 핵심 규칙
|
|
21
|
-
|
|
22
|
-
1. 커밋 하나 = 책임 하나, 파일 5개 이하.
|
|
23
|
-
2. 커밋 1개 후 작업을 멈추고 사용자 피드백을 기다린다.
|
|
24
|
-
3. PR 은 한 가지 목적만 담는다.
|
|
25
|
-
4. 커밋·PR 메시지는 사람이 쓴 것처럼 짧게 쓴다. AI 서명 금지.
|
|
26
|
-
5. 코드에는 의도를 설명하는 주석을 적극적으로 단다.
|
|
27
|
-
6. 훅 우회(`--no-verify`) 금지.
|
|
28
|
-
|
|
29
|
-
## 지침 관리
|
|
30
|
-
|
|
31
|
-
- 지침 추가·변경 요청은 메모리에 저장하지 않는다. 이 파일이나 `docs/` 에 반영한다.
|
|
32
|
-
- 새 문서를 만들면 위 문서 지도에 한 줄 추가한다.
|
|
33
|
-
- 문서 수정도 같은 커밋 규칙을 따른다.
|
|
34
|
-
- 문서 문체는 [docs/writing-style.md](docs/writing-style.md) 를 따른다.
|
package/files/CLAUDE.md
DELETED