mirror of
https://github.com/toeverything/AFFiNE.git
synced 2026-08-18 18:41:52 +08:00
24448659a4
Fix #12284 Close [BS-3517](https://linear.app/affine-design/issue/BS-3517/微软新注音输入法无法使用markdown语法) This PR refactor the markdown transform during inputting, including: - Transfrom markdown syntax input in `inlineEditor.slots.inputting`, where we can detect the space character inputed by IME like Microsoft Bopomofo, but `keydown` event can't. - Remove `markdown-input.ts` which was used in `KeymapExtension` of paragraph, and refactor with `InlineMarkdownExtension` - Adjust existing `InlineMarkdownExtension` since the space is included in text. - Add two `InlineMarkdownExtension` for paragraph and list to impl Heading1-6, number, bullet, to-do list conversion. Other changes: - Improve type hint for parameter of `store.addBlock` <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit ## Summary by CodeRabbit - **New Features** - Added markdown shortcuts for creating code blocks and dividers in the rich text editor. - Introduced enhanced paragraph markdown support for headings and blockquotes with inline markdown patterns. - Integrated new list markdown extension supporting numbered, bulleted, and todo lists with checked states. - **Improvements** - Updated markdown formatting patterns to require trailing spaces for links, LaTeX, and inline styles, improving detection accuracy. - Markdown transformations now respond to input events instead of keydown for smoother editing experience. - Added focus management after markdown transformations to maintain seamless editing flow. - **Bug Fixes** - Removed unnecessary prevention of default behavior on space and shift-space key presses in list and paragraph editors. - **Refactor** - Enhanced event handling and typing for editor input events, improving reliability and maintainability. - Refined internal prefix text extraction logic for markdown processing. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
285 lines
6.9 KiB
TypeScript
285 lines
6.9 KiB
TypeScript
import { LatexExtension } from '@blocksuite/affine-inline-latex';
|
|
import type { AffineTextAttributes } from '@blocksuite/affine-shared/types';
|
|
import { InlineMarkdownExtension } from '@blocksuite/std/inline';
|
|
import type { ExtensionType } from '@blocksuite/store';
|
|
|
|
// inline markdown match rules:
|
|
// covert: ***test*** + space
|
|
// covert: ***t est*** + space
|
|
// not convert: *** test*** + space
|
|
// not convert: ***test *** + space
|
|
// not convert: *** test *** + space
|
|
|
|
export const BoldItalicMarkdown = InlineMarkdownExtension<AffineTextAttributes>(
|
|
{
|
|
name: 'bolditalic',
|
|
pattern: /.*\*{3}([^\s*][^*]*[^\s*])\*{3}\s$|.*\*{3}([^\s*])\*{3}\s$/,
|
|
action: ({
|
|
inlineEditor,
|
|
prefixText,
|
|
inlineRange,
|
|
pattern,
|
|
undoManager,
|
|
}) => {
|
|
const match = prefixText.match(pattern);
|
|
if (!match) return;
|
|
|
|
const targetText = match[1] ?? match[2];
|
|
const annotatedText = match[0].slice(
|
|
-(targetText.length + 3 * 2 + 1),
|
|
-1
|
|
);
|
|
const startIndex = inlineRange.index - annotatedText.length - 1;
|
|
|
|
undoManager.stopCapturing();
|
|
|
|
inlineEditor.formatText(
|
|
{
|
|
index: startIndex,
|
|
length: annotatedText.length,
|
|
},
|
|
{
|
|
bold: true,
|
|
italic: true,
|
|
}
|
|
);
|
|
|
|
inlineEditor.deleteText({
|
|
index: inlineRange.index - 4,
|
|
length: 4,
|
|
});
|
|
inlineEditor.deleteText({
|
|
index: startIndex,
|
|
length: 3,
|
|
});
|
|
inlineEditor.setInlineRange({
|
|
index: startIndex + annotatedText.length - 6,
|
|
length: 0,
|
|
});
|
|
},
|
|
}
|
|
);
|
|
|
|
export const BoldMarkdown = InlineMarkdownExtension<AffineTextAttributes>({
|
|
name: 'bold',
|
|
pattern: /.*\*{2}([^\s][^*]*[^\s*])\*{2}\s$|.*\*{2}([^\s*])\*{2}\s$/,
|
|
action: ({ inlineEditor, prefixText, inlineRange, pattern, undoManager }) => {
|
|
const match = prefixText.match(pattern);
|
|
if (!match) return;
|
|
|
|
const targetText = match[1] ?? match[2];
|
|
const annotatedText = match[0].slice(-(targetText.length + 2 * 2 + 1), -1);
|
|
const startIndex = inlineRange.index - annotatedText.length - 1;
|
|
|
|
undoManager.stopCapturing();
|
|
|
|
inlineEditor.formatText(
|
|
{
|
|
index: startIndex,
|
|
length: annotatedText.length,
|
|
},
|
|
{
|
|
bold: true,
|
|
}
|
|
);
|
|
|
|
inlineEditor.deleteText({
|
|
index: inlineRange.index - 3,
|
|
length: 3,
|
|
});
|
|
inlineEditor.deleteText({
|
|
index: startIndex,
|
|
length: 2,
|
|
});
|
|
inlineEditor.setInlineRange({
|
|
index: startIndex + annotatedText.length - 4,
|
|
length: 0,
|
|
});
|
|
},
|
|
});
|
|
|
|
export const ItalicExtension = InlineMarkdownExtension<AffineTextAttributes>({
|
|
name: 'italic',
|
|
pattern: /.*\*{1}([^\s][^*]*[^\s*])\*{1}\s$|.*\*{1}([^\s*])\*{1}\s$/,
|
|
action: ({ inlineEditor, prefixText, inlineRange, pattern, undoManager }) => {
|
|
const match = prefixText.match(pattern);
|
|
if (!match) return;
|
|
|
|
const targetText = match[1] ?? match[2];
|
|
const annotatedText = match[0].slice(-(targetText.length + 1 * 2 + 1), -1);
|
|
const startIndex = inlineRange.index - annotatedText.length - 1;
|
|
|
|
undoManager.stopCapturing();
|
|
|
|
inlineEditor.formatText(
|
|
{
|
|
index: startIndex,
|
|
length: annotatedText.length,
|
|
},
|
|
{
|
|
italic: true,
|
|
}
|
|
);
|
|
|
|
inlineEditor.deleteText({
|
|
index: inlineRange.index - 2,
|
|
length: 2,
|
|
});
|
|
inlineEditor.deleteText({
|
|
index: startIndex,
|
|
length: 1,
|
|
});
|
|
inlineEditor.setInlineRange({
|
|
index: startIndex + annotatedText.length - 2,
|
|
length: 0,
|
|
});
|
|
},
|
|
});
|
|
|
|
export const StrikethroughExtension =
|
|
InlineMarkdownExtension<AffineTextAttributes>({
|
|
name: 'strikethrough',
|
|
pattern: /.*~{2}([^\s][^~]*[^\s])~{2}\s$|.*~{2}([^\s~])~{2}\s$/,
|
|
action: ({
|
|
inlineEditor,
|
|
prefixText,
|
|
inlineRange,
|
|
pattern,
|
|
undoManager,
|
|
}) => {
|
|
const match = prefixText.match(pattern);
|
|
if (!match) return;
|
|
|
|
const targetText = match[1] ?? match[2];
|
|
const annotatedText = match[0].slice(
|
|
-targetText.length - (2 * 2 + 1),
|
|
-1
|
|
);
|
|
const startIndex = inlineRange.index - annotatedText.length - 1;
|
|
|
|
undoManager.stopCapturing();
|
|
|
|
inlineEditor.formatText(
|
|
{
|
|
index: startIndex,
|
|
length: annotatedText.length,
|
|
},
|
|
{
|
|
strike: true,
|
|
}
|
|
);
|
|
|
|
inlineEditor.deleteText({
|
|
index: inlineRange.index - 3,
|
|
length: 3,
|
|
});
|
|
inlineEditor.deleteText({
|
|
index: startIndex,
|
|
length: 2,
|
|
});
|
|
|
|
inlineEditor.setInlineRange({
|
|
index: startIndex + annotatedText.length - 4,
|
|
length: 0,
|
|
});
|
|
},
|
|
});
|
|
|
|
export const UnderthroughExtension =
|
|
InlineMarkdownExtension<AffineTextAttributes>({
|
|
name: 'underthrough',
|
|
pattern: /.*~{1}([^\s][^~]*[^\s~])~{1}\s$|.*~{1}([^\s~])~{1}\s$/,
|
|
action: ({
|
|
inlineEditor,
|
|
prefixText,
|
|
inlineRange,
|
|
pattern,
|
|
undoManager,
|
|
}) => {
|
|
const match = prefixText.match(pattern);
|
|
if (!match) return;
|
|
|
|
const targetText = match[1] ?? match[2];
|
|
const annotatedText = match[0].slice(
|
|
-(targetText.length + 1 * 2 + 1),
|
|
-1
|
|
);
|
|
const startIndex = inlineRange.index - annotatedText.length - 1;
|
|
|
|
undoManager.stopCapturing();
|
|
|
|
inlineEditor.formatText(
|
|
{
|
|
index: startIndex,
|
|
length: annotatedText.length,
|
|
},
|
|
{
|
|
underline: true,
|
|
}
|
|
);
|
|
|
|
inlineEditor.deleteText({
|
|
index: inlineRange.index - 2,
|
|
length: 2,
|
|
});
|
|
inlineEditor.deleteText({
|
|
index: startIndex,
|
|
length: 1,
|
|
});
|
|
|
|
inlineEditor.setInlineRange({
|
|
index: startIndex + annotatedText.length - 2,
|
|
length: 0,
|
|
});
|
|
},
|
|
});
|
|
|
|
export const CodeExtension = InlineMarkdownExtension<AffineTextAttributes>({
|
|
name: 'code',
|
|
pattern: /.*`([^\s][^`]*[^\s])`\s$|.*`([^\s`])`\s$/,
|
|
action: ({ inlineEditor, prefixText, inlineRange, pattern, undoManager }) => {
|
|
const match = prefixText.match(pattern);
|
|
if (!match) return;
|
|
|
|
const targetText = match[1] ?? match[2];
|
|
const annotatedText = match[0].slice(-(targetText.length + 1 * 2 + 1), -1);
|
|
const startIndex = inlineRange.index - annotatedText.length - 1;
|
|
|
|
undoManager.stopCapturing();
|
|
|
|
inlineEditor.formatText(
|
|
{
|
|
index: startIndex,
|
|
length: annotatedText.length,
|
|
},
|
|
{
|
|
code: true,
|
|
}
|
|
);
|
|
|
|
inlineEditor.deleteText({
|
|
index: inlineRange.index - 2,
|
|
length: 2,
|
|
});
|
|
inlineEditor.deleteText({
|
|
index: startIndex,
|
|
length: 1,
|
|
});
|
|
|
|
inlineEditor.setInlineRange({
|
|
index: startIndex + annotatedText.length - 2,
|
|
length: 0,
|
|
});
|
|
},
|
|
});
|
|
|
|
export const MarkdownExtensions: ExtensionType[] = [
|
|
BoldItalicMarkdown,
|
|
BoldMarkdown,
|
|
ItalicExtension,
|
|
StrikethroughExtension,
|
|
UnderthroughExtension,
|
|
CodeExtension,
|
|
LatexExtension,
|
|
];
|