ADR-0031: editor의 필요 인터페이스 DocumentStore · SettingsStore를 셸이 구현한다

이후 변경

  • 2026-11-21: 다른 문서의 Method 호출을 철회해 DocumentStore에서 다른 문서 읽기(readOther)를 뺐다. DocumentStore는 이 문서를 읽고 · 쓰고 · 다른 이름으로 쓴다. 아래 “다른 문서를 경로로 읽는다”와 셸마다의 “다른 문서 읽기” 칸, 2026-11-19의 줄은 지금 해당하지 않는다 → ADR-0049, R-BLK-09
  • 2026-11-21: createEditor가 선택적인 필요 인터페이스 pastedDocument(PastedDocumentPort: isDocument · open)를 받게 되었다. 붙여넣은 텍스트가 AriadneNSD 문서(모델 JSON · 공유 링크)이면 editor가 새 문서로 열지 묻고, 여는 일은 셸이 한다. 셸이 부르는 prompt는 제목 · 확인 버튼 · 여러 줄 입력 칸을 받는다 → R-WEB-11, 3.3 클립보드, JP2
  • 2026-11-19: 다른 문서를 읽지 못해도 그 호출 블록을 “이어진 곳 없음”으로 저장하지 않는다. 저장되는 그림은 실선 그대로이고, 찾을 수 없다는 표시는 편집 레이어에만 그린다 → EX1
  • 2026-11-10: 셸이 부르는 editor의 confirm이 모달의 제목(title)을 받게 되었고, 모달의 메시지는 줄바꿈을 지킨다. 열지 못한 공유 링크의 까닭을 묻지 않고 알리는 모달에 쓴다 → 6. 셸과의 연결, LG6
  • 2026-11-03: 웹 셸에 브라우저 문서(파일 없이 그 브라우저의 IndexedDB에 저장한 문서, R-WEB-09)가 생겨, DocumentStore가 문서가 사는 곳(place: 파일 또는 브라우저)을 알리고, 쓰기 실패에 셸의 문장(WriteResult.message)을 실을 수 있게 되었다. editor의 choose는 넷째 버튼을 받는다. 어디서 열고 저장할지는 editor의 열기 · 저장 창(EditorApp의 places)으로 셸이 묻는다 → 6. 셸과의 연결, 1.3 브라우저 문서
  • 2026-11-03: createEditor가 받는 화면 언어의 기본값은 새 문서의 그림 문구의 언어(문서 설정)도 정한다. 그림의 고정 문구는 화면 언어가 아니라 문서 설정을 따른다 → ADR-0041, 6. 셸과의 연결
  • 2026-11-01: MVP 코드에서 createEditor에 저장 파일의 서브셋 글꼴을 만들 것(fonts), 화면 언어의 기본값, 화면 글꼴의 주소, 클립보드, 로그를 더했다. 저장 · 다른 이름으로 저장은 editor의 명령이고 DocumentStore를 거쳐 셸에 닿는다 → 6. 셸과의 연결
  • 2026-11-01: DocumentStore는 문서 하나의 읽기 · 쓰기로 남고, 어떤 파일을 열지(새로 · 열기 · 최근 파일)와 자동 저장 · 임시 보관의 타이머는 셸이 맡는 것으로 정했다. 셸은 editor를 만들 때 문서와 함께 화면 밝기 · UI 글꼴(Appearance)을 넘긴다. 설정이 아니라 호스트의 형편이라 SettingsStore에 넣지 않았다 → 6.1 새로 · 열기 · 최근 파일, 6.3 자동 저장과 로컬 백업은 셸이 담당한다
  • 2026-11-01: 두 인터페이스에 구체적인 시그니처가 생겼다(WriteResult, canWriteInPlace, readOther 등) → 6. 셸과의 연결. 웹 셸은 파일 밖에 임시 보관과 최근 파일을 브라우저의 IndexedDB에 둔다 → 2. 로컬 백업과 자동 저장
  • 2026-10-22: 용어를 SW 엔지니어의 말로 고쳤다(뜻은 그대로). 두 인터페이스에 이름(DocumentStore, SettingsStore)을 붙였다. 이 ADR은 editor가 요구하고 셸이 구현하는 필요 인터페이스, ADR-0033은 editor가 구현하고 셸이 쓰는 제공 인터페이스다. 같은 경계의 반대 방향이다 → 4.2 editor와 셸의 인터페이스
  • 2026-10-18: 반대 방향이 더해졌다. editor가 제공 인터페이스로 명령 레지스트리와 설정 스키마를 노출하고, 셸은 그것을 자기 메뉴나 호스트 프로그램(Obsidian, IDE)의 메뉴 · 설정 화면에 등록한다 → ADR-0033

배경

같은 편집기(editor + core)를 배포 대상마다의 셸(호스트 애플리케이션)이 감싼다(ADR-0002). 셸은 웹 · Obsidian · 데스크톱에서 그치지 않는다. 웹 위에 얹는 Google Drive, 나중의 Confluence, IDE 플러그인(VSCode, 그다음 IntelliJ)도 셸이다(7. 배포 구성). 그래서 “셸이 무엇을 구현하면 붙는가”를 인터페이스 계약으로 적어 두어야 한다.

01-architecture의 초안(2026-10-13)에 Claude는 “셸의 인터페이스는 파일 I/O 하나(이 문서를 읽기 · 쓰기 · 다른 이름으로 쓰기)“라고 적었다. 텍스트 측정 함수의 주입과 편집기 상태 저장소가 그날의 결정으로 필요 없어져서다. 시안 M20을 만들며(2026-10-17) 둘이 빠진 것을 찾았다.

  • 다른 문서의 Method 호출(R-BLK-09)은 지금 연 문서가 아닌 다른 파일을 읽어야 한다.
  • 사용자 설정(UI 언어, 화면 색)은 문서 파일 밖 어딘가에 영속해야 한다.

결정 기준

  • 새 셸을 붙이는 사람이 무엇을 구현해야 하는지 인터페이스만 보고 안다
  • 같은 기능을 셸마다 인터페이스 밖에서 제각각 구현하지 않는다
  • 문서의 상태는 파일 안에만 둔다(편집기 상태 저장소는 두지 않는다)

검토한 대안

그림은 시안 M20의 A6에 있다: https://claude.ai/artifact/R8RJxg8V1qweiMfusMKk87

대안 A: 두 인터페이스. 문서 파일(+ 다른 문서 읽기)과 설정 보관

  • 장점: 셸이 구현할 것이 인터페이스 둘로 모두 드러난다
  • 단점: 인터페이스가 조금 커진다. 다른 문서를 읽지 못하는 셸(웹)의 경우를 editor가 처리해야 한다

대안 B: 처음 제안대로 파일 I/O 하나

  • 장점: 인터페이스가 가장 작다
  • 단점: 다른 문서 읽기와 설정 영속을 셸마다 인터페이스 밖에서 따로 구현한다. 새 셸을 붙일 때 그것을 구현해야 한다는 것이 계약에 드러나지 않는다

결정

대안 A. 메인테이너: “추천 수용.” (2026-10-18)

editor가 필요 인터페이스(required interface) 둘을 정의하고, 셸이 구현해 주입한다.

  1. DocumentStore(문서 파일): 이 문서를 읽는다 · 쓴다 · 다른 이름으로 쓴다, 다른 문서를 경로로 읽는다. 읽지 못하면 null을 돌려준다.
  2. SettingsStore(설정 보관): 사용자 설정(UI 언어, 화면 색)을 읽고 쓴다.

셸마다의 구현은 다음과 같다(뒤에 붙는 셸은 그 셸을 설계할 때 정한다).

셸다른 문서 읽기설정 영속
웹사용자가 권한을 준 파일이나 폴더 안에서만그 브라우저의 저장소
Obsidian볼트에서플러그인 설정
데스크톱파일 시스템에서설정 파일

다른 문서를 읽지 못하면 그 호출 블록은 “이어진 곳 없음”(dangling reference)으로 보인다. 웹에서는 사용자가 그 파일에 권한을 주지 않았으면 늘 그렇다.

결과

  • 좋아지는 점: 새 셸(Confluence, IDE 플러그인)을 붙일 때 구현할 것이 두 인터페이스로 정해진다.
  • 감수하는 점: 웹에서는 다른 문서를 호출하는 호출 블록이 끊겨 보이기 쉽다.
  • 남은 것: IDE 플러그인은 원본이 .ns 파일이 아니라 소스 코드라서, 이 둘만으로는 모자랄 수 있다(코드와 모델 사이의 변환) → 7. 배포 구성
  • 후속 작업: 인터페이스의 메서드 시그니처 → 6. 셸과의 연결, 웹에서 다른 문서에 권한을 받는 흐름 → 06-web