@14ch/svelte-md-outliner 0.0.1 → 0.0.3
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.
- package/CHANGELOG.md +73 -0
- package/LICENSE +21 -0
- package/README.ja.md +33 -17
- package/README.md +33 -17
- package/dist/assets/styles/editor.css +77 -3
- package/dist/assets/styles/theme.css +4 -0
- package/dist/components/ContextMenu.svelte +12 -3
- package/dist/components/MarkdownEditor.svelte +26 -2
- package/dist/components/MarkdownEditor.svelte.d.ts +15 -0
- package/dist/index.d.ts +5 -0
- package/dist/messages/en.js +3 -1
- package/dist/messages/index.js +2 -0
- package/dist/messages/ja.js +3 -1
- package/dist/messages/messages.types.d.ts +6 -0
- package/dist/models/document/document.types.d.ts +7 -0
- package/dist/models/document/schema.js +98 -18
- package/dist/models/document/sectionTree.d.ts +9 -0
- package/dist/models/document/sectionTree.js +12 -0
- package/dist/models/markdown/parser.js +26 -19
- package/dist/models/markdown/serializer.js +65 -6
- package/dist/models/viewState/viewStateCodec.js +2 -2
- package/dist/operations/autoformat.js +17 -0
- package/dist/operations/commands/lineBreak.d.ts +3 -3
- package/dist/operations/commands/lineBreak.js +3 -3
- package/dist/operations/keymap/coreActions.js +2 -2
- package/dist/operations/keymap/viewActions.js +25 -1
- package/dist/operations/plugins/focus.js +2 -2
- package/dist/operations/plugins/imagePaste.d.ts +26 -0
- package/dist/operations/plugins/imagePaste.js +178 -0
- package/dist/operations/plugins/imageView.d.ts +16 -0
- package/dist/operations/plugins/imageView.js +102 -0
- package/dist/states/editorSession.js +25 -2
- package/dist/states/editorSession.types.d.ts +17 -0
- package/package.json +6 -1
|
@@ -14,6 +14,13 @@ import { MAX_HEADING_LEVEL, MIN_HEADING_LEVEL } from './document.types';
|
|
|
14
14
|
* 印は描画にも読み書きにも現れない。`toDOM` / `parseDOM` とマークダウンの入出力は
|
|
15
15
|
* 印の有無で変わらない。
|
|
16
16
|
*/
|
|
17
|
+
/**
|
|
18
|
+
* `htmlLineBreak` は**段落内改行を `<br>` で書くノードの印**である。表のセルに付く。
|
|
19
|
+
*
|
|
20
|
+
* マークダウンでは改行の書き方がブロックによって違う。段落は行末の `\` で書けるが、
|
|
21
|
+
* パイプ表のセルは 1 行で、`<br>` 以外に書く形が無い。印を読み書きの両方から見ることで、
|
|
22
|
+
* **書き出しと読み込みが同じ記法を指す**(→ `serializer.ts` / `parser.ts`)。
|
|
23
|
+
*/
|
|
17
24
|
/**
|
|
18
25
|
* 見出しどうしが作る階層を入れ子の `section` として表す。
|
|
19
26
|
*
|
|
@@ -78,6 +85,17 @@ const structureNodes = {
|
|
|
78
85
|
parseDOM: [{ tag: 'div.markdown-editor__intro-section' }]
|
|
79
86
|
},
|
|
80
87
|
/**
|
|
88
|
+
* `allowGapCursor` は**要選択ブロックの前後にカーソルの置き場所を作るための指定**である。
|
|
89
|
+
*
|
|
90
|
+
* 既定の判定は「次に来る既定の種別がテキストブロックなら置いてよい」であり、
|
|
91
|
+
* `heading block* section*` では既定の種別が `section` になるため、**セクションの中には
|
|
92
|
+
* 置き場所が 1 つもできない**。文書の末尾が表・コードブロックのとき、その下に書く
|
|
93
|
+
* 手段が無くなる(見出しを持たない `intro_section` は `block+` なので既定の種別が段落
|
|
94
|
+
* になり、そこだけ置けていた)。
|
|
95
|
+
*
|
|
96
|
+
* 明示しても、置き場所ができるのは前後が閉じている位置だけである(→ `createGapCursor`)。
|
|
97
|
+
* 段落と段落のあいだのような、文字を打てる位置が既にあるところには現れない。
|
|
98
|
+
*
|
|
81
99
|
* `collapsed` は「今どう見ているか」であって「何が書かれているか」ではない。
|
|
82
100
|
* 属性として持つのは、移動・複製・削除・取り消しにノードごと追随させるためである
|
|
83
101
|
* (書き出しには現れない。シリアライザは属性を読まない)。
|
|
@@ -87,6 +105,7 @@ const structureNodes = {
|
|
|
87
105
|
*/
|
|
88
106
|
section: {
|
|
89
107
|
content: 'heading block* section*',
|
|
108
|
+
allowGapCursor: true,
|
|
90
109
|
defining: true,
|
|
91
110
|
attrs: { collapsed: { default: false } },
|
|
92
111
|
toDOM: (node) => [
|
|
@@ -139,14 +158,18 @@ const blockNodes = {
|
|
|
139
158
|
/**
|
|
140
159
|
* `block` グループに入れない。見出しは section の先頭にしか置けない。
|
|
141
160
|
*
|
|
142
|
-
* 中身を `text*` に絞るのは、**見出しに段落内改行を置かせない**ためである。
|
|
161
|
+
* 中身を `(text | image)*` に絞るのは、**見出しに段落内改行を置かせない**ためである。
|
|
143
162
|
* ATX 見出し(`# ...`)はマークダウンでは 1 行のブロックで、行末の空白 2 つも `\` も
|
|
144
|
-
* 改行にならない。書ける手段は生の `<br>`
|
|
145
|
-
*
|
|
146
|
-
*
|
|
163
|
+
* 改行にならない。書ける手段は生の `<br>` だけだが、見出しの文字列はパンくず・
|
|
164
|
+
* 折りたたみの見出しとしても出る**1 行のもの**であり、改行を入れる場所ではない。
|
|
165
|
+
* 解釈せず文字として残すため、書けば往復で `<br>` という文字列のまま残る(→ `hard_break`)。
|
|
166
|
+
*
|
|
167
|
+
* **画像は受ける。** 絞っている目的は改行を置かせないことであって、記法を持つ内容を
|
|
168
|
+
* 拒むことではない(`inline*` にすると `hard_break` まで通ってしまう)。読める 1 行の
|
|
169
|
+
* 文字は `headingText` が決める(画像は代替文字で表す)。
|
|
147
170
|
*/
|
|
148
171
|
heading: {
|
|
149
|
-
content: 'text*',
|
|
172
|
+
content: '(text | image)*',
|
|
150
173
|
defining: true,
|
|
151
174
|
attrs: { level: { default: MIN_HEADING_LEVEL } },
|
|
152
175
|
toDOM: (node) => [
|
|
@@ -175,14 +198,14 @@ const blockNodes = {
|
|
|
175
198
|
* `level` は**原文のレベル**をそのまま持つ。`heading` と違い構造上の深さから
|
|
176
199
|
* 決め直さないのは、加わる階層が無く決め直す相手がいないためである。
|
|
177
200
|
*
|
|
178
|
-
* 中身を `text*` に絞る理由は `heading` と同じ(マークダウンでは 1
|
|
179
|
-
*
|
|
201
|
+
* 中身を `(text | image)*` に絞る理由は `heading` と同じ(マークダウンでは 1 行の
|
|
202
|
+
* ブロックで、改行を書く手段が無い)。画像を受けるところも同じである。
|
|
180
203
|
*
|
|
181
204
|
* parseDOM の規則の競合は並び順(スキーマのノード順)で決まり、`heading` の汎用
|
|
182
205
|
* `h1`〜`h6` 規則が先に並ぶため、`priority` を上げて先に評価させる。
|
|
183
206
|
*/
|
|
184
207
|
nested_heading: {
|
|
185
|
-
content: 'text*',
|
|
208
|
+
content: '(text | image)*',
|
|
186
209
|
group: 'block',
|
|
187
210
|
defining: true,
|
|
188
211
|
attrs: { level: { default: MIN_HEADING_LEVEL } },
|
|
@@ -200,9 +223,17 @@ const blockNodes = {
|
|
|
200
223
|
priority: 60
|
|
201
224
|
}))
|
|
202
225
|
},
|
|
226
|
+
/**
|
|
227
|
+
* `createGapCursor` は**このブロックの前後を「閉じている」と見なさせる指定**である。
|
|
228
|
+
* 編集基盤は隣が文字を持つブロックなら閉じていないと判断し、置き場所を作らない。
|
|
229
|
+
* 中身が文字(コードブロック・Mermaid)や段落(引用)であるブロックはこれに当たり、
|
|
230
|
+
* 文書の末尾に来ると**その下に書く手段が無くなる**。表は編集基盤が最初から閉じたもの
|
|
231
|
+
* として扱うため(`isolating`)、指定が要らない。
|
|
232
|
+
*/
|
|
203
233
|
blockquote: {
|
|
204
234
|
content: 'block+',
|
|
205
235
|
group: 'block',
|
|
236
|
+
createGapCursor: true,
|
|
206
237
|
defining: true,
|
|
207
238
|
requiredSelectionBlock: true,
|
|
208
239
|
toDOM: () => ['blockquote', { class: 'markdown-editor__blockquote' }, 0],
|
|
@@ -212,6 +243,7 @@ const blockNodes = {
|
|
|
212
243
|
content: 'text*',
|
|
213
244
|
group: 'block',
|
|
214
245
|
code: true,
|
|
246
|
+
createGapCursor: true,
|
|
215
247
|
defining: true,
|
|
216
248
|
requiredSelectionBlock: true,
|
|
217
249
|
marks: '',
|
|
@@ -242,6 +274,7 @@ const blockNodes = {
|
|
|
242
274
|
content: 'text*',
|
|
243
275
|
group: 'block',
|
|
244
276
|
code: true,
|
|
277
|
+
createGapCursor: true,
|
|
245
278
|
defining: true,
|
|
246
279
|
requiredSelectionBlock: true,
|
|
247
280
|
marks: '',
|
|
@@ -289,8 +322,10 @@ const blockNodes = {
|
|
|
289
322
|
* 消え、差分にも現れないためである。改行が黙って失われる書き方は選ばない。
|
|
290
323
|
*
|
|
291
324
|
* 置ける場所は**インラインを持つブロックのうち、`content` が `inline*` のもの**、
|
|
292
|
-
*
|
|
293
|
-
*
|
|
325
|
+
* つまり段落と表のセルである。**書き方はブロックによって違う**——段落は行末の `\`、
|
|
326
|
+
* セルは `<br>`(パイプ表のセルは 1 行で、他に書く形が無い → `htmlLineBreak`)。
|
|
327
|
+
*
|
|
328
|
+
* 見出しだけは `text*` に絞ってあり、構造として入らない。
|
|
294
329
|
*/
|
|
295
330
|
hard_break: {
|
|
296
331
|
inline: true,
|
|
@@ -300,13 +335,53 @@ const blockNodes = {
|
|
|
300
335
|
toDOM: () => ['br'],
|
|
301
336
|
parseDOM: [{ tag: 'br' }]
|
|
302
337
|
},
|
|
338
|
+
/**
|
|
339
|
+
* 画像。**独立したインラインノード**であり、受け皿の文字ではない。
|
|
340
|
+
*
|
|
341
|
+
* 属性は**記法に書かれている 3 つ**だけを持つ。寸法・配置・読み込み状態は文書に
|
|
342
|
+
* 書かれていないものであり、属性にしない(読み込み状態は NodeView が持つ)。
|
|
343
|
+
*
|
|
344
|
+
* 中身を持たない葉として定義する。編集基盤は葉を atom として扱うため、選択・削除は
|
|
345
|
+
* 1 文字と同じ単位になる。置ける場所は**インラインを受ける場所すべて**で、記法を
|
|
346
|
+
* 解釈しない場所(コードブロック・Mermaid・フロントマター)は `text*` なので構造として
|
|
347
|
+
* 拒まれる。
|
|
348
|
+
*
|
|
349
|
+
* **`draggable` にしない。** ドラッグでの追加は対象外であり、半端な振る舞いを作らない。
|
|
350
|
+
*
|
|
351
|
+
* `toDOM` と `parseDOM` の両方が要る。**編集エリアの中でのコピー・貼り付けが DOM を
|
|
352
|
+
* 通る**ためである。`src` は空文字になりうる(`![alt]()` と書かれた文書)。空でも
|
|
353
|
+
* 読み込みに失敗した表示として扱い、ノードは落とさない。
|
|
354
|
+
*/
|
|
355
|
+
image: {
|
|
356
|
+
inline: true,
|
|
357
|
+
group: 'inline',
|
|
358
|
+
attrs: { src: { default: '' }, alt: { default: '' }, title: { default: null } },
|
|
359
|
+
toDOM: (node) => [
|
|
360
|
+
'img',
|
|
361
|
+
{
|
|
362
|
+
class: 'markdown-editor__image',
|
|
363
|
+
src: node.attrs.src,
|
|
364
|
+
alt: node.attrs.alt,
|
|
365
|
+
title: node.attrs.title
|
|
366
|
+
}
|
|
367
|
+
],
|
|
368
|
+
parseDOM: [
|
|
369
|
+
{
|
|
370
|
+
tag: 'img[src]',
|
|
371
|
+
getAttrs: (element) => ({
|
|
372
|
+
src: element.getAttribute('src') ?? '',
|
|
373
|
+
alt: element.getAttribute('alt') ?? '',
|
|
374
|
+
title: element.getAttribute('title')
|
|
375
|
+
})
|
|
376
|
+
}
|
|
377
|
+
]
|
|
378
|
+
},
|
|
303
379
|
text: { group: 'inline' }
|
|
304
380
|
};
|
|
305
381
|
const tableNodeSpecs = tableNodes({
|
|
306
382
|
tableGroup: 'block',
|
|
307
|
-
//
|
|
308
|
-
|
|
309
|
-
cellContent: 'text*',
|
|
383
|
+
// セル内はインラインのみ。ブロック要素はスキーマ段階で拒否する
|
|
384
|
+
cellContent: 'inline*',
|
|
310
385
|
cellAttributes: {
|
|
311
386
|
// 列の配置指定。マークダウンの `|:--|--:|` と往復させるために保持する
|
|
312
387
|
align: {
|
|
@@ -333,7 +408,9 @@ const tableNodeSpecs = tableNodes({
|
|
|
333
408
|
const tableSpec = {
|
|
334
409
|
...tableNodeSpecs,
|
|
335
410
|
table: { ...tableNodeSpecs.table, requiredSelectionBlock: true },
|
|
336
|
-
table_row: { ...tableNodeSpecs.table_row, allowGapCursor: false }
|
|
411
|
+
table_row: { ...tableNodeSpecs.table_row, allowGapCursor: false },
|
|
412
|
+
table_cell: { ...tableNodeSpecs.table_cell, htmlLineBreak: true },
|
|
413
|
+
table_header: { ...tableNodeSpecs.table_header, htmlLineBreak: true }
|
|
337
414
|
};
|
|
338
415
|
const marks = {
|
|
339
416
|
link: {
|
|
@@ -400,17 +477,20 @@ const marks = {
|
|
|
400
477
|
},
|
|
401
478
|
/**
|
|
402
479
|
* その文字が**記法の原文**であり、書き出しで手を加えてはならないというマーク。
|
|
403
|
-
*
|
|
404
|
-
*
|
|
480
|
+
* 文書モデルで表現できない記法(インラインの HTML・番号付きの項目のチェックボックス・
|
|
481
|
+
* 脚注のマーカー)は、このマークを付けた文字として取り込む。**ブロックの側の
|
|
405
482
|
* `unknown_block` にあたるものが、インラインの側に無いことが壊れる理由だった。**
|
|
406
483
|
*
|
|
484
|
+
* **画像はここに含まれない。** 画像は自分のノード(→ `image`)と自分の読み書きの
|
|
485
|
+
* 規則を持ち、正準な形で往復する。
|
|
486
|
+
*
|
|
407
487
|
* **必ずマークの一覧のいちばん最後に置く。** マークの並びは宣言順(rank)の
|
|
408
488
|
* 昇順で作られるため、最後に置いたものが最も内側になる。書き出しの
|
|
409
489
|
* 「エスケープしない」(`escape: false`)が効くのは最も内側のマークのときだけであり、
|
|
410
490
|
* **後ろへマークを足すと、エスケープしない性質が黙って失われる**。
|
|
411
491
|
*
|
|
412
|
-
* `excludes`
|
|
413
|
-
* `inclusive: false`
|
|
492
|
+
* `excludes` を持たせないのは、リンクの中・強調の中の記法で共存が要るため。
|
|
493
|
+
* `inclusive: false` にするのは、**記法の直後に打った文字へマークが広がらない**ように
|
|
414
494
|
* するためである(広がると、書き手が普通に打った `[foo]` がエスケープされずリンクの
|
|
415
495
|
* 一部として読み直されうる)。同じスキーマの `link` が既にこの形である。
|
|
416
496
|
*
|
|
@@ -1,6 +1,15 @@
|
|
|
1
1
|
import type { Node } from 'prosemirror-model';
|
|
2
2
|
import type { Transaction } from 'prosemirror-state';
|
|
3
3
|
import { type SectionPath, type SectionRef } from './document.types';
|
|
4
|
+
/**
|
|
5
|
+
* 見出しの**読める 1 行の文字**。パンくず・折りたたみの見出し・表示状態の突合キーは
|
|
6
|
+
* すべてこれを使う。
|
|
7
|
+
*
|
|
8
|
+
* **`textContent` を直に読まない。** あちらは葉ノードを飛ばすため、画像を含む見出しから
|
|
9
|
+
* 画像が黙って消える。ここでは代替文字を葉の文字表現として与え、読み手に見えているものと
|
|
10
|
+
* 同じ 1 行を返す。見出しには改行が入らないため(→ スキーマの `heading`)、区切りは要らない。
|
|
11
|
+
*/
|
|
12
|
+
export declare function headingText(heading: Node): string;
|
|
4
13
|
export interface SectionTree {
|
|
5
14
|
/** 位置がもっとも内側で属するセクションを返す */
|
|
6
15
|
resolveSection(doc: Node, pos: number): SectionRef | null;
|
|
@@ -2,6 +2,18 @@ import { MAX_HEADING_LEVEL } from './document.types';
|
|
|
2
2
|
import { outlineSchema } from './schema';
|
|
3
3
|
const SECTION = outlineSchema.nodes.section;
|
|
4
4
|
const INTRO_SECTION = outlineSchema.nodes.intro_section;
|
|
5
|
+
const IMAGE = outlineSchema.nodes.image;
|
|
6
|
+
/**
|
|
7
|
+
* 見出しの**読める 1 行の文字**。パンくず・折りたたみの見出し・表示状態の突合キーは
|
|
8
|
+
* すべてこれを使う。
|
|
9
|
+
*
|
|
10
|
+
* **`textContent` を直に読まない。** あちらは葉ノードを飛ばすため、画像を含む見出しから
|
|
11
|
+
* 画像が黙って消える。ここでは代替文字を葉の文字表現として与え、読み手に見えているものと
|
|
12
|
+
* 同じ 1 行を返す。見出しには改行が入らないため(→ スキーマの `heading`)、区切りは要らない。
|
|
13
|
+
*/
|
|
14
|
+
export function headingText(heading) {
|
|
15
|
+
return heading.textBetween(0, heading.content.size, '', (leaf) => leaf.type === IMAGE ? String(leaf.attrs.alt ?? '') : '');
|
|
16
|
+
}
|
|
5
17
|
export const sectionTree = {
|
|
6
18
|
resolveSection,
|
|
7
19
|
resolveAncestors,
|
|
@@ -19,6 +19,8 @@ const TASK_MARKER = /^\[([ xX])\](\s+|$)/;
|
|
|
19
19
|
* (`C:\path` のような素のバックスラッシュを拾わない)。
|
|
20
20
|
*/
|
|
21
21
|
const ESCAPE_IN_SOURCE = /\\[!-/:-@[-`{-~]/;
|
|
22
|
+
/** 改行として書かれた `<br>`(→ スキーマの `htmlLineBreak`) */
|
|
23
|
+
const BR_TAG = /^<br\s*\/?>$/i;
|
|
22
24
|
export function parseMarkdown(markdown) {
|
|
23
25
|
try {
|
|
24
26
|
const { content, body } = splitFrontMatter(markdown);
|
|
@@ -334,7 +336,8 @@ function alignOf(token) {
|
|
|
334
336
|
}
|
|
335
337
|
// --- インライン ---
|
|
336
338
|
/**
|
|
337
|
-
*
|
|
339
|
+
* 段落内改行を置けるかは**行き先のノードに聞く**(見出しには置けない)。書かれ方も
|
|
340
|
+
* 行き先に聞く——表のセルの改行は `<br>` である(→ スキーマの `htmlLineBreak`)。
|
|
338
341
|
* 規則をスキーマだけが持つことで、置ける場所を変えたときに読み込み側が取り残されない。
|
|
339
342
|
* 置けない場所では、読めなくなるより繋がる方を採り、空白へ畳む。
|
|
340
343
|
*/
|
|
@@ -342,6 +345,7 @@ function parseInline(inline, into) {
|
|
|
342
345
|
const tokens = inline?.children ?? [];
|
|
343
346
|
const nodes = [];
|
|
344
347
|
const lineBreak = into.contentMatch.matchType(n.hard_break) !== null;
|
|
348
|
+
const htmlLineBreak = lineBreak && into.spec.htmlLineBreak === true;
|
|
345
349
|
const insideHtml = htmlElementContent(tokens, inline?.content ?? '');
|
|
346
350
|
let marks = Mark.none;
|
|
347
351
|
const push = (text) => {
|
|
@@ -407,15 +411,34 @@ function parseInline(inline, into) {
|
|
|
407
411
|
case 'link_close':
|
|
408
412
|
marks = m.link.removeFromSet(marks);
|
|
409
413
|
break;
|
|
414
|
+
/**
|
|
415
|
+
* 画像は独立したノードになる。直接の形・タイトルつき・参照の形を区別しない
|
|
416
|
+
* (行き先はトークンの属性に入っており、markdown-it が解決済みで渡す)。
|
|
417
|
+
* 代替文字の中の記法はトークンの側で文字へ落ちている。
|
|
418
|
+
*/
|
|
410
419
|
case 'image':
|
|
411
|
-
|
|
420
|
+
nodes.push(n.image.create({
|
|
421
|
+
src: token.attrGet('src') ?? '',
|
|
422
|
+
alt: token.content,
|
|
423
|
+
title: token.attrGet('title')
|
|
424
|
+
}, null, marks));
|
|
412
425
|
break;
|
|
413
426
|
// 印であることが画面から分かるように、見た目のマークだけ重ねる
|
|
414
427
|
case 'footnote_ref':
|
|
415
428
|
pushVerbatim(token.content, m.footnote.create());
|
|
416
429
|
break;
|
|
430
|
+
/**
|
|
431
|
+
* `<br>` を改行として読むのは、**改行を `<br>` で書く行の中だけ**である。
|
|
432
|
+
* 段落では書き手が書いた HTML のまま残す(段落の改行は `\` で書かれる)。
|
|
433
|
+
*/
|
|
434
|
+
case 'html_inline':
|
|
435
|
+
if (htmlLineBreak && BR_TAG.test(token.content))
|
|
436
|
+
nodes.push(n.hard_break.create());
|
|
437
|
+
else
|
|
438
|
+
pushVerbatim(token.content);
|
|
439
|
+
break;
|
|
417
440
|
default:
|
|
418
|
-
//
|
|
441
|
+
// 表現を持たない記法すべて。**記法の名前で分岐しない**
|
|
419
442
|
pushVerbatim(token.content);
|
|
420
443
|
break;
|
|
421
444
|
}
|
|
@@ -470,22 +493,6 @@ function htmlElementContent(tokens, source) {
|
|
|
470
493
|
});
|
|
471
494
|
return inside;
|
|
472
495
|
}
|
|
473
|
-
/**
|
|
474
|
-
* 画像の記法を、トークンの属性から組み立てる。
|
|
475
|
-
*
|
|
476
|
-
* **原文そのものは復元できない。** パーサが返すのは代替文字と属性だけで、
|
|
477
|
-
* 記法の原文(`markup`)も位置(`map`)も持たない。したがって間隔・`<>`・引用符の
|
|
478
|
-
* 種類は正準形へ揃う(`` → ``)。
|
|
479
|
-
* **壊れているのは記法が文字になることであって、書き方ではない。**
|
|
480
|
-
*
|
|
481
|
-
* 参照の形(`![alt][ref]`)も同じ経路を通る。行き先が属性に入っているためである。
|
|
482
|
-
*/
|
|
483
|
-
function imageNotation(token) {
|
|
484
|
-
const src = token.attrGet('src') ?? '';
|
|
485
|
-
const title = String(token.attrGet('title') ?? '');
|
|
486
|
-
const suffix = title ? ` "${title.replace(/"/g, '\\"')}"` : '';
|
|
487
|
-
return ``;
|
|
488
|
-
}
|
|
489
496
|
// --- ヘルパー ---
|
|
490
497
|
function matchingClose(tokens, start, openType, closeType) {
|
|
491
498
|
let depth = 0;
|
|
@@ -25,7 +25,7 @@ export function serializeSlice(slice) {
|
|
|
25
25
|
const line = partialLine(slice);
|
|
26
26
|
if (line) {
|
|
27
27
|
// コードブロックは記法を持たない。書き出しのエスケープ(`\*` など)も入れずに素の文字を返す
|
|
28
|
-
return line.type.spec.code ? line.textContent :
|
|
28
|
+
return line.type.spec.code ? line.textContent : writeLine(line);
|
|
29
29
|
}
|
|
30
30
|
// スライスは単体では文書として成立しないため、内容検証を伴わないコンテナへ載せる
|
|
31
31
|
return serializeMarkdown(n.doc.create(null, wrapTableRows(slice.content)));
|
|
@@ -135,6 +135,38 @@ function writeBlocks(content) {
|
|
|
135
135
|
function writeInline(content) {
|
|
136
136
|
return writeBlocks(Fragment.from(n.paragraph.create(null, content))).trim();
|
|
137
137
|
}
|
|
138
|
+
/**
|
|
139
|
+
* 行(テキストブロック)の中身を書き出す。**改行の記法は行の側が決める**
|
|
140
|
+
* (→ スキーマの `htmlLineBreak`)。
|
|
141
|
+
*/
|
|
142
|
+
function writeLine(line) {
|
|
143
|
+
return line.type.spec.htmlLineBreak
|
|
144
|
+
? writeHtmlBreakLine(line.content)
|
|
145
|
+
: writeInline(line.content);
|
|
146
|
+
}
|
|
147
|
+
/**
|
|
148
|
+
* 改行を `<br>` で書く行。**改行で区切って、区切りごとに書き出す。**
|
|
149
|
+
*
|
|
150
|
+
* `hard_break` の書き出し(行末の `\`)へ回さないのは、行末が来ないためである——
|
|
151
|
+
* セルは 1 行で、続きは同じ行に並ぶ。区切って書けば、改行の次の文字が行頭に来ないことも
|
|
152
|
+
* そのまま表れる(行頭の記号のエスケープが要らない)。
|
|
153
|
+
*/
|
|
154
|
+
function writeHtmlBreakLine(content) {
|
|
155
|
+
const parts = [];
|
|
156
|
+
let pending = [];
|
|
157
|
+
const flush = () => {
|
|
158
|
+
parts.push(writeInline(Fragment.fromArray(pending)));
|
|
159
|
+
pending = [];
|
|
160
|
+
};
|
|
161
|
+
content.forEach((child) => {
|
|
162
|
+
if (child.type === n.hard_break)
|
|
163
|
+
flush();
|
|
164
|
+
else
|
|
165
|
+
pending.push(child);
|
|
166
|
+
});
|
|
167
|
+
flush();
|
|
168
|
+
return parts.join('<br>');
|
|
169
|
+
}
|
|
138
170
|
const serializeParagraph = (state, node) => {
|
|
139
171
|
state.renderInline(node);
|
|
140
172
|
state.closeBlock(node);
|
|
@@ -184,6 +216,21 @@ const serializeHardBreak = (state, node, parent, index) => {
|
|
|
184
216
|
}
|
|
185
217
|
}
|
|
186
218
|
};
|
|
219
|
+
/**
|
|
220
|
+
* 画像。**記法を組み立てる場所はここだけ**である(読み込みは属性を写すだけ → `parser.ts`)。
|
|
221
|
+
*
|
|
222
|
+
* 代替文字は**そのスロットの原文**なので、1 文字も足さず 1 文字も削らない。書き出しの
|
|
223
|
+
* 既定のエスケープへ回すと、原文にあった記号(`**` や `\[`)に `\` が重なり、
|
|
224
|
+
* **往復のたびに記号が増える**。逃がすのは、書いたものが別の意味に読み直される 2 つ——
|
|
225
|
+
* 出どころの丸括弧(`(` で閉じてしまう)と、タイトルの引用符(`"` で閉じてしまう)だけである。
|
|
226
|
+
*/
|
|
227
|
+
const serializeImage = (state, node) => {
|
|
228
|
+
const alt = String(node.attrs.alt ?? '');
|
|
229
|
+
const src = String(node.attrs.src ?? '').replace(/[()]/g, '\\$&');
|
|
230
|
+
const title = node.attrs.title;
|
|
231
|
+
const suffix = title ? ` "${String(title).replace(/"/g, '\\"')}"` : '';
|
|
232
|
+
state.write(``);
|
|
233
|
+
};
|
|
187
234
|
/**
|
|
188
235
|
* 文字。**改行の次の行だけは、行頭の記号を自分でエスケープする。**
|
|
189
236
|
*
|
|
@@ -263,7 +310,7 @@ const serializeTable = (state, node) => {
|
|
|
263
310
|
node.forEach((row, _offset, rowIndex) => {
|
|
264
311
|
const cells = [];
|
|
265
312
|
row.forEach((cell) => {
|
|
266
|
-
cells.push(escapeCell(
|
|
313
|
+
cells.push(escapeCell(writeLine(cell)));
|
|
267
314
|
if (rowIndex === 0)
|
|
268
315
|
aligns.push(cell.attrs.align);
|
|
269
316
|
});
|
|
@@ -298,6 +345,7 @@ const blocks = {
|
|
|
298
345
|
const nodes = {
|
|
299
346
|
...Object.fromEntries(Object.entries(blocks).map(([name, serialize]) => [name, afterBlankLine(serialize)])),
|
|
300
347
|
hard_break: serializeHardBreak,
|
|
348
|
+
image: serializeImage,
|
|
301
349
|
text: serializeText
|
|
302
350
|
};
|
|
303
351
|
const marks = {
|
|
@@ -332,15 +380,26 @@ const marks = {
|
|
|
332
380
|
};
|
|
333
381
|
const markdownSerializer = new MarkdownSerializer(nodes, marks);
|
|
334
382
|
// --- ヘルパー ---
|
|
383
|
+
/**
|
|
384
|
+
* 中身が空行だけか(先頭セクションを書き出すかの判定)。
|
|
385
|
+
*
|
|
386
|
+
* **文字だけを見ない。** 画像は文字を持たない葉なので、`textContent` で見ると
|
|
387
|
+
* 画像 1 つの段落が「空行」と判定され、書き出しから丸ごと落ちる。
|
|
388
|
+
* 文字以外の内容を持つ段落は、空行ではない。
|
|
389
|
+
*/
|
|
335
390
|
function isBlank(node) {
|
|
336
|
-
if (node.textContent.trim() !== '')
|
|
337
|
-
return false;
|
|
338
391
|
let blank = true;
|
|
339
392
|
node.forEach((child) => {
|
|
340
|
-
if (child.type !== n.paragraph)
|
|
393
|
+
if (child.type !== n.paragraph) {
|
|
341
394
|
blank = false;
|
|
395
|
+
return;
|
|
396
|
+
}
|
|
397
|
+
child.forEach((inline) => {
|
|
398
|
+
if (!inline.isText)
|
|
399
|
+
blank = false;
|
|
400
|
+
});
|
|
342
401
|
});
|
|
343
|
-
return blank;
|
|
402
|
+
return blank && node.textContent.trim() === '';
|
|
344
403
|
}
|
|
345
404
|
/**
|
|
346
405
|
* 記号だけの行に続くブロックを、空行を挟まずに書く。
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { outlineSchema } from '../document/schema';
|
|
2
|
-
import { sectionTree } from '../document/sectionTree';
|
|
2
|
+
import { headingText, sectionTree } from '../document/sectionTree';
|
|
3
3
|
import { isViewState } from './viewState.types';
|
|
4
4
|
const SECTION = outlineSchema.nodes.section;
|
|
5
5
|
/** 形式の版。将来の変更で増やし、古い側は「未対応」として安全に無視できるようにする */
|
|
@@ -152,7 +152,7 @@ function keyOf(path) {
|
|
|
152
152
|
function hashOfChain(chain) {
|
|
153
153
|
let hash = 0x811c9dc5;
|
|
154
154
|
for (const section of chain) {
|
|
155
|
-
hash = mix(hash, section.child(0)
|
|
155
|
+
hash = mix(hash, headingText(section.child(0)));
|
|
156
156
|
// 区切りを混ぜる。混ぜないと「AB / C」と「A / BC」が同じ値になる
|
|
157
157
|
hash = step(hash, 0x1f);
|
|
158
158
|
}
|
|
@@ -27,6 +27,23 @@ export const autoformatRules = [
|
|
|
27
27
|
textblockTypeInputRule(/^```mermaid[\s\n]$/, outlineSchema.nodes.mermaid_block),
|
|
28
28
|
textblockTypeInputRule(/^```([a-zA-Z0-9_+#-]*)[\s\n]$/, outlineSchema.nodes.code_block, (match) => ({ language: match[1] ?? '' })),
|
|
29
29
|
new InputRule(/^(?:---|___|\*\*\*)$/, (state, _match, start, end) => state.tr.replaceWith(start, end, outlineSchema.nodes.horizontal_rule.create())),
|
|
30
|
+
/**
|
|
31
|
+
* 打った画像記法を、閉じ括弧まで打ち終えた時点で画像にする。
|
|
32
|
+
*
|
|
33
|
+
* **記法の判定を 3 つ目にしたわけではない。** ここが見るのは**打っている途中の 1 行**
|
|
34
|
+
* であり、文書全体を解釈する読み込み(markdown-it)とは役割が違う。取り出す属性は
|
|
35
|
+
* 書き出し(→ `serializer.ts` の `serializeImage`)の鏡である。
|
|
36
|
+
*
|
|
37
|
+
* 代替文字は角括弧を含まない範囲、出どころは空白と丸括弧を含まない範囲に限る。
|
|
38
|
+
* 打っている最中の 1 行で、釣り合いを数える相手がいないためである(込み入った形は
|
|
39
|
+
* 読み込みが受け止める)。記法を解釈しない場所(コードブロック・Mermaid・
|
|
40
|
+
* フロントマター)では、入力規則の仕組み自体が働かない(`code` なブロックを除く)。
|
|
41
|
+
*/
|
|
42
|
+
new InputRule(/!\[([^[\]]*)\]\(([^\s()]*)(?:\s+"([^"]*)")?\)$/, (state, match, start, end) => state.tr.replaceWith(start, end, outlineSchema.nodes.image.create({
|
|
43
|
+
src: match[2] ?? '',
|
|
44
|
+
alt: match[1] ?? '',
|
|
45
|
+
title: match[3] ?? null
|
|
46
|
+
}))),
|
|
30
47
|
markInputRule(/(\*\*([^*]+)\*\*)$/, outlineSchema.marks.strong),
|
|
31
48
|
markInputRule(/(?:^|[^*])(\*([^*]+)\*)$/, outlineSchema.marks.em),
|
|
32
49
|
markInputRule(/(~~([^~]+)~~)$/, outlineSchema.marks.strikethrough),
|
|
@@ -2,8 +2,8 @@ import type { EditorCommand } from '../operations.types';
|
|
|
2
2
|
/**
|
|
3
3
|
* 段落を分けずに改行する。
|
|
4
4
|
*
|
|
5
|
-
*
|
|
6
|
-
*
|
|
7
|
-
*
|
|
5
|
+
* 置けるかどうかはスキーマに聞き、種別で判定しない。見出しは中身が `text*` であるため、
|
|
6
|
+
* ここで名前を並べなくても偽が返る(→ スキーマの `hard_break`)。判定を二重に持たない
|
|
7
|
+
* ことで、置ける場所を増やしたときに直し忘れが起きない。
|
|
8
8
|
*/
|
|
9
9
|
export declare const insertLineBreak: EditorCommand;
|
|
@@ -2,9 +2,9 @@ import { outlineSchema } from '../../models/document/schema';
|
|
|
2
2
|
/**
|
|
3
3
|
* 段落を分けずに改行する。
|
|
4
4
|
*
|
|
5
|
-
*
|
|
6
|
-
*
|
|
7
|
-
*
|
|
5
|
+
* 置けるかどうかはスキーマに聞き、種別で判定しない。見出しは中身が `text*` であるため、
|
|
6
|
+
* ここで名前を並べなくても偽が返る(→ スキーマの `hard_break`)。判定を二重に持たない
|
|
7
|
+
* ことで、置ける場所を増やしたときに直し忘れが起きない。
|
|
8
8
|
*/
|
|
9
9
|
export const insertLineBreak = (state, dispatch) => {
|
|
10
10
|
const { $from } = state.selection;
|
|
@@ -365,8 +365,8 @@ export const coreActions = [
|
|
|
365
365
|
/**
|
|
366
366
|
* 段落を分けずに改行する。`Shift+Enter` は多くのエディタでこの意味を持つ。
|
|
367
367
|
*
|
|
368
|
-
*
|
|
369
|
-
*
|
|
368
|
+
* 置けない場所(見出し)では偽を返し、何も起きない。同じキーへ別の意味を用意しない
|
|
369
|
+
* のは、キーの意味を場所ごとに覚えることになるためである。
|
|
370
370
|
*/
|
|
371
371
|
{
|
|
372
372
|
id: 'editing.insertLineBreak',
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import { sectionCommands } from '../commands/element';
|
|
1
2
|
import { targetSection } from '../commands/section';
|
|
2
3
|
import { foldCommands } from '../commands/sectionFold';
|
|
3
4
|
import { headingJump } from '../commands/sectionJump';
|
|
@@ -28,7 +29,20 @@ export function createViewActions(focus, toggleShortcutHelp) {
|
|
|
28
29
|
changesDocument: false,
|
|
29
30
|
keys: [{ key: '.', mod: true }],
|
|
30
31
|
command: foldCommands.toggleFold,
|
|
31
|
-
|
|
32
|
+
/**
|
|
33
|
+
* 折りたたみはサブツリー単位の操作。**印を付けた対象そのものが畳めるとき
|
|
34
|
+
* だけ出す**(見出しと、子を持つ項目)。段落・表・コードブロックの中から
|
|
35
|
+
* 出すと、メニューが指しているアイテムではなく外側のセクションが畳まれ、
|
|
36
|
+
* **印を付けた当のアイテムごと隠れる**。要選択ブロックの中で外側への操作を
|
|
37
|
+
* 出さない規則(→ `coreActions.ts` の `unpointedRequiredSelectionTarget`)
|
|
38
|
+
* とも食い違っていた。キーは従来どおりどこからでも働く
|
|
39
|
+
* (→ `view.focusSection` と同じ扱い)。
|
|
40
|
+
*/
|
|
41
|
+
variantId: (state) => {
|
|
42
|
+
if (!foldsPointedItem(state))
|
|
43
|
+
return null;
|
|
44
|
+
return foldCommands.isFolded(state) ? 'view.toggleFold.unfold' : 'view.toggleFold.fold';
|
|
45
|
+
}
|
|
32
46
|
},
|
|
33
47
|
// `,` は `<`、`.` は `>` の位置にあり、閉じる・開くの向きとして読める
|
|
34
48
|
{
|
|
@@ -177,6 +191,16 @@ export function createContextMenuShortcut(toggleContextMenu) {
|
|
|
177
191
|
}
|
|
178
192
|
];
|
|
179
193
|
}
|
|
194
|
+
/**
|
|
195
|
+
* メニューが指しているアイテムが、そのまま折りたたみの対象になるか。
|
|
196
|
+
*
|
|
197
|
+
* 折りたたみの対象は見出し(セクション)と箇条書きの項目だけである。畳めるかどうか
|
|
198
|
+
* (子を持つか)は実行の可否として別に判定される(→ `menuGroupsFor` の試し実行)。
|
|
199
|
+
*/
|
|
200
|
+
function foldsPointedItem(state) {
|
|
201
|
+
const kind = sectionCommands.targetElement(state)?.kind;
|
|
202
|
+
return kind === 'section' || kind === 'listItem';
|
|
203
|
+
}
|
|
180
204
|
function levels() {
|
|
181
205
|
return Array.from({ length: MAX_HEADING_LEVEL }, (_, index) => (index + 1));
|
|
182
206
|
}
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { Plugin, PluginKey, TextSelection } from 'prosemirror-state';
|
|
2
2
|
import { Decoration, DecorationSet } from 'prosemirror-view';
|
|
3
3
|
import { outlineSchema } from '../../models/document/schema';
|
|
4
|
-
import { sectionTree } from '../../models/document/sectionTree';
|
|
4
|
+
import { headingText, sectionTree } from '../../models/document/sectionTree';
|
|
5
5
|
import { originOf } from '../transactionOrigin';
|
|
6
6
|
const SECTION = outlineSchema.nodes.section;
|
|
7
7
|
/** 範囲外のブロックに付ける印。隠すかどうかの決定は CSS に委ねる */
|
|
@@ -324,7 +324,7 @@ function breadcrumbOf(doc, anchorPos) {
|
|
|
324
324
|
chain.push(self);
|
|
325
325
|
return chain
|
|
326
326
|
.filter((ref) => ref.path !== null)
|
|
327
|
-
.map((ref) => ({ path: ref.path, title: ref.node.child(0)
|
|
327
|
+
.map((ref) => ({ path: ref.path, title: headingText(ref.node.child(0)) }));
|
|
328
328
|
}
|
|
329
329
|
/**
|
|
330
330
|
* 解除時に戻すためのスクロール位置。
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
import { Plugin } from 'prosemirror-state';
|
|
2
|
+
import { DecorationSet } from 'prosemirror-view';
|
|
3
|
+
/**
|
|
4
|
+
* 貼り付けられた画像を引き受け、表示に使う URL を返す。
|
|
5
|
+
* 保存先・形式やサイズの判定・アクセス制御は呼び出し側の裁量である。
|
|
6
|
+
* 失敗は reject または `null` で表す。
|
|
7
|
+
*/
|
|
8
|
+
export type ImageUpload = (file: File) => Promise<string | null>;
|
|
9
|
+
/** 呼ぶ時点の引き受け先を返す。渡されていなければ `undefined`(要件 4.4) */
|
|
10
|
+
export type ImageUploadSource = () => ImageUpload | undefined;
|
|
11
|
+
/** 待っているあいだの表示に使う文言 */
|
|
12
|
+
export interface ImagePasteText {
|
|
13
|
+
readonly uploading: string;
|
|
14
|
+
}
|
|
15
|
+
/**
|
|
16
|
+
* 貼り付けられた画像を引き受け、返された URL で画像を差し込む。
|
|
17
|
+
*
|
|
18
|
+
* **文書は、引き受け先が答えるまで 1 文字も変わらない。** 待っているあいだ置くのは
|
|
19
|
+
* decoration の印だけで、それは文書ではない(書き出しにも現れない)。失敗したときに
|
|
20
|
+
* 「無かった状態へ戻す」が印を消すだけで済むのは、この形の帰結である。
|
|
21
|
+
*
|
|
22
|
+
* **譲る条件は 4 つあり、すべて委譲の前にある**(要件 4.4・4.5・6.1)。1 つでも偽なら
|
|
23
|
+
* `false` を返し、後段の貼り付け(`markdownClipboard`)が従来どおり働く。譲る側の条件を
|
|
24
|
+
* **登録順で表す**ため、このプラグインは `markdownClipboard` より前に置く。
|
|
25
|
+
*/
|
|
26
|
+
export declare function imagePastePlugin(getUpload: ImageUploadSource, getText: () => ImagePasteText): Plugin<DecorationSet>;
|