Skip to content

refactor: 문서화 작업이 남긴 부채 정리 (이름 정합·중복 제거·주석) - #288

Merged
chanwoo7 merged 1 commit into
developfrom
refactor/docs-check-cleanup
Sep 9, 2026
Merged

refactor: 문서화 작업이 남긴 부채 정리 (이름 정합·중복 제거·주석)#288
chanwoo7 merged 1 commit into
developfrom
refactor/docs-check-cleanup

Conversation

@chanwoo7

@chanwoo7 chanwoo7 commented Sep 9, 2026

Copy link
Copy Markdown
Member

#281~#286을 진행하며 리뷰 라운드마다 패치가 쌓였고 그 흔적이 코드에 남았다. 동작은 바뀌지 않고 정리만 한다.

이름이 실제와 어긋난 것

문제
카테고리 키 rootArgScalar 두 번의 리팩터(루트 인자 → 모든 필드 인자, 스칼라 → 비-input)를 거치며 라벨만 "필드 인자(비 input)"로 바뀌고 키는 그대로였다. directive 인자도 이 키로 들어간다 → fieldArg
CLI 헤더의 THRESHOLDS 존재하지 않는 식별자. 변수명은 BASELINE으로 바뀐 지 오래다

중복

object 비루트 분기와 interface 분기의 필드 루프가 20줄 가까이 같았다. recordOutputFields로 합쳤다.

주석에서 걷어낸 것

사실이 틀린 것

  • "플레이스홀더가 70건 있다" → 지금 0건
  • "남은 부채는 임계치를 올려가며 갚는다" → 부채 0, 기준선 100%
  • 기준선 주석이 예시로 든 185/603 → 작업 전 수치

리뷰 과정 회고 — "directive를 그렇게 놓쳤다", "quantity는 일부러 넣지 않았다", "왜 스칼라 allowlist가 아닌가"

판단 근거는 남기되 어떻게 그 판단에 이르렀는지는 코드가 알 필요가 없다. CLAUDE.md의 "주석은 왜를 남긴다"는 트레이드오프·방어 이유를 뜻하지 내 실수 이력이 아니다.

SDL에서 걷어낸 것

둘 다 작업 전 이 레포에 0건이던 표기를 내가 들여온 것이다.

  • 마크다운 볼드 5건 제거
  • # 주석 1건 → 타입 설명으로 이동. SpectaQL에 렌더되지 않는 자리라 문서 가치가 없었다(감사 로그가 totalCount를 안 내리는 이유)

검증

225 suites 1,873건 + 게이트 스크립트 42건 통과. docs:check 100% 유지. knip 기준 미사용 export 없음.

설명 길이도 함께 봤다 — 1,349개 평균 28자, 120자 초과 6개뿐이고 그것들은 배너 링크 필드·주문 상태 전이처럼 실제로 복잡한 계약이라 그대로 뒀다.

리뷰 라운드를 여러 번 돌면서 패치가 쌓였고, 그 흔적이 코드에 남았다. 동작은
바뀌지 않고 정리만 한다.

이름이 실제와 어긋난 것:
- 카테고리 키 rootArgScalar → fieldArg. 두 번의 리팩터(루트 인자 → 모든 필드
  인자, 스칼라 → 비-input)를 거치며 라벨만 "필드 인자(비 input)"로 바뀌고 키는
  그대로였다. directive 인자도 이 키로 들어간다
- CLI 헤더 주석이 THRESHOLDS를 가리켰다. 변수명은 BASELINE으로 바뀐 지 오래다

중복:
- object 비루트 분기와 interface 분기의 필드 루프가 20줄 가까이 같았다.
  recordOutputFields로 합쳤다

주석에서 걷어낸 것:
- 사실이 틀린 것 — "플레이스홀더가 70건 있다"(지금 0건),
  "남은 부채는 임계치를 올려가며 갚는다"(부채 0), 기준선 예시의 작업 전 수치
- 리뷰 과정 회고 — "directive를 그렇게 놓쳤다", "quantity는 일부러 넣지 않았다",
  "왜 스칼라 allowlist가 아닌가" 같은, 존재하지 않는 대안·내 실수와의 비교
  판단 근거는 남기되 어떻게 그 판단에 이르렀는지는 코드가 알 필요 없다

SDL에서 걷어낸 것 — 둘 다 작업 전 이 레포에 0건이던 표기를 내가 들여왔다:
- 마크다운 볼드 5건 제거
- # 주석 1건 → 타입 설명으로 이동. SpectaQL에 렌더되지 않는 자리라 문서 가치가
  없었다(감사 로그가 totalCount를 안 내리는 이유)

검증: 225 suites 1,873건 + 게이트 스크립트 42건 통과. docs:check 100% 유지.
knip 기준 미사용 export 없음.
@coderabbitai

coderabbitai Bot commented Sep 9, 2026

Copy link
Copy Markdown

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Advanced

Run ID: 9d5b9c3b-4325-4946-aa7f-415184e09b59

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@github-actions

github-actions Bot commented Sep 9, 2026

Copy link
Copy Markdown

🧹 knip — dead-code 리포트

Unused dependencies (1)
Duplicate exports (1)
전체 리포트
Unused dependencies (1)
graphql-ws  package.json:65:6
Duplicate exports (1)
KEYWORD_RANK_SNAPSHOT_SIZE|MAX_POPULAR_KEYWORDS_LIMIT  src/features/search/constants/search.constants.ts

청소 후보(오탐 가능) · 기준 docs/guide/architecture-conventions.md

@github-actions

github-actions Bot commented Sep 9, 2026

Copy link
Copy Markdown

🩺 NestJS Doctor — 90/100 (Excellent)

진단 313건 (error 0).

Category error warning info
architecture 0 0 9
correctness 0 161 0
performance 0 27 17
schema 0 0 86
security 0 13 0
architecture / security 상위 항목
  • info architecture/architecture/no-barrel-export-internals: Barrel file re-exports internal type 'IAuditLogRepository'.
  • warning security/security/no-exposed-env-vars: Direct 'process.env.NODE_ENV' access in 'AuthController'. Use ConfigService instead.
  • warning security/security/require-guards-on-endpoints: Endpoint 'start' has no @UseGuards() at class or method level.
  • warning security/security/require-guards-on-endpoints: Endpoint 'callback' has no @UseGuards() at class or method level.
  • warning security/security/require-guards-on-endpoints: Endpoint 'refresh' has no @UseGuards() at class or method level.
  • warning security/security/require-guards-on-endpoints: Endpoint 'logout' has no @UseGuards() at class or method level.
  • warning security/security/require-guards-on-endpoints: Endpoint 'sellerLogin' has no @UseGuards() at class or method level.
  • warning security/security/require-guards-on-endpoints: Endpoint 'sellerRefresh' has no @UseGuards() at class or method level.
  • warning security/security/require-guards-on-endpoints: Endpoint 'sellerLogout' has no @UseGuards() at class or method level.
  • warning security/security/require-guards-on-endpoints: Endpoint 'devIssueToken' has no @UseGuards() at class or method level.
  • info architecture/architecture/no-barrel-export-internals: Barrel file re-exports internal module '@/features/conversation/repositories/conversation.repository'.
  • info architecture/architecture/no-barrel-export-internals: Barrel file re-exports internal type 'ConversationRepository'.
  • info architecture/architecture/no-barrel-export-internals: Barrel file re-exports internal module '@/features/order/repositories/order.repository'.
  • info architecture/architecture/no-barrel-export-internals: Barrel file re-exports internal type 'OrderRepository'.
  • info architecture/architecture/no-barrel-export-internals: Barrel file re-exports internal module '@/features/product/repositories/product.repository'.

오탐 포함 가능 · 기준 docs/guide/architecture-conventions.md

@codecov

codecov Bot commented Sep 9, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@github-actions

github-actions Bot commented Sep 9, 2026

Copy link
Copy Markdown

Coverage report

St.
Category Percentage Covered / Total
🟢 Statements 97.69% 5909/6049
🟢 Branches 93.12% 2316/2487
🟢 Functions 96.47% 1176/1219
🟢 Lines 98.27% 5382/5477

Test suite run success

1873 tests passing in 225 suites.

Report generated by 🧪jest coverage report action from df456f1

@chanwoo7
chanwoo7 merged commit f8b948f into develop Sep 9, 2026
12 checks passed
@chanwoo7
chanwoo7 deleted the refactor/docs-check-cleanup branch September 9, 2026 20:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant