Bareun Grammar Assistant for Obsidian 정리본
Bareun Revision API 기반의 한국어 맞춤법/띄어쓰기/표준어/통계 교정기를 Obsidian으로 포팅한 플러그인 메모. VS Code용 BKGA를 쓰던 흐름을 Obsidian에서도 그대로 가져오면서, 하단 상태바·Issues 패널·사용자 사전 연동을 지원한다. GitHub: https://github.com/idencosmos/bareun-obsidian-plugin
주요 기능 (v0.1.4 기준)
- 자동/수동 분석: Markdown 노트에 디바운스 후 자동 분석(기본 1200ms, 파일별 쿨다운 5초) 혹은 명령으로 수동 실행.
- 인라인 표시: 카테고리별 물결 밑줄 + 호버 툴팁(원문/제안, 사용자 사전 등록 버튼).
- Issues 패널: 현재 노트의 문제 목록, 카테고리 토글/리셋, 위치 표시, 제안 즉시 적용, “사전에 추가” 버튼으로 바로 등록.
- 사용자 사전: 패널에서 빠른 추가(현재 선택어 자동 프리필), 선택 추가, 카테고리별 목록/삭제, 동기화 버튼. 호버·Issues에서도 바로 추가 가능. 사전에 있는 단어는 숨기거나 다시 표시하는 토글 제공.
- 로컬 폴백: API 키가 없거나 오류 발생 시 여분 공백/줄 끝 공백만 안내하는 로컬 휴리스틱으로 폴백.
설치
- GitHub Release의
manifest.json,main.js,main.js.map,styles.css네 파일만 Vault의.obsidian/plugins/bareun-grammar-assistant/에 복사. - Settings → Community plugins → Installed plugins에서 활성화.
- (선택) BRAT 사용 시 레포 URL 등록으로 자동 업데이트 가능.
설정 포인트
- Bareun API key (필수) / Endpoint(비우면 기본 클라우드) / 분석 경로 glob / 영어 무시 토글 / 디바운스·쿨다운 슬라이더 / 자동·수동 모드.
- Custom dictionary: Enable + Domain(필수) + Endpoint(기본값 가능). “Hide issues present in custom dictionary”로 사전에 있는 단어를 밑줄/목록에서 숨길지 결정.
사용자 사전 활용
- 패널: “빠른 추가” 입력(현재 편집기 선택어 자동 채움) → 카테고리 선택 후 추가. “선택 추가”는 편집기 선택어를 곧바로 모달에 띄움. 항목별 “삭제”, 상단 “동기화”로 Bareun 서버 반영.
- 인라인: 밑줄 호버 카드나 Issues 항목의 “사전에 추가” 버튼으로 바로 등록. 모달에서 단어를 다듬고 카테고리를 고른 뒤 저장.
- 카테고리: 고유명사(np_set), 복합명사(cp_set), 복합명사 분리(cp_caret_set), 동사(vv_set), 형용사(va_set).
사용 흐름
- Markdown 편집 → 자동 분석 → 밑줄/호버/Issues 확인 → 제안 적용 또는 “사전에 추가”.
- API 키가 없으면 상태바에 “API key required (local)”로 표시되고 공백류만 안내. 오류 시 “API error (local)”로 폴백.
- 사전 제외 토글을 켜면 등록된 단어는 밑줄/Issues에서 숨김, 끄면 다시 표시.
배포/유의사항
- 릴리스 첨부물은 4개 파일만 포함(위 참조),
node_modules제외. - Bareun API 키는 사용자가 직접 입력해야 하며 릴리스/저장소에 포함 금지.
- Bareun 약관·요금·쿼터 준수는 사용자 책임.
- 네트워크 요청 시
rejectUnauthorized: false로 설정되어 있으니, 공식 배포에서는 TLS 검증을 명확히 안내하거나 필요한 경우 변경을 검토.
간단 변경 이력
- v0.1.4: 사용자 사전 인라인 추가(호버·Issues), 사전 제외 토글, 패널 “빠른/선택 추가” 정리, 버전·번들 갱신.
- v0.1.3: 설정 문구 문장형 정비, Obsidian ESLint 룰 도입, 번들/메타데이터 갱신.
