@14ch/svelte-md-outliner 0.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (153) hide show
  1. package/README.ja.md +190 -0
  2. package/README.md +190 -0
  3. package/dist/assets/styles/editor.css +1459 -0
  4. package/dist/assets/styles/theme.css +486 -0
  5. package/dist/components/ContextMenu.svelte +279 -0
  6. package/dist/components/ContextMenu.svelte.d.ts +9 -0
  7. package/dist/components/EditorSurface.svelte +99 -0
  8. package/dist/components/EditorSurface.svelte.d.ts +16 -0
  9. package/dist/components/FocusBreadcrumb.svelte +138 -0
  10. package/dist/components/FocusBreadcrumb.svelte.d.ts +16 -0
  11. package/dist/components/MarkdownEditor.svelte +393 -0
  12. package/dist/components/MarkdownEditor.svelte.d.ts +119 -0
  13. package/dist/components/ShortcutHelpDialog.svelte +155 -0
  14. package/dist/components/ShortcutHelpDialog.svelte.d.ts +12 -0
  15. package/dist/components/internal/Dialog.svelte +157 -0
  16. package/dist/components/internal/Dialog.svelte.d.ts +23 -0
  17. package/dist/components/internal/Modal.svelte +181 -0
  18. package/dist/components/internal/Modal.svelte.d.ts +18 -0
  19. package/dist/components/internal/Popup.svelte +248 -0
  20. package/dist/components/internal/Popup.svelte.d.ts +26 -0
  21. package/dist/index.d.ts +32 -0
  22. package/dist/index.js +28 -0
  23. package/dist/markdown.d.ts +13 -0
  24. package/dist/markdown.js +10 -0
  25. package/dist/messages/en.d.ts +2 -0
  26. package/dist/messages/en.js +107 -0
  27. package/dist/messages/index.d.ts +13 -0
  28. package/dist/messages/index.js +31 -0
  29. package/dist/messages/ja.d.ts +2 -0
  30. package/dist/messages/ja.js +112 -0
  31. package/dist/messages/messages.types.d.ts +59 -0
  32. package/dist/messages/messages.types.js +1 -0
  33. package/dist/models/document/bodySelection.d.ts +32 -0
  34. package/dist/models/document/bodySelection.js +43 -0
  35. package/dist/models/document/document.types.d.ts +27 -0
  36. package/dist/models/document/document.types.js +8 -0
  37. package/dist/models/document/foldable.d.ts +18 -0
  38. package/dist/models/document/foldable.js +21 -0
  39. package/dist/models/document/schema.d.ts +2 -0
  40. package/dist/models/document/schema.js +428 -0
  41. package/dist/models/document/sectionTree.d.ts +15 -0
  42. package/dist/models/document/sectionTree.js +123 -0
  43. package/dist/models/markdown/blockOutline.d.ts +9 -0
  44. package/dist/models/markdown/blockOutline.js +82 -0
  45. package/dist/models/markdown/frontMatter.d.ts +98 -0
  46. package/dist/models/markdown/frontMatter.js +300 -0
  47. package/dist/models/markdown/markdown.types.d.ts +60 -0
  48. package/dist/models/markdown/markdown.types.js +1 -0
  49. package/dist/models/markdown/markdownIt.d.ts +1 -0
  50. package/dist/models/markdown/markdownIt.js +92 -0
  51. package/dist/models/markdown/parser.d.ts +4 -0
  52. package/dist/models/markdown/parser.js +505 -0
  53. package/dist/models/markdown/plainText.d.ts +1 -0
  54. package/dist/models/markdown/plainText.js +25 -0
  55. package/dist/models/markdown/serializer.d.ts +17 -0
  56. package/dist/models/markdown/serializer.js +453 -0
  57. package/dist/models/viewState/viewState.types.d.ts +38 -0
  58. package/dist/models/viewState/viewState.types.js +17 -0
  59. package/dist/models/viewState/viewStateCodec.d.ts +31 -0
  60. package/dist/models/viewState/viewStateCodec.js +173 -0
  61. package/dist/operations/autoformat.d.ts +9 -0
  62. package/dist/operations/autoformat.js +86 -0
  63. package/dist/operations/commands/block.d.ts +24 -0
  64. package/dist/operations/commands/block.js +139 -0
  65. package/dist/operations/commands/codeBlock.d.ts +7 -0
  66. package/dist/operations/commands/codeBlock.js +26 -0
  67. package/dist/operations/commands/element.d.ts +67 -0
  68. package/dist/operations/commands/element.js +269 -0
  69. package/dist/operations/commands/frontMatter.d.ts +35 -0
  70. package/dist/operations/commands/frontMatter.js +120 -0
  71. package/dist/operations/commands/lineBreak.d.ts +9 -0
  72. package/dist/operations/commands/lineBreak.js +16 -0
  73. package/dist/operations/commands/link.d.ts +7 -0
  74. package/dist/operations/commands/link.js +21 -0
  75. package/dist/operations/commands/list.d.ts +126 -0
  76. package/dist/operations/commands/list.js +652 -0
  77. package/dist/operations/commands/mermaidBlock.d.ts +9 -0
  78. package/dist/operations/commands/mermaidBlock.js +28 -0
  79. package/dist/operations/commands/section.d.ts +217 -0
  80. package/dist/operations/commands/section.js +865 -0
  81. package/dist/operations/commands/sectionFold.d.ts +36 -0
  82. package/dist/operations/commands/sectionFold.js +219 -0
  83. package/dist/operations/commands/sectionJump.d.ts +8 -0
  84. package/dist/operations/commands/sectionJump.js +144 -0
  85. package/dist/operations/commands/selectedBlock.d.ts +37 -0
  86. package/dist/operations/commands/selectedBlock.js +170 -0
  87. package/dist/operations/commands/table.d.ts +64 -0
  88. package/dist/operations/commands/table.js +437 -0
  89. package/dist/operations/keymap/assemble.d.ts +22 -0
  90. package/dist/operations/keymap/assemble.js +165 -0
  91. package/dist/operations/keymap/coreActions.d.ts +2 -0
  92. package/dist/operations/keymap/coreActions.js +711 -0
  93. package/dist/operations/keymap/menuItems.d.ts +52 -0
  94. package/dist/operations/keymap/menuItems.js +114 -0
  95. package/dist/operations/keymap/shortcutKeys.d.ts +42 -0
  96. package/dist/operations/keymap/shortcutKeys.js +114 -0
  97. package/dist/operations/keymap/viewActions.d.ts +30 -0
  98. package/dist/operations/keymap/viewActions.js +182 -0
  99. package/dist/operations/operations.types.d.ts +121 -0
  100. package/dist/operations/operations.types.js +1 -0
  101. package/dist/operations/plugins/blockHandle.d.ts +25 -0
  102. package/dist/operations/plugins/blockHandle.js +112 -0
  103. package/dist/operations/plugins/contextMenu.d.ts +33 -0
  104. package/dist/operations/plugins/contextMenu.js +204 -0
  105. package/dist/operations/plugins/focus.d.ts +39 -0
  106. package/dist/operations/plugins/focus.js +350 -0
  107. package/dist/operations/plugins/foldClick.d.ts +11 -0
  108. package/dist/operations/plugins/foldClick.js +117 -0
  109. package/dist/operations/plugins/foldGuard.d.ts +15 -0
  110. package/dist/operations/plugins/foldGuard.js +31 -0
  111. package/dist/operations/plugins/frontMatterGuard.d.ts +21 -0
  112. package/dist/operations/plugins/frontMatterGuard.js +150 -0
  113. package/dist/operations/plugins/frontMatterView.d.ts +34 -0
  114. package/dist/operations/plugins/frontMatterView.js +137 -0
  115. package/dist/operations/plugins/linkPaste.d.ts +3 -0
  116. package/dist/operations/plugins/linkPaste.js +20 -0
  117. package/dist/operations/plugins/listStructure.d.ts +13 -0
  118. package/dist/operations/plugins/listStructure.js +18 -0
  119. package/dist/operations/plugins/markdownClipboard.d.ts +8 -0
  120. package/dist/operations/plugins/markdownClipboard.js +208 -0
  121. package/dist/operations/plugins/mermaidView.d.ts +20 -0
  122. package/dist/operations/plugins/mermaidView.js +206 -0
  123. package/dist/operations/plugins/requiredSelectionEntry.d.ts +10 -0
  124. package/dist/operations/plugins/requiredSelectionEntry.js +124 -0
  125. package/dist/operations/plugins/sectionView.d.ts +12 -0
  126. package/dist/operations/plugins/sectionView.js +44 -0
  127. package/dist/operations/plugins/tabEscape.d.ts +21 -0
  128. package/dist/operations/plugins/tabEscape.js +41 -0
  129. package/dist/operations/plugins/tableHandles.d.ts +24 -0
  130. package/dist/operations/plugins/tableHandles.js +89 -0
  131. package/dist/operations/transaction.d.ts +26 -0
  132. package/dist/operations/transaction.js +51 -0
  133. package/dist/operations/transactionOrigin.d.ts +17 -0
  134. package/dist/operations/transactionOrigin.js +9 -0
  135. package/dist/states/contextMenuController.svelte.d.ts +57 -0
  136. package/dist/states/contextMenuController.svelte.js +206 -0
  137. package/dist/states/editorSession.d.ts +12 -0
  138. package/dist/states/editorSession.js +268 -0
  139. package/dist/states/editorSession.types.d.ts +57 -0
  140. package/dist/states/editorSession.types.js +1 -0
  141. package/dist/states/outlineViewController.svelte.d.ts +52 -0
  142. package/dist/states/outlineViewController.svelte.js +134 -0
  143. package/dist/utils/dateText.d.ts +25 -0
  144. package/dist/utils/dateText.js +71 -0
  145. package/dist/utils/geometry.types.d.ts +13 -0
  146. package/dist/utils/geometry.types.js +1 -0
  147. package/dist/utils/json.types.d.ts +4 -0
  148. package/dist/utils/json.types.js +1 -0
  149. package/dist/utils/platform.d.ts +8 -0
  150. package/dist/utils/platform.js +10 -0
  151. package/dist/utils/result.types.d.ts +7 -0
  152. package/dist/utils/result.types.js +1 -0
  153. package/package.json +109 -0
@@ -0,0 +1,98 @@
1
+ /**
2
+ * フロントマター(文書先頭の `---` に囲まれたフロントマター)について、
3
+ * **何をフロントマターと見なし、その中身をどう読み書きするか**を定める唯一の場所。
4
+ *
5
+ * 持つのは切り出し・読み取り・書き出し・項目の範囲の規則である。YAML の構文解析は行わず、
6
+ * 解析ライブラリにも依存しない。判定に使う語彙は「字下げの無い `キー:` の行」に揃える。
7
+ *
8
+ * **読み取り規則と書き出し規則が同じ場所にある。** これが「書いた値が同じ文字列として
9
+ * 読み戻せる」ことを関数の対として保証できる根拠である。
10
+ */
11
+ import type { Result } from '../../utils/result.types';
12
+ import type { FieldRange, FrontMatterFields, FrontMatterValues, FrontMatterWriteError } from './markdown.types';
13
+ /** 文書先頭のフロントマターと、本文の切り分け結果 */
14
+ export interface FrontMatterSplit {
15
+ /**
16
+ * 区切りの内側。区切りの行そのものと、末尾の改行を**含まない**。
17
+ * 存在しなければ空文字列
18
+ */
19
+ readonly content: string;
20
+ readonly body: string;
21
+ }
22
+ /**
23
+ * 文書先頭のフロントマターを本文から切り離す。
24
+ * 区切りに囲まれた範囲が、字下げの無い `キー:` の行を 1 つも含まないときは
25
+ * フロントマターとして扱わず、全体を本文として返す。
26
+ */
27
+ export declare function splitFrontMatter(markdown: string): FrontMatterSplit;
28
+ /**
29
+ * マークダウン**全体**から、指定した項目の値を読む(公開 API)。
30
+ * `splitFrontMatter` で中身を切り出し、`readField` を呼ぶだけの合成である。
31
+ */
32
+ export declare function readFrontMatterField(markdown: string, key: string): string | null;
33
+ /**
34
+ * マークダウン**全体**から、フロントマターの全項目を読む(公開 API)。
35
+ *
36
+ * 領域の切り出しは `splitFrontMatter`、項目の行の判定は `lineSpans`、値の読み取りは
37
+ * `readValue` に委ねる。**新しい探索を書かない**——列挙は新しい規則ではなく、
38
+ * 既にある規則の別の呼び方である。同じキーが複数あれば最初のものだけを返す。
39
+ *
40
+ * コンテナを原型の無い形で作るのは、素のオブジェクトが `__proto__` というキーを
41
+ * 受け付けず、**その項目が例外も出さずに消える**ためである。
42
+ */
43
+ export declare function readFrontMatterFields(markdown: string): FrontMatterValues;
44
+ /**
45
+ * マークダウン**全体**から、フロントマターを除いた本文を返す(公開 API)。
46
+ *
47
+ * 区切りの直後から後ろをそのまま返し、**1 文字も足さない**(先頭の空行も本文の一部として
48
+ * 残る)。フロントマターを持たなければ、渡された文字列をそのまま返す。
49
+ *
50
+ * 公開するのは、利用者が同じ切り分けを自前で書かずに済むようにするためである。素朴な
51
+ * 「先頭の `---` から次の `---` まで」という規則は、水平線で始まる文書を食う
52
+ * (→ `splitFrontMatter`)。判定はこのモジュールの 1 か所だけが持つ。
53
+ */
54
+ export declare function readBody(markdown: string): string;
55
+ /**
56
+ * フロントマターの**中身**から、指定した項目の値を読む。
57
+ *
58
+ * 字下げの無い `キー:` の行を上から探し、最初に見つかったものを採る。値の前後の空白を
59
+ * 落とし、引用符で囲まれていれば外す。見つからない・値が空・読み取れない書き方
60
+ * (ブロックスカラー、アンカー)のときは `null`。
61
+ *
62
+ * **コロンの後には空白か行末を要求する。** `title:x` は YAML ではキーと値の対ではなく
63
+ * `title:x` という 1 つの平文スカラーであり、緩く読むと同じファイルを読む他の道具と
64
+ * 食い違う。項目名として成立しない名前にも値を返さない(→ `isFieldName`)。
65
+ *
66
+ * **読み取りの規則はこの関数だけが持つ。** 要約も公開 API もここを通ることで、
67
+ * 見えている値と読める値が食い違わない。
68
+ */
69
+ export declare function readField(content: string, key: string): string | null;
70
+ /**
71
+ * マークダウン**全体**の項目を書き換え、書き換えた全体を返す(公開 API)。
72
+ *
73
+ * 領域の切り出しは `splitFrontMatter` に委ね、判定を 2 通り持たない。領域を持たない
74
+ * 文字列(空文字列を含む)には、先頭に領域を作って書く。
75
+ *
76
+ * 返す文字列は**正準形**である——読み込みと書き出しに通しても変わらない。壊れると、
77
+ * 繰り返し書き込む利用側で「保存が止まらない」という症状になる。
78
+ */
79
+ export declare function writeFrontMatterFields(markdown: string, fields: FrontMatterFields): Result<string, FrontMatterWriteError>;
80
+ /**
81
+ * フロントマターの**中身**の項目を書き換え、書き換えた中身を返す。
82
+ *
83
+ * 1 つでも書けないキー・値があれば、**その呼び出しの項目をいずれも書かない**。
84
+ * 半分だけ入った状態を作らないためである。
85
+ */
86
+ export declare function writeFields(content: string, fields: FrontMatterFields): Result<string, FrontMatterWriteError>;
87
+ /**
88
+ * フロントマターの**中身**の中で、指定したキーの項目が占める範囲を返す。
89
+ * まだ無いキーは返さない。並びは中身の中での出現順で、同じキーは最初のものだけを返す。
90
+ *
91
+ * 範囲は字下げの無い `キー:` の行から始まり、次の字下げの無い `キー:` の行の直前で
92
+ * 終わる。ただし**そこへ連続するコメント行と空行は後続の項目に属する**——コメントは
93
+ * 下に来る項目の説明として書かれるのが普通であり、置き換えで消さない。
94
+ *
95
+ * **範囲の規則を持つのはこの関数だけである。** 書き出しも、エディタの「利用者がその項目を
96
+ * 編集中か」の判定も、ここを通る(規則を 2 か所に置かないための入口)。
97
+ */
98
+ export declare function findFieldRanges(content: string, keys: readonly string[]): readonly FieldRange[];
@@ -0,0 +1,300 @@
1
+ /**
2
+ * フロントマター(文書先頭の `---` に囲まれたフロントマター)について、
3
+ * **何をフロントマターと見なし、その中身をどう読み書きするか**を定める唯一の場所。
4
+ *
5
+ * 持つのは切り出し・読み取り・書き出し・項目の範囲の規則である。YAML の構文解析は行わず、
6
+ * 解析ライブラリにも依存しない。判定に使う語彙は「字下げの無い `キー:` の行」に揃える。
7
+ *
8
+ * **読み取り規則と書き出し規則が同じ場所にある。** これが「書いた値が同じ文字列として
9
+ * 読み戻せる」ことを関数の対として保証できる根拠である。
10
+ */
11
+ const FRONT_MATTER = /^---\r?\n([\s\S]*?)\r?\n---[ \t]*(\r?\n|$)/;
12
+ /**
13
+ * 字下げの無い `キー:` の行。
14
+ *
15
+ * `#` 始まり(YAML のコメント)と字下げのある行は数えない。この条件があることで、
16
+ * 水平線で始まる文書(`---` をスライドの区切りに使う記法など)が
17
+ * フロントマターとして取り込まれない。
18
+ */
19
+ const KEY_LINE = /^[^\s#][^:\n]*:(\s|$)/m;
20
+ /** 1 行から字下げの無い `キー:` を取り出す。`KEY_LINE` と同じ語彙を、行ごとに当てる形 */
21
+ const FIELD_LINE = /^([^\s#][^:\n]*):(\s|$)/;
22
+ /**
23
+ * 項目名として成立するか。**判定は `FIELD_LINE` そのものである**——
24
+ * 読み取り・書き込み・項目の範囲が同じ規則を見ることで、
25
+ * 「書き込みが断る名前を読み取りが読めてしまう」食い違いが生まれない。
26
+ */
27
+ function isFieldName(key) {
28
+ return FIELD_LINE.test(`${key}:`);
29
+ }
30
+ /**
31
+ * 文書先頭のフロントマターを本文から切り離す。
32
+ * 区切りに囲まれた範囲が、字下げの無い `キー:` の行を 1 つも含まないときは
33
+ * フロントマターとして扱わず、全体を本文として返す。
34
+ */
35
+ export function splitFrontMatter(markdown) {
36
+ const match = FRONT_MATTER.exec(markdown);
37
+ if (!match || !KEY_LINE.test(match[1]))
38
+ return { content: '', body: markdown };
39
+ return { content: match[1], body: markdown.slice(match[0].length) };
40
+ }
41
+ /**
42
+ * マークダウン**全体**から、指定した項目の値を読む(公開 API)。
43
+ * `splitFrontMatter` で中身を切り出し、`readField` を呼ぶだけの合成である。
44
+ */
45
+ export function readFrontMatterField(markdown, key) {
46
+ return readField(splitFrontMatter(markdown).content, key);
47
+ }
48
+ /**
49
+ * マークダウン**全体**から、フロントマターの全項目を読む(公開 API)。
50
+ *
51
+ * 領域の切り出しは `splitFrontMatter`、項目の行の判定は `lineSpans`、値の読み取りは
52
+ * `readValue` に委ねる。**新しい探索を書かない**——列挙は新しい規則ではなく、
53
+ * 既にある規則の別の呼び方である。同じキーが複数あれば最初のものだけを返す。
54
+ *
55
+ * コンテナを原型の無い形で作るのは、素のオブジェクトが `__proto__` というキーを
56
+ * 受け付けず、**その項目が例外も出さずに消える**ためである。
57
+ */
58
+ export function readFrontMatterFields(markdown) {
59
+ const values = Object.create(null);
60
+ for (const line of lineSpans(splitFrontMatter(markdown).content)) {
61
+ if (line.key === null || line.key in values)
62
+ continue;
63
+ values[line.key] = readValue(line.text.slice(line.key.length + 1));
64
+ }
65
+ return values;
66
+ }
67
+ /**
68
+ * マークダウン**全体**から、フロントマターを除いた本文を返す(公開 API)。
69
+ *
70
+ * 区切りの直後から後ろをそのまま返し、**1 文字も足さない**(先頭の空行も本文の一部として
71
+ * 残る)。フロントマターを持たなければ、渡された文字列をそのまま返す。
72
+ *
73
+ * 公開するのは、利用者が同じ切り分けを自前で書かずに済むようにするためである。素朴な
74
+ * 「先頭の `---` から次の `---` まで」という規則は、水平線で始まる文書を食う
75
+ * (→ `splitFrontMatter`)。判定はこのモジュールの 1 か所だけが持つ。
76
+ */
77
+ export function readBody(markdown) {
78
+ return splitFrontMatter(markdown).body;
79
+ }
80
+ /**
81
+ * フロントマターの**中身**から、指定した項目の値を読む。
82
+ *
83
+ * 字下げの無い `キー:` の行を上から探し、最初に見つかったものを採る。値の前後の空白を
84
+ * 落とし、引用符で囲まれていれば外す。見つからない・値が空・読み取れない書き方
85
+ * (ブロックスカラー、アンカー)のときは `null`。
86
+ *
87
+ * **コロンの後には空白か行末を要求する。** `title:x` は YAML ではキーと値の対ではなく
88
+ * `title:x` という 1 つの平文スカラーであり、緩く読むと同じファイルを読む他の道具と
89
+ * 食い違う。項目名として成立しない名前にも値を返さない(→ `isFieldName`)。
90
+ *
91
+ * **読み取りの規則はこの関数だけが持つ。** 要約も公開 API もここを通ることで、
92
+ * 見えている値と読める値が食い違わない。
93
+ */
94
+ export function readField(content, key) {
95
+ if (!isFieldName(key))
96
+ return null;
97
+ const line = new RegExp(`^${escapeForRegExp(key)}:(?=\\s|$)(.*)$`, 'm').exec(content);
98
+ return line ? readValue(line[1]) : null;
99
+ }
100
+ /**
101
+ * コロンの後ろを値として読む。
102
+ *
103
+ * 引用符で囲まれていれば**閉じの引用符より後ろを落とし**、囲まれていなければ
104
+ * **空白に続く `#` から行末までを落とす**(YAML のコメント)。引用の内側の `#` と、
105
+ * 空白を伴わない `#`(`メモ#タグ`)は値の一部である。
106
+ */
107
+ function readValue(raw) {
108
+ const value = raw.trim();
109
+ // 1 行では読み取れない書き方。ブロックスカラー(`|` `>`)とアンカー・参照(`&` `*`)
110
+ if (!value || /^[|>&*]/.test(value))
111
+ return null;
112
+ // 閉じの引用符は、円記号でエスケープされたものを数えない(中身は解除せずそのまま返す)
113
+ const double = /^"((?:[^"\\]|\\[\s\S])*)"/.exec(value);
114
+ if (double)
115
+ return double[1] || null;
116
+ /**
117
+ * 単一引用の規則は「囲む」と「中の `'` を `''` にする」の 2 つで閉じる。戻すのは
118
+ * その 1 つだけで、円記号のエスケープは持たない(→ `writeValue` と対になる)。
119
+ * 二重引用の読み方を変えないのは、手で書かれた既存の文書を守るためである。
120
+ */
121
+ const single = /^'((?:[^']|'')*)'/.exec(value);
122
+ if (single)
123
+ return single[1].replaceAll("''", "'") || null;
124
+ return value.replace(/(^|\s)#[\s\S]*$/, '').trimEnd() || null;
125
+ }
126
+ function escapeForRegExp(value) {
127
+ return value.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
128
+ }
129
+ /**
130
+ * マークダウン**全体**の項目を書き換え、書き換えた全体を返す(公開 API)。
131
+ *
132
+ * 領域の切り出しは `splitFrontMatter` に委ね、判定を 2 通り持たない。領域を持たない
133
+ * 文字列(空文字列を含む)には、先頭に領域を作って書く。
134
+ *
135
+ * 返す文字列は**正準形**である——読み込みと書き出しに通しても変わらない。壊れると、
136
+ * 繰り返し書き込む利用側で「保存が止まらない」という症状になる。
137
+ */
138
+ export function writeFrontMatterFields(markdown, fields) {
139
+ if (Object.keys(fields).length === 0)
140
+ return { ok: true, value: markdown };
141
+ const { content, body } = splitFrontMatter(markdown);
142
+ const written = writeFields(content, fields);
143
+ if (!written.ok)
144
+ return written;
145
+ return { ok: true, value: `---\n${written.value}\n---\n${seam(body)}` };
146
+ }
147
+ /**
148
+ * 領域と本文の継ぎ目を正準形へ揃える。
149
+ *
150
+ * **落とすのは表示に現れない空白だけ**である。その文書を開いた利用者の最初の保存で
151
+ * エディタ自身が同じ正規化を行う。ここはそれを先にやっているにすぎない。
152
+ */
153
+ function seam(body) {
154
+ if (!body.trim())
155
+ return '';
156
+ return `\n${body.replace(/^\n+/, '')}`;
157
+ }
158
+ /**
159
+ * フロントマターの**中身**の項目を書き換え、書き換えた中身を返す。
160
+ *
161
+ * 1 つでも書けないキー・値があれば、**その呼び出しの項目をいずれも書かない**。
162
+ * 半分だけ入った状態を作らないためである。
163
+ */
164
+ export function writeFields(content, fields) {
165
+ const error = unwritableField(fields);
166
+ if (error)
167
+ return { ok: false, error };
168
+ return { ok: true, value: rewrite(content, fields) };
169
+ }
170
+ /**
171
+ * 書けないキー・値を 1 つ見つけて返す。無ければ `null`。
172
+ *
173
+ * キーの誤りは値の誤りより重い。壊れた値が入っても読めないのはその項目だけだが、
174
+ * 壊れたキーは領域の切り出しと項目の探索から外れ、**領域全体の読み取りを崩す**。
175
+ */
176
+ function unwritableField(fields) {
177
+ for (const [key, value] of Object.entries(fields)) {
178
+ if (!isFieldName(key))
179
+ return { kind: 'unwritable-field', key, reason: 'invalid-key' };
180
+ if (typeof value !== 'string')
181
+ continue;
182
+ // どちらも `readValue` が読み戻せない。**読み戻せない値を書かない**
183
+ if (!value)
184
+ return { kind: 'unwritable-field', key, reason: 'empty-value' };
185
+ if (/[\r\n]/.test(value))
186
+ return { kind: 'unwritable-field', key, reason: 'multiline-value' };
187
+ }
188
+ return null;
189
+ }
190
+ /**
191
+ * 既にある項目はその範囲だけを置き換え、まだ無い項目は末尾へ渡された順に足す。
192
+ *
193
+ * 置き換えは**後ろから**当てる。前から当てると、置き換えるたびに後ろの範囲がずれる。
194
+ * 渡されなかった項目は、値・並び・字下げ・コメント・空行を含めて 1 文字も変わらない。
195
+ */
196
+ function rewrite(content, fields) {
197
+ const keys = Object.keys(fields);
198
+ const ranges = findFieldRanges(content, keys);
199
+ let next = content;
200
+ for (const range of [...ranges].reverse()) {
201
+ const line = writeLine(range.key, fields[range.key]);
202
+ next = next.slice(0, range.start) + line + next.slice(range.end);
203
+ }
204
+ const existing = new Set(ranges.map((range) => range.key));
205
+ const added = keys.filter((key) => !existing.has(key)).map((key) => writeLine(key, fields[key]));
206
+ if (added.length === 0)
207
+ return next;
208
+ return next ? `${next}\n${added.join('\n')}` : added.join('\n');
209
+ }
210
+ /**
211
+ * フロントマターの**中身**の中で、指定したキーの項目が占める範囲を返す。
212
+ * まだ無いキーは返さない。並びは中身の中での出現順で、同じキーは最初のものだけを返す。
213
+ *
214
+ * 範囲は字下げの無い `キー:` の行から始まり、次の字下げの無い `キー:` の行の直前で
215
+ * 終わる。ただし**そこへ連続するコメント行と空行は後続の項目に属する**——コメントは
216
+ * 下に来る項目の説明として書かれるのが普通であり、置き換えで消さない。
217
+ *
218
+ * **範囲の規則を持つのはこの関数だけである。** 書き出しも、エディタの「利用者がその項目を
219
+ * 編集中か」の判定も、ここを通る(規則を 2 か所に置かないための入口)。
220
+ */
221
+ export function findFieldRanges(content, keys) {
222
+ const lines = lineSpans(content);
223
+ const wanted = new Set(keys);
224
+ const found = new Set();
225
+ const ranges = [];
226
+ lines.forEach((line, index) => {
227
+ const key = line.key;
228
+ if (key === null || !wanted.has(key) || found.has(key))
229
+ return;
230
+ found.add(key);
231
+ ranges.push({ key, start: line.start, end: lines[lastLineOfField(lines, index)].end });
232
+ });
233
+ return ranges;
234
+ }
235
+ /** 項目の最後の行の添字。次のキー行の手前から、続くコメント行と空行を戻す */
236
+ function lastLineOfField(lines, index) {
237
+ const next = lines.findIndex((line, at) => at > index && line.key !== null);
238
+ // 下に項目が無ければ末尾まで。末尾のコメントがここに入るのは避けようのない限界である
239
+ if (next === -1)
240
+ return lines.length - 1;
241
+ let last = next - 1;
242
+ while (last > index && /^(#|\s*$)/.test(lines[last].text))
243
+ last -= 1;
244
+ return last;
245
+ }
246
+ function lineSpans(content) {
247
+ const spans = [];
248
+ let start = 0;
249
+ for (const text of content.split('\n')) {
250
+ spans.push({ text, start, end: start + text.length, key: FIELD_LINE.exec(text)?.[1] ?? null });
251
+ start += text.length + 1;
252
+ }
253
+ return spans;
254
+ }
255
+ /** 1 つの項目を 1 行として書く */
256
+ function writeLine(key, value) {
257
+ return `${key}: ${writeValue(value)}`;
258
+ }
259
+ /**
260
+ * 値を 1 行の中に書く。
261
+ *
262
+ * 文字列以外(数値・真偽値・空値・配列・オブジェクト)は JSON の表記のまま置く。
263
+ * YAML のフロー記法として妥当であり、読み取りはそれを文字列として返す。
264
+ *
265
+ * 引用は**単一引用だけ**を使い、円記号のエスケープを持ち込まない。単一引用の規則は
266
+ * 「囲む」と「中の `'` を `''` にする」の 2 つで閉じており、読み取り側もその 1 つを
267
+ * 戻すだけで対になる(→ `readValue`)。
268
+ */
269
+ function writeValue(value) {
270
+ if (typeof value !== 'string')
271
+ return JSON.stringify(value);
272
+ return isPlainSafe(value) ? value : `'${value.replaceAll("'", "''")}'`;
273
+ }
274
+ /** 行頭に置くと構造の指示として読まれる文字 */
275
+ const INDICATOR = /^[-?:,[\]{}#&*!|>'"%@`]/;
276
+ /** 素で書くと文字列以外の型として読まれうる形(数値に見えるものは `Number` で見る) */
277
+ const TYPED = /^(true|false|null|~|[-+]?\.(inf|nan))$/i;
278
+ /**
279
+ * 引用符で囲まずに書けるか。
280
+ *
281
+ * **狭く取り、迷ったら引用する。** 引用は常に妥当で常に読み戻せるため、誤りの方向が
282
+ * 安全である。型として読まれうる形を外すのは、こちらの読み取りが常に文字列を返しても、
283
+ * **持ち出した先の YAML の読み取りで型が変わる**ためである。
284
+ *
285
+ * 判定は連言であり、最後に素で書いた値を読み取りへ通して一致まで確かめる。
286
+ * 手前の条件の取りこぼしに対する保険である。
287
+ */
288
+ function isPlainSafe(value) {
289
+ if (!value || value !== value.trim())
290
+ return false;
291
+ if (INDICATOR.test(value))
292
+ return false;
293
+ if (value.includes(': ') || value.endsWith(':'))
294
+ return false;
295
+ if (value.includes(' #'))
296
+ return false;
297
+ if (TYPED.test(value) || !Number.isNaN(Number(value)))
298
+ return false;
299
+ return readValue(value) === value;
300
+ }
@@ -0,0 +1,60 @@
1
+ import type { JsonValue } from '../../utils/json.types';
2
+ export type MarkdownParseError = {
3
+ readonly kind: 'invalid-structure';
4
+ readonly detail: string;
5
+ } | {
6
+ readonly kind: 'unsupported-schema';
7
+ readonly detail: string;
8
+ };
9
+ /** フロントマターへ書き込む項目。キーと JSON の値の対応 */
10
+ export type FrontMatterFields = Readonly<Record<string, JsonValue>>;
11
+ /**
12
+ * フロントマターから読み取った項目。
13
+ *
14
+ * 値の `null` は「項目ではあるが 1 行の値として読み取れない」を表し、**キーが無いことと
15
+ * は別である**。値は文字列のまま返し、型として解釈しない。
16
+ */
17
+ export type FrontMatterValues = Readonly<Record<string, string | null>>;
18
+ /**
19
+ * 書き込めなかった項目と、その理由。**呼び出し側の誤りだけを表す**。
20
+ *
21
+ * 利用者がその項目を編集している最中の見送りはここに入らない(成功側の `skipped`)。
22
+ * `not-ready` は編集の仕組みがまだ用意できていない場合で、項目を持たない。
23
+ */
24
+ export type FrontMatterWriteError = {
25
+ readonly kind: 'unwritable-field';
26
+ readonly key: string;
27
+ readonly reason: 'multiline-value' | 'empty-value' | 'invalid-key';
28
+ } | {
29
+ readonly kind: 'not-ready';
30
+ };
31
+ /** 書き込んだか、利用者の編集を避けて見送ったか */
32
+ export type FrontMatterWriteOutcome = 'applied' | 'skipped';
33
+ /**
34
+ * 本文のブロックの種別。**スキーマのノード名を借りない**——スキーマはエディタの都合で
35
+ * 分かれており(Mermaid を専用ノードにする・箇条書きは項目 1 つが 1 ノード)、
36
+ * 本文を読む側から見たセクションと一致しない。
37
+ */
38
+ export type MarkdownBlockKind = 'heading' | 'paragraph' | 'code' | 'table' | 'list' | 'blockquote' | 'horizontalRule'
39
+ /** モジュールが構造として解釈しない原文のブロック。現時点で到達するのは HTML ブロックだけ */
40
+ | 'raw';
41
+ /**
42
+ * 本文の最上位のブロック 1 つ。
43
+ *
44
+ * 範囲は、それを求めた**本文の文字列**に対する位置である。本文が変われば無効になる。
45
+ */
46
+ export interface MarkdownBlock {
47
+ readonly kind: MarkdownBlockKind;
48
+ /** 本文の中での開始位置(この位置を含む) */
49
+ readonly start: number;
50
+ /** 本文の中での終了位置(この位置を**含まない**) */
51
+ readonly end: number;
52
+ /** このブロックを含む見出しを外側から順に並べたもの。記法は落としてある */
53
+ readonly headingPath: readonly string[];
54
+ }
55
+ /** フロントマターの中身の中で、1 つの項目が占める範囲(`end` は含まない) */
56
+ export type FieldRange = {
57
+ readonly key: string;
58
+ readonly start: number;
59
+ readonly end: number;
60
+ };
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1 @@
1
+ export declare const markdownIt: import("markdown-it").MarkdownIt;
@@ -0,0 +1,92 @@
1
+ /**
2
+ * 本文のトークナイザの実例。**このファイルは実例と、その規則の手当てだけを持つ。**
3
+ *
4
+ * 本文の読み込み(`parser.ts`)・ブロックの並び(`blockOutline.ts`)・記法の除去
5
+ * (`plainText.ts`)が同じものを通ることで、**マークダウンの解釈がモジュールの中で
6
+ * 1 通りである**状態を保つ。設定を足すと、その解釈が黙って全体へ及ぶ。
7
+ *
8
+ * 実例をモジュールスコープに置くが、`parse()` は呼び出しごとに状態を作るため
9
+ * 可変の共有状態にはならない(`structure.md`「シングルトン状態を持たない」)。
10
+ */
11
+ import MarkdownIt from 'markdown-it';
12
+ // html: true にすると HTML ブロックが `html_block` として届く(原文のまま保持するために必要)
13
+ export const markdownIt = new MarkdownIt({ html: true, linkify: false, typographer: false });
14
+ /**
15
+ * 脚注(`本文[^1]` と `[^1]: 注`)を、参照リンクとして読ませない。
16
+ *
17
+ * このエディタは脚注に対応していない。既定の規則のままだと、`[^1]: 注` が**参照リンクの
18
+ * 定義**として読まれ、`注` が行き先として埋め込まれる(`本文[^1](%E6%B3%A8)`)。
19
+ * 定義の行はブロックの並びからも消える。**注の中身が別のものへ化ける**ため、往復で
20
+ * 失われる記法の中でもっともひどい壊れ方だった。
21
+ *
22
+ * 対応させるのではなく、**原文のまま持って返せる形にする**。規則を 2 つ足す。
23
+ *
24
+ * 1. 定義の行を、参照の規則より前に、**その 1 行だけの段落**として読む
25
+ * 2. 印(`[^1]`)を 1 つのトークンとして届ける
26
+ *
27
+ * 2 が要るのは、素の文字として届くと**書き出しが角括弧をエスケープする**ためである
28
+ * (`本文\[^1\]`)。専用のトークンにしておけば、読み込みが「文書モデルに居場所を
29
+ * 持たない記法」として受け皿へ入れ、書き出しは 1 文字も手を加えない。
30
+ * **この先の読み込みに、脚注のための分岐は 1 つも要らない。**
31
+ *
32
+ * **通常の参照リンク(`[a][ref]` と `[ref]: url`)には触らない。** 規則が見るのは
33
+ * ラベルが `^` で始まる行だけである。
34
+ */
35
+ const FOOTNOTE_LABEL = /^\^[^\s[\]]+$/;
36
+ const FOOTNOTE_DEFINITION = /^\[\^[^\s[\]]+\]:/;
37
+ const LEFT_BRACKET = 0x5b;
38
+ /**
39
+ * 定義の行(`[^1]: 注`)を、**その 1 行だけの段落**として読む。
40
+ *
41
+ * 参照の規則より前に置くことで、参照リンクの定義として食われる経路を塞ぐ。
42
+ * **1 行に限るのが要点である。** 続く行と 1 つの段落にすると、定義が 2 つ並んだ
43
+ * ときに `[^1]: 一 [^note]: 二` と繋がって、行の区切りが失われる。
44
+ *
45
+ * 段落として出すので、この先の読み込みに脚注のための分岐は要らない。行の中の印は
46
+ * インラインの規則が拾い、残りは普通の文字になる。
47
+ */
48
+ function readFootnoteDefinitions() {
49
+ markdownIt.block.ruler.before('reference', 'footnote_definition', (state, startLine, _endLine, silent) => {
50
+ const start = state.bMarks[startLine] + state.tShift[startLine];
51
+ const line = state.src.slice(start, state.eMarks[startLine]);
52
+ if (!FOOTNOTE_DEFINITION.test(line))
53
+ return false;
54
+ if (silent)
55
+ return true;
56
+ state.line = startLine + 1;
57
+ const open = state.push('paragraph_open', 'p', 1);
58
+ open.map = [startLine, state.line];
59
+ const inline = state.push('inline', '', 0);
60
+ inline.content = line.trim();
61
+ inline.map = [startLine, state.line];
62
+ inline.children = [];
63
+ state.push('paragraph_close', 'p', -1);
64
+ return true;
65
+ });
66
+ }
67
+ /**
68
+ * 脚注のマーカー(`[^1]`)を 1 つのトークンにする。
69
+ *
70
+ * リンクの規則より前に置く。あとに置くと、`[` から始まる形をリンクの規則が先に
71
+ * 見て、閉じの `]` までを別の解釈で消費してしまう。
72
+ */
73
+ function readFootnoteRefs() {
74
+ markdownIt.inline.ruler.before('link', 'footnote_ref', (state, silent) => {
75
+ const start = state.pos;
76
+ if (state.src.charCodeAt(start) !== LEFT_BRACKET)
77
+ return false;
78
+ const end = state.src.indexOf(']', start + 1);
79
+ if (end < 0 || end >= state.posMax)
80
+ return false;
81
+ if (!FOOTNOTE_LABEL.test(state.src.slice(start + 1, end)))
82
+ return false;
83
+ if (!silent) {
84
+ const token = state.push('footnote_ref', '', 0);
85
+ token.content = state.src.slice(start, end + 1);
86
+ }
87
+ state.pos = end + 1;
88
+ return true;
89
+ });
90
+ }
91
+ readFootnoteDefinitions();
92
+ readFootnoteRefs();
@@ -0,0 +1,4 @@
1
+ import { type Node } from 'prosemirror-model';
2
+ import type { MarkdownParseError } from './markdown.types';
3
+ import type { Result } from '../../utils/result.types';
4
+ export declare function parseMarkdown(markdown: string): Result<Node, MarkdownParseError>;