Skip to content

fix: ellipsis rule in inline code #829

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
63 changes: 63 additions & 0 deletions src/extensions/base/BaseInputRules/BaseInputRules.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
import {EditorState, TextSelection} from 'prosemirror-state';
import {builders} from 'prosemirror-test-builder';
import {EditorView} from 'prosemirror-view';

import {ExtensionsManager} from '../../../core';
import {CodeSpecs, codeMarkName} from '../../markdown/Code/CodeSpecs';
import {BaseNode, BaseSchemaSpecs} from '../specs';

import {BaseInputRules} from './index';

const {schema, plugins} = new ExtensionsManager({
extensions: (builder) => builder.use(BaseSchemaSpecs, {}).use(CodeSpecs).use(BaseInputRules),
}).build();

const {doc, p, c} = builders<'doc' | 'p', 'c'>(schema, {
doc: {nodeType: BaseNode.Doc},
p: {nodeType: BaseNode.Paragraph},
c: {markType: codeMarkName},
});

describe('BaseInputRules ellipsis', () => {
it('does not replace triple dots inside inline code', () => {
const startDoc = doc(p(c('text<a>')));
const state = EditorState.create({
schema,
doc: startDoc,
selection: TextSelection.create(startDoc, startDoc.tag.a),
plugins,
});
const view = new EditorView(document.createElement('div'), {state});

const handled = view.someProp('handleTextInput', (f: any) =>
f(view, startDoc.tag.a, startDoc.tag.a, '...'),
);

if (!handled) {
view.dispatch(view.state.tr.insertText('...', startDoc.tag.a, startDoc.tag.a));
}

expect(view.state.doc).toMatchNode(doc(p(c('text...'))));
});

it('replaces triple dots in regular text', () => {
const startDoc = doc(p('text<a>'));
const state = EditorState.create({
schema,
doc: startDoc,
selection: TextSelection.create(startDoc, startDoc.tag.a),
plugins,
});
const view = new EditorView(document.createElement('div'), {state});

const handled = view.someProp('handleTextInput', (f: any) =>
f(view, startDoc.tag.a, startDoc.tag.a, '...'),
);

if (!handled) {
view.dispatch(view.state.tr.insertText('...', startDoc.tag.a, startDoc.tag.a));
}

expect(view.state.doc).toMatchNode(doc(p('text…')));
});
});
10 changes: 8 additions & 2 deletions src/extensions/base/BaseInputRules/index.ts
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This issue has been fixed in prosemirror-inputrules since v1.5.0
So you just need to update prosemirror-inputrules

Original file line number Diff line number Diff line change
@@ -1,7 +1,13 @@
import {ellipsis} from 'prosemirror-inputrules';
import {InputRule} from 'prosemirror-inputrules';

import type {ExtensionAuto} from '../../../core';
import {hasCodeMark} from '../../../utils/inputrules';

const ellipsisInputRule = new InputRule(/\.\.\.$/, (state, match, start, end) => {
if (hasCodeMark(state, match, start, end)) return null;
return state.tr.insertText('…', start, end);
});

export const BaseInputRules: ExtensionAuto = (builder) => {
builder.addInputRules(() => ({rules: [ellipsis]}));
builder.addInputRules(() => ({rules: [ellipsisInputRule]}));
};
Loading