ADR-0033: editor가 제공 인터페이스 CommandRegistry · SettingsSchema를 노출하고, 셸은 그것을 호스트의 확장 지점에 등록한다

이후 변경

  • 2026-11-21: 웹 셸이 파일 메뉴에 “붙여넣은 JSON으로 열기…”(file.openPasted)를 더한다. editor의 모달(Dialog)은 넷째 버튼을 흐리게 하고(isSecondDisabled) 입력 칸을 여러 줄로(isMultiline) 할 수 있다 → JP3, 6. 셸과의 연결
  • 2026-11-03: EditorHandle에 답이 셋인 물음 choose가 생겼다(셸이 저장하지 않은 새 문서를 두고 다른 문서를 열 때 저장 · 버리고 열기 · 취소를 묻는다) → US1, 6. 셸과의 연결
  • 2026-11-03: 설정 스키마의 항목(SettingSpec)에 흐린 한 줄 설명(hint)이 생겼다. 첫 쓰임은 문서 설정의 “그림 문구의 언어”다 → ADR-0041, 6. 셸과의 연결
  • 2026-11-01: MVP 코드에서 EditorHandle이 커졌다(state · onChange · chromeState · documentSetting · startBlockDrag · focus 등). open은 열었는지를 돌려주고 serialize는 비동기다. CommandRegistry에 context(), CommandSpec에 checked, 메뉴 자리에 하위 메뉴(submenu)가 생겼다. 셸이 더하는 명령은 새로 · 열기 · 최근 파일 · 내보내기다 → 5. 명령 목록과 메뉴, 6. 셸과의 연결
  • 2026-11-01: 제공 인터페이스에 EditorHandle(문서 바꾸기 · 저장 · 직렬화 · 상태 알림)을 더했다. 셸도 자기 명령(새로 · 열기 · 최근 파일)을 CommandRegistry.register로 같은 목록에 더한다. 명령의 이름은 형편에 따라 바뀔 수 있다(내려받는 브라우저에서 “저장” → “내려받기”) → 6. 셸과의 연결
  • 2026-11-01: 명령 하나의 항목(CommandSpec)을 정했다 → 5. 명령 목록과 메뉴. 명령 목록은 웹 · 데스크톱의 메뉴 바와 커맨드 팔레트에도 쓰인다(W1, W6). SettingsSchema의 설정에 범위(user · document)가 생겼다(W5)
  • 2026-10-22: 용어를 SW 엔지니어의 말로 고쳤다(뜻은 그대로). 두 인터페이스에 이름(CommandRegistry, SettingsSchema)을 붙였다. 이 ADR은 editor가 구현하고 셸이 쓰는 제공 인터페이스, ADR-0031은 editor가 요구하고 셸이 구현하는 필요 인터페이스다. 같은 경계의 반대 방향이다 → 4.2 editor와 셸의 인터페이스

배경

UI 프레임워크(ADR-0010)를 고르는 시안 M22를 보며 메인테이너가 물었다: “배포 유형이 매우 다양합니다. IDE까지 고려한 것인가요?” (2026-10-18)

편집기의 화면은 모든 배포 대상에서 브라우저 엔진 안에서 돈다(웹, Obsidian, Electron · Tauri, Confluence의 iframe, VSCode의 웹뷰, IntelliJ의 JCEF). 그러나 메뉴 · 명령 · 설정은 다르다. Obsidian, VSCode, IntelliJ에는 호스트 프로그램의 명령 팔레트 · 컨텍스트 메뉴 · 설정 화면이 있고, 사용자는 거기서 찾는다. 아키텍처에는 “키 바인딩은 표 하나”까지만 있었고, 그 표를 셸에게 노출한다는 것은 없었다.

결정 기준

  • IDE와 Obsidian 사용자가 호스트 프로그램의 명령 팔레트와 설정 화면에서 AriadneNSD의 명령과 설정을 찾을 수 있다
  • 명령을 하나 더할 때 대상마다 메뉴를 따로 고치지 않는다
  • 웹 · 데스크톱 · Confluence처럼 기댈 메뉴가 없는 대상에서도 같은 명령이 보인다

검토한 대안

그림은 시안 M22의 U1에 있다: https://claude.ai/artifact/1gXCQSyoSnPcTP3ro64d5Z

대안 A: 명령의 목록을 내놓는다

  • 장점: 메뉴 · 도구 모음 · 키 바인딩이 모두 같은 명령 레지스트리에서 생성된다. 명령을 더하면 모든 대상의 메뉴에 함께 생긴다
  • 단점: 셸이 레지스트리를 호스트 프로그램의 메뉴에 등록하는 코드를 구현해야 한다

대안 B: 늘 우리가 그린다

  • 장점: 셸이 할 일이 가장 적고, 모든 대상에서 똑같이 보인다
  • 단점: IDE와 Obsidian의 명령 팔레트로 찾을 수 없고, 메뉴와 설정의 모양이 호스트 프로그램과 다르다. 나중에 A로 바꾸려면 흩어진 명령을 모아야 한다

결정

대안 A. 메인테이너가 시안 M22의 U1에서 1번(추천)을 골랐다 (2026-10-18).

  1. editor는 제공 인터페이스(provided interface) **CommandRegistry(명령 레지스트리)**를 노출한다. 명령마다 id, 표시 이름(UI 언어에 따라), 키 바인딩(→ 03-keymap), 활성 여부(지금 실행할 수 있는가)를 알려 준다. 실행 진입점도 하나(id로 실행)다.
  2. 사용자 설정도 같은 방법으로 SettingsSchema(설정 스키마)(id, 표시 이름, 허용 값)를 노출한다. 값의 영속은 셸이 구현하는 필요 인터페이스 SettingsStore가 맡는다(ADR-0031).
  3. 셸은 이것을 렌더링하거나 호스트의 확장 지점에 등록한다.
셸명령설정
웹, 데스크톱, Confluence우리 도구 모음과 컨텍스트 메뉴우리 설정 창
ObsidianObsidian 명령 팔레트, Obsidian 컨텍스트 메뉴 (+ 우리 도구 모음)플러그인 설정 탭
VSCode명령 팔레트, 확장이 등록한 컨텍스트 메뉴, 에디터 타이틀 바 버튼VSCode 설정
IntelliJAction (메뉴 · 단축키)IntelliJ 설정
  1. 다이어그램 영역 안의 키 입력은 어느 대상이든 editor가 처리한다. 호스트 프로그램의 단축키와 충돌하는 키는 셸을 설계할 때 정한다.

결과

  • 좋아지는 점: 명령과 설정이 레지스트리 하나라, 새 셸을 붙일 때 “이것을 어느 확장 지점에 등록하나”만 정하면 된다.
  • 감수하는 점: 셸마다 레지스트리를 호스트 프로그램의 메뉴로 옮기는 어댑터 코드가 생긴다.
  • 우리가 그리는 주변 UI 컴포넌트는 줄어든다. UI 프레임워크(ADR-0010)가 맡을 곳도 그만큼 작다.
  • 후속 작업: 레지스트리 항목의 타입 → 6. 셸과의 연결, 셸마다 등록하는 법 → 각 셸의 설계 문서