[Feat] .editorconfig 생성 및 PR/Issue 템플릿 수정, 테스트 관련 gradle 설정 복구 #31
Conversation
|
Caution Review failedThe pull request is closed. 📝 WalkthroughWalkthrough프로젝트에 광범위한 Changes
Sequence Diagram(s)sequenceDiagram
autonumber
participant Test as Task:test
participant Snippets as build/generated-snippets
participant Asciidoctor as Task:asciidoctor
participant BootJar as Task:bootJar
Note over Test,Snippets: 테스트 실행 → REST Docs 스니펫 생성
Test->>Snippets: outputs.dir(snippetsDir)
Test-->>Asciidoctor: 테스트 완료 (asciidoctor dependsOn test)
Asciidoctor->>Snippets: inputs.dir(snippetsDir)
Asciidoctor->>Asciidoctor: .adoc → HTML/docs 변환
Asciidoctor-->>BootJar: 변환 완료 (bootJar dependsOn asciidoctor)
BootJar->>Asciidoctor: from(asciidoctor.outputDir) 복사하여 포함
Note over BootJar: 최종 JAR에 static/docs 포함
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Possibly related PRs
Poem
Pre-merge checks and finishing touches✅ Passed checks (5 passed)
📜 Recent review detailsConfiguration used: Path: .coderabbit.yaml Review profile: ASSERTIVE Plan: Pro 📒 Files selected for processing (2)
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Fix all issues with AI Agents
In @.editorconfig:
- Line 6: The .editorconfig currently sets insert_final_newline = false which
causes POSIX non-compliance and tool conflicts; change the setting to
insert_final_newline = true in the .editorconfig file so files end with a
newline; update the single entry for insert_final_newline (search for the key
name "insert_final_newline") and commit the change so Git diffs, Prettier/ESLint
and build tools stop reporting missing end-of-file newlines.
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (1)
.editorconfig
🔇 Additional comments (2)
.editorconfig (2)
14-14:ij_visual_guides빈 값 의도 확인 필요현재
ij_visual_guides =설정이 값 없이 비어있습니다. 이것이 의도적으로 모든 시각 가이드를 비활성화하려는 것인지, 아니면 완성되지 않은 설정인지 확인이 필요합니다.명시적으로 가이드를 비활성화하려면 현재 형태가 맞지만, 특정 컬럼에 가이드를 표시하려면 (예:
120,80) 값을 추가해야 합니다.
1-1250: WootecoStyle 표준 준수 확인 필요파일 전체가 WootecoStyle 가이드라인을 따르고 있는지 검증이 필요합니다. 특히 다음 항목들에 대한 확인을 권장합니다:
- 들여쓰기 표준: 전역 설정은 4칸이지만, CSS/JSON/YAML 등 많은 파일 타입에서 2칸으로 오버라이드됨 - WootecoStyle에서 의도한 설정인지 확인
- Java 포매팅: 광범위한 Java 설정(wildcard import 금지 등)이 팀의 Java 코딩 가이드와 일치하는지 확인
- TypeScript/JavaScript: 엄격한 포매팅 규칙(예:
imports_wrap = on_every_item)이 프로젝트 요구사항과 일치하는지 확인WootecoStyle 공식 문서나 팀 가이드와의 대조를 통해 모든 설정이 의도된 표준과 정렬되어 있는지 재확인하시기 바랍니다.
There was a problem hiding this comment.
Pull request overview
이 PR은 WootecoStyle 기반의 .editorconfig 파일을 프로젝트에 추가합니다. 1,254줄에 달하는 포괄적인 코드 스타일 설정이 포함되어 있으며, Java, TypeScript, JavaScript, Kotlin, Groovy 등 다양한 언어에 대한 포매팅 규칙을 정의합니다.
주요 변경사항:
- WootecoStyle을 따르는 .editorconfig 파일 추가
- Java 코드 스타일: 4칸 들여쓰기, end_of_line 중괄호 스타일, 999개 클래스까지 개별 import 사용
- 프론트엔드 언어들(TypeScript, JavaScript 등)은 2칸 들여쓰기 적용
참고: PR 제목에 "PR/Issue 템플릿 수정"이 언급되어 있으나, 실제 변경사항에는 템플릿 파일이 포함되지 않았습니다.
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In @build.gradle.kts:
- Around line 138-148: The Asciidoctor task (tasks.asciidoctor) is missing an
attributes entry to expose the snippets directory to .adoc files; update the
tasks.asciidoctor configuration to add an attributes mapping that sets the
"snippets" attribute to the existing snippetsDir variable so Asciidoctor can
resolve {snippets} includes (e.g., configure attributes to point "snippets" ->
snippetsDir).
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (4)
.github/ISSUE_TEMPLATE/chore.md.github/ISSUE_TEMPLATE/docs-creation.md.github/pull_request_template.mdbuild.gradle.kts
🔇 Additional comments (9)
.github/ISSUE_TEMPLATE/chore.md (1)
5-5: 라벨 정의의 일관성 검증 필요Chore 템플릿의 라벨 정의가 다른 이슈 템플릿(예: docs-creation.md의 ':memo: Docs')과 불일치합니다.
D-3라벨의 의도(우선순위, 기한, 또는 초기 설정값)를 명확히 하고, 기존 Bug/Feature 등 다른 이슈 템플릿과의 라벨 정의 일관성을 검증해주시기 바랍니다..github/ISSUE_TEMPLATE/docs-creation.md (1)
9-18: 명확한 지침과 좋은 구조Docs 이슈 템플릿은 명확한 두 섹션(문서화 대상 + 작업 내용)과 실질적인 예시를 제공하여 기여자가 이해하기 쉽습니다. 라벨 정의도 간결하고 일관성 있게 구성되었습니다.
.github/pull_request_template.md (2)
3-4: PR 템플릿 개선 - 명확한 지침 추가병합 대상 브랜치 명시(prod: main, dev: develop)와 PR 제목 컨벤션 체크리스트 추가는 기여자의 실수를 줄이고 일관성을 높이는 좋은 개선입니다.
14-15: 작업 내용 섹션의 지침 개선구체적 작성 요청과 외부 문서 링크 가이드를 추가하여 기여자가 더 명확한 정보를 PR에 포함하도록 유도하는 점이 좋습니다.
build.gradle.kts (5)
23-23: LGTM!Spring REST Docs를 위한 커스텀 configuration 생성이 올바르게 구성되었습니다.
121-124: LGTM!Spring REST Docs 의존성이 올바르게 추가되었습니다. 버전은 Spring Boot BOM에서 관리되므로 명시하지 않은 것이 적절합니다.
131-136: LGTM!테스트 실행 시 REST Docs 스니펫이 생성될 디렉토리가 올바르게 구성되었습니다.
150-155: LGTM!생성된 API 문서가 bootJar에 올바르게 포함되도록 구성되었습니다. 문서는 애플리케이션 실행 시
/docs/경로에서 제공됩니다.
5-5: 플러그인 버전 확인 완료 - 추가 조치 불필요Asciidoctor 플러그인 버전 4.0.5는 현재 최신 안정 버전(2025년 8월 25일 릴리스)이며 Spring Boot 3.5.9 및 Java 21 환경과 완전히 호환됩니다. 빌드 설정이 올바르게 구성되어 있으므로 버전 업그레이드나 구성 변경이 필요하지 않습니다.
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In @.editorconfig:
- Around line 483-659: 에디터설정에서 TypeScript와 JavaScript 블록에 동일한 규칙이 중복 정의되어 있어
유지보수가 어렵습니다; ij_typescript_* 및 대응하는 ij_javascript_* 키들(예:
ij_typescript_blank_lines_around_class, ij_javascript_blank_lines_around_class
등)을 찾아 공통 규칙을 하나의 명시된 섹션으로 통합하거나(가능한 범위 내에서) 공통 규칙 목록 문서화 및 변경 체크리스트를 추가하도록
수정하세요; 구체적으로는 중복된 속성들을 한 곳에 모아 주석으로 “공통 규칙”을 만들거나 변경 가이드를 추가하고, 각 블록에는 오직 언어 특화된
차이만 남기며 자동화 검증 스크립트(또는 체크리스트) 추가를 제안하도록 주석 및 문서에 명시하세요.
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (1)
.editorconfig
🔇 Additional comments (1)
.editorconfig (1)
1-16: 글로벌 설정이 적절하게 구성되었습니다.POSIX 표준 준수 및 프로젝트 전반의 포매팅 기본값이 잘 설정되었습니다. 특히 Line 6의
insert_final_newline = true는 이전 CodeRabbit 권고사항이 반영된 것으로, Git 호환성과 빌드 도구 경고 문제를 해결합니다.
kyeoungwoon
changed the title
✅ 체크리스트
🔥 연관 이슈
🚀 작업 내용
.editorconfig로 변경해서 작성하였습니다.💬 리뷰 중점사항
📃 관련 문서
Summary by CodeRabbit
신기능
Chores
✏️ Tip: You can customize this high-level summary in your review settings.