feat: enforce 100% TSDoc coverage for TypeScript workspaces

[seonghobae]

Summary

• Installed eslint-plugin-jsdoc and added it to flat ESLint config
• Enforced jsdoc/require-jsdoc and jsdoc/require-description on exported functions/types
• Auto-populated docstrings for all exported entities in desktop and shared-types
• Re-run quickcheck.sh locally to ensure it passes

[coderabbitai]

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: 12d93569-b85d-4a10-8c6b-efa77aae22a7

📥 Commits

Reviewing files that changed from the base of the PR and between 23bc1d6 and 61d4dca.

⛔ Files ignored due to path filters (1)

• package-lock.json is excluded by !**/package-lock.json

📒 Files selected for processing (18)

• README.md
• apps/desktop/src/App.tsx
• apps/desktop/src/features/chords/index.tsx
• apps/desktop/src/features/home/index.tsx
• apps/desktop/src/features/player/index.tsx
• apps/desktop/src/features/ranges/index.tsx
• apps/desktop/src/features/settings/index.tsx
• apps/desktop/src/features/workspace/ConfidenceBadge.tsx
• apps/desktop/src/features/workspace/RoleSwitcher.tsx
• apps/desktop/src/features/workspace/SectionRoadmap.tsx
• apps/desktop/src/features/workspace/Workspace.tsx
• apps/desktop/src/features/workspace/WorkspaceStates.tsx
• apps/desktop/src/i18n/index.ts
• apps/desktop/src/lib/analysis.ts
• apps/desktop/src/lib/export.ts
• eslint.config.js
• package.json
• packages/shared-types/src/index.ts

Cache: Disabled due to Reviews > Disable Cache setting

Disabled knowledge base sources:

• Linear integration is disabled

You can enable these sources in your CodeRabbit configuration.

---

📝 Walkthrough

Summary by CodeRabbit

릴리스 노트

• Documentation

  • 코드베이스 전반에 JSDoc 주석을 추가해 문서화 및 타입 설명 개선.
  • README의 상태 문단에서 남은 TODO 문장 제거.

• Chores

  • ESLint JSDoc 플러그인 설정을 추가해 JSDoc 규칙을 강제.
  • 개발용 의존성에 eslint-plugin-jsdoc 추가.

Walkthrough

저장소 전반의 내보낸 선언과 컴포넌트에 JSDoc 주석을 추가하고 ESLint에 eslint-plugin-jsdoc 규칙을 도입해 특정 내보낸 선언에 대해 JSDoc 작성을 강제합니다. README의 남은 TODO 문장을 삭제했습니다.

Changes

Cohort / File(s)	Summary
JSDoc — Desktop UI 컴포넌트 apps/desktop/src/App.tsx, apps/desktop/src/features/*/index.tsx, apps/desktop/src/features/workspace/ConfidenceBadge.tsx, apps/desktop/src/features/workspace/RoleSwitcher.tsx, apps/desktop/src/features/workspace/SectionRoadmap.tsx, apps/desktop/src/features/workspace/Workspace.tsx, apps/desktop/src/features/workspace/WorkspaceStates.tsx	내보낸 컴포넌트와 일부 내부 핸들러 위에 /** Documented. */ JSDoc 주석 추가. 서명·로직 미변경.
JSDoc — Desktop 유틸/로직 apps/desktop/src/lib/analysis.ts, apps/desktop/src/lib/export.ts, apps/desktop/src/i18n/index.ts	공개 타입·함수 및 내부 헬퍼에 JSDoc 주석 추가. 동작·시그니처 변경 없음.
JSDoc — 공유 타입 라이브러리 packages/shared-types/src/index.ts	다수의 export된 상수·타입·함수에 JSDoc 주석 추가(일부 상수의 export 위치에 주석 삽입). 시그니처·값 미변경.
린트 설정 및 메타 eslint.config.js, package.json, README.md	eslint-plugin-jsdoc 추가 및 플러그인 등록, 특정 파일/패턴에 jsdoc/require-jsdoc·jsdoc/require-description 규칙 적용; README의 TODO 문장 제거.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Possibly related PRs

• feat: add shared rehearsal contract baseline #37: 동일한 공유 타입(리허설 타입/요약 등)과 관련된 선언들을 추가/수정한 PR — JSDoc 주석 대상이 겹침.
• feat: add local analysis orchestration #53: 분석 관련 함수·타입과 데스크탑 분석 흐름을 확장한 PR — apps/desktop/src/lib/analysis.ts 변화와 직접적 연결.
• feat: implement practical rehearsal workspace UI #88: workspace 구성요소(ConfidenceBadge, RoleSwitcher, SectionRoadmap 등)를 다룬 PR — 동일 컴포넌트들에 대한 문서화 변경과 연관.

Poem

🐰
잉크를 닦는 토끼가 말하네,
"함수들에 이름표 달아주었지" ✨
린터가 고개 끄덕이며,
주석은 춤추고 코드가 웃네,
작은 문서 한 줄이 길을 밝히네.

✨ Finishing Touches

📝 Generate docstrings

• Create stacked PR
• Commit on current branch

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch feature/tsdoc-coverage

---

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[seonghobae]

@coderabbitai review

[coderabbitai]

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.