Mirrors/notesnook
1
0
Fork 0
mirror of https://github.com/streetwriters/notesnook.git synced 2025-12-24 07:29:30 +01:00
Code Issues Packages Projects Releases Wiki Activity

editor: migrate tests to vitest

Browse Source
This commit is contained in:
Abdullah Atta
2023-03-06 14:29:12 +05:00
committed by Abdullah Atta
parent dfa718f8ea
commit 2f4a7f5410
9 changed files with 2064 additions and 12715 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14180
packages/editor/package-lock.json generated
View File

File diff suppressed because it is too large Load Diff

9
packages/editor/package.json
View File

@@ -6,6 +6,7 @@
"dependencies": { "dependencies": {
"@emotion/react": "^11.10.0", "@emotion/react": "^11.10.0",
"@notesnook/theme": "*", "@notesnook/theme": "*",
"@remirror/core-utils": "^2.0.10",
"@social-embed/lib": "^0.0.2-next.1", "@social-embed/lib": "^0.0.2-next.1",
"@theme-ui/components": "^0.14.7", "@theme-ui/components": "^0.14.7",
"@theme-ui/core": "^0.14.7", "@theme-ui/core": "^0.14.7",
@@ -32,6 +33,7 @@
"@tiptap/starter-kit": "^2.0.0-beta.218", "@tiptap/starter-kit": "^2.0.0-beta.218",
"detect-indent": "^7.0.0", "detect-indent": "^7.0.0",
"katex": "^0.16.2", "katex": "^0.16.2",
"nanoid": "^4.0.1",
"prism-themes": "^1.9.0", "prism-themes": "^1.9.0",
"prosemirror-codemark": "^0.4.1", "prosemirror-codemark": "^0.4.1",
"re-resizable": "^6.9.9", "re-resizable": "^6.9.9",
@@ -45,25 +47,20 @@
"zustand": "^3.7.2" "zustand": "^3.7.2"
}, },
"devDependencies": { "devDependencies": {
"@happy-dom/global-registrator": "^8.9.0",
"@mdi/js": "^6.9.96", "@mdi/js": "^6.9.96",
"@mdi/react": "^1.6.0", "@mdi/react": "^1.6.0",
"@swc/core": "^1.3.36",
"@types/katex": "^0.14.0", "@types/katex": "^0.14.0",
"@types/prismjs": "^1.26.0", "@types/prismjs": "^1.26.0",
"@types/react": "17.0.2", "@types/react": "17.0.2",
"@types/react-color": "^3.0.6", "@types/react-color": "^3.0.6",
"@types/react-dom": "17.0.2", "@types/react-dom": "17.0.2",
"@types/react-modal": "^3.13.1", "@types/react-modal": "^3.13.1",
"@types/tap": "^15.0.8",
"@types/tinycolor2": "^1.4.3", "@types/tinycolor2": "^1.4.3",
"expect": "^29.4.3",
"framer-motion": "^6.5.1", "framer-motion": "^6.5.1",
"isomorphic-fetch": "^3.0.0", "isomorphic-fetch": "^3.0.0",
"prosemirror-test-builder": "^1.1.0", "prosemirror-test-builder": "^1.1.0",
"tap": "^16.3.4",
"tsconfig-paths": "^3.14.2",
"typescript": "^4.8.2", "typescript": "^4.8.2",
"vitest": "^0.29.2",
"web-vitals": "^2.1.4", "web-vitals": "^2.1.4",
"zx": "^7.0.8" "zx": "^7.0.8"
}, },

13
packages/editor/src/extensions/key-map/key-map.ts
View File

@@ -21,6 +21,7 @@ import { Editor, Extension } from "@tiptap/core";
import { isInTable } from "@tiptap/pm/tables"; import { isInTable } from "@tiptap/pm/tables";
import { LIST_ITEM_NODE_TYPES, LIST_NODE_TYPES } from "../../utils/node-types"; import { LIST_ITEM_NODE_TYPES, LIST_NODE_TYPES } from "../../utils/node-types";
import { isListActive } from "../../utils/prosemirror"; import { isListActive } from "../../utils/prosemirror";
import { CodeBlock } from "../code-block";
export const KeyMap = Extension.create({ export const KeyMap = Extension.create({
name: "key-map", name: "key-map",
@@ -28,7 +29,13 @@ export const KeyMap = Extension.create({
addKeyboardShortcuts() { addKeyboardShortcuts() {
return { return {
Tab: ({ editor }) => { Tab: ({ editor }) => {
if (isListActive(editor) || isInTable(editor.state)) return false; if (
isListActive(editor) ||
isInTable(editor.state) ||
editor.isActive(CodeBlock.name)
)
return false;
return editor.commands.insertContent("\t"); return editor.commands.insertContent("\t");
}, },
"Shift-Tab": ({ editor }) => { "Shift-Tab": ({ editor }) => {
@@ -37,9 +44,9 @@ export const KeyMap = Extension.create({
}, },
Backspace: ({ editor }) => { Backspace: ({ editor }) => {
return joinUpWithLastListItem(editor); return joinUpWithLastListItem(editor);
} },
}; };
} },
}); });
/** /**

209
packages/editor/tap-snapshots/src/extensions/key-map/tests/key-map.test.ts.test.cjs → packages/editor/src/extensions/key-map/tests/__snapshots__/key-map.test.ts.snap
View File

@@ -1,22 +1,17 @@
/* IMPORTANT // Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
* This snapshot file is auto-generated, but designed for humans.
* It should be checked into source control and tracked carefully. exports[`join up with last list item in a flat list 1`] = `
* Re-generate by setting TAP_SNAPSHOT=1 and running tests. [
* Make sure to inspect the output below. Do not ignore changes! {
*/ "attrs": {
'use strict'
exports[`src/extensions/key-map/tests/key-map.test.ts TAP join up with last list item in a flat list > must match snapshot 1`] = `
Array [
Object {
"attrs": Null Object {
"listType": "", "listType": "",
}, },
"content": Array [ "content": [
Object { {
"content": Array [ "content": [
Object { {
"content": Array [ "content": [
Object { {
"text": "Hello", "text": "Hello",
"type": "text", "type": "text",
}, },
@@ -26,11 +21,11 @@ Array [
], ],
"type": "listItem", "type": "listItem",
}, },
Object { {
"content": Array [ "content": [
Object { {
"content": Array [ "content": [
Object { {
"text": "World", "text": "World",
"type": "text", "type": "text",
}, },
@@ -44,20 +39,20 @@ Array [
"type": "bulletList", "type": "bulletList",
}, },
] ]
` `;
exports[`src/extensions/key-map/tests/key-map.test.ts TAP join up with last list item in a nested list > must match snapshot 1`] = ` exports[`join up with last list item in a nested list 1`] = `
Array [ [
Object { {
"attrs": Null Object { "attrs": {
"listType": "", "listType": "",
}, },
"content": Array [ "content": [
Object { {
"content": Array [ "content": [
Object { {
"content": Array [ "content": [
Object { {
"text": "Hello", "text": "Hello",
"type": "text", "type": "text",
}, },
@@ -67,27 +62,27 @@ Array [
], ],
"type": "listItem", "type": "listItem",
}, },
Object { {
"content": Array [ "content": [
Object { {
"content": Array [ "content": [
Object { {
"text": "World", "text": "World",
"type": "text", "type": "text",
}, },
], ],
"type": "paragraph", "type": "paragraph",
}, },
Object { {
"attrs": Null Object { "attrs": {
"listType": "", "listType": "",
}, },
"content": Array [ "content": [
Object { {
"content": Array [ "content": [
Object { {
"content": Array [ "content": [
Object { {
"text": "Hello", "text": "Hello",
"type": "text", "type": "text",
}, },
@@ -97,27 +92,27 @@ Array [
], ],
"type": "listItem", "type": "listItem",
}, },
Object { {
"content": Array [ "content": [
Object { {
"content": Array [ "content": [
Object { {
"text": "World", "text": "World",
"type": "text", "type": "text",
}, },
], ],
"type": "paragraph", "type": "paragraph",
}, },
Object { {
"attrs": Null Object { "attrs": {
"listType": "", "listType": "",
}, },
"content": Array [ "content": [
Object { {
"content": Array [ "content": [
Object { {
"content": Array [ "content": [
Object { {
"text": "Hello", "text": "Hello",
"type": "text", "type": "text",
}, },
@@ -133,11 +128,11 @@ Array [
], ],
"type": "listItem", "type": "listItem",
}, },
Object { {
"content": Array [ "content": [
Object { {
"content": Array [ "content": [
Object { {
"text": "A very nested world", "text": "A very nested world",
"type": "text", "type": "text",
}, },
@@ -157,20 +152,20 @@ Array [
"type": "bulletList", "type": "bulletList",
}, },
] ]
` `;
exports[`src/extensions/key-map/tests/key-map.test.ts TAP join up with last list item in a nested list > must match snapshot 2`] = ` exports[`join up with last list item in a nested list 2`] = `
Array [ [
Object { {
"attrs": Null Object { "attrs": {
"listType": "", "listType": "",
}, },
"content": Array [ "content": [
Object { {
"content": Array [ "content": [
Object { {
"content": Array [ "content": [
Object { {
"text": "Hello", "text": "Hello",
"type": "text", "type": "text",
}, },
@@ -180,27 +175,27 @@ Array [
], ],
"type": "listItem", "type": "listItem",
}, },
Object { {
"content": Array [ "content": [
Object { {
"content": Array [ "content": [
Object { {
"text": "World", "text": "World",
"type": "text", "type": "text",
}, },
], ],
"type": "paragraph", "type": "paragraph",
}, },
Object { {
"attrs": Null Object { "attrs": {
"listType": "", "listType": "",
}, },
"content": Array [ "content": [
Object { {
"content": Array [ "content": [
Object { {
"content": Array [ "content": [
Object { {
"text": "Hello", "text": "Hello",
"type": "text", "type": "text",
}, },
@@ -210,27 +205,27 @@ Array [
], ],
"type": "listItem", "type": "listItem",
}, },
Object { {
"content": Array [ "content": [
Object { {
"content": Array [ "content": [
Object { {
"text": "World", "text": "World",
"type": "text", "type": "text",
}, },
], ],
"type": "paragraph", "type": "paragraph",
}, },
Object { {
"attrs": Null Object { "attrs": {
"listType": "", "listType": "",
}, },
"content": Array [ "content": [
Object { {
"content": Array [ "content": [
Object { {
"content": Array [ "content": [
Object { {
"text": "Hello", "text": "Hello",
"type": "text", "type": "text",
}, },
@@ -246,11 +241,11 @@ Array [
], ],
"type": "listItem", "type": "listItem",
}, },
Object { {
"content": Array [ "content": [
Object { {
"content": Array [ "content": [
Object { {
"text": "A very nested world", "text": "A very nested world",
"type": "text", "type": "text",
}, },
@@ -270,4 +265,4 @@ Array [
"type": "bulletList", "type": "bulletList",
}, },
] ]
` `;

15
packages/editor/src/extensions/key-map/tests/key-map.test.ts
View File

@@ -18,13 +18,12 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
*/ */
import { createEditor, h } from "@/test-utils"; import { createEditor, h } from "@/test-utils";
import tap from "tap"; import { test, expect } from "vitest";
import expect from "expect";
import BulletList from "../../bullet-list"; import BulletList from "../../bullet-list";
import { ListItem } from "../../list-item"; import { ListItem } from "../../list-item";
import { joinUpWithLastListItem } from "../key-map"; import { joinUpWithLastListItem } from "../key-map";
tap.test(`join up with last list item in a flat list`, async (t) => { test(`join up with last list item in a flat list`, async () => {
const { editor } = createEditor({ const { editor } = createEditor({
initialContent: h("div", [ initialContent: h("div", [
h("ul", [h("li", ["Hello"]), h("li", ["World"])]), h("ul", [h("li", ["Hello"]), h("li", ["World"])]),
@@ -40,10 +39,10 @@ tap.test(`join up with last list item in a flat list`, async (t) => {
joinUpWithLastListItem(editor); joinUpWithLastListItem(editor);
expect(editor.state.selection.$from.parent.textContent).toBe("World"); expect(editor.state.selection.$from.parent.textContent).toBe("World");
t.matchSnapshot(editor.state.doc.content.toJSON()); expect(editor.state.doc.content.toJSON()).toMatchSnapshot();
}); });
tap.test(`join up with last list item in a nested list`, async (t) => { test(`join up with last list item in a nested list`, async () => {
const { editor } = createEditor({ const { editor } = createEditor({
initialContent: h("div", [ initialContent: h("div", [
h("ul", [ h("ul", [
@@ -71,10 +70,10 @@ tap.test(`join up with last list item in a nested list`, async (t) => {
expect(editor.state.selection.$from.parent.textContent).toBe( expect(editor.state.selection.$from.parent.textContent).toBe(
"A very nested world" "A very nested world"
); );
t.matchSnapshot(editor.state.doc.content.toJSON()); expect(editor.state.doc.content.toJSON()).toMatchSnapshot();
}); });
tap.test(`join up with last list item in a nested list`, async (t) => { test(`join up with last list item in a nested list`, async () => {
const { editor } = createEditor({ const { editor } = createEditor({
initialContent: h("div", [ initialContent: h("div", [
h("ul", [ h("ul", [
@@ -102,5 +101,5 @@ tap.test(`join up with last list item in a nested list`, async (t) => {
expect(editor.state.selection.$from.parent.textContent).toBe( expect(editor.state.selection.$from.parent.textContent).toBe(
"A very nested world" "A very nested world"
); );
t.matchSnapshot(editor.state.doc.content.toJSON()); expect(editor.state.doc.content.toJSON()).toMatchSnapshot();
}); });

225
packages/editor/tap-snapshots/src/extensions/task-list/tests/task-list.test.ts.test.cjs → packages/editor/src/extensions/task-list/tests/__snapshots__/task-list.test.ts.snap
View File

@@ -1,25 +1,20 @@
/* IMPORTANT // Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
* This snapshot file is auto-generated, but designed for humans.
* It should be checked into source control and tracked carefully. exports[`delete checked items in a nested task list 1`] = `
* Re-generate by setting TAP_SNAPSHOT=1 and running tests. [
* Make sure to inspect the output below. Do not ignore changes! {
*/ "attrs": {
'use strict'
exports[`src/extensions/task-list/tests/task-list.test.ts TAP delete checked items in a nested task list > must match snapshot 1`] = `
Array [
Object {
"attrs": Null Object {
"title": null, "title": null,
}, },
"content": Array [ "content": [
Object { {
"attrs": Null Object { "attrs": {
"checked": false, "checked": false,
}, },
"content": Array [ "content": [
Object { {
"content": Array [ "content": [
Object { {
"text": "Task item 2", "text": "Task item 2",
"type": "text", "type": "text",
}, },
@@ -29,95 +24,95 @@ Array [
], ],
"type": "taskItem", "type": "taskItem",
}, },
Object { {
"attrs": Null Object { "attrs": {
"checked": false, "checked": false,
}, },
"content": Array [ "content": [
Object { {
"content": Array [ "content": [
Object { {
"text": "Task item 3", "text": "Task item 3",
"type": "text", "type": "text",
}, },
], ],
"type": "paragraph", "type": "paragraph",
}, },
Object { {
"content": Array [ "content": [
Object { {
"text": "Task item 4", "text": "Task item 4",
"type": "text", "type": "text",
}, },
], ],
"type": "paragraph", "type": "paragraph",
}, },
Object { {
"content": Array [ "content": [
Object { {
"text": "Task item 5", "text": "Task item 5",
"type": "text", "type": "text",
}, },
], ],
"type": "paragraph", "type": "paragraph",
}, },
Object { {
"content": Array [ "content": [
Object { {
"text": "Task item 6", "text": "Task item 6",
"type": "text", "type": "text",
}, },
], ],
"type": "paragraph", "type": "paragraph",
}, },
Object { {
"content": Array [ "content": [
Object { {
"text": "Task item 7", "text": "Task item 7",
"type": "text", "type": "text",
}, },
], ],
"type": "paragraph", "type": "paragraph",
}, },
Object { {
"content": Array [ "content": [
Object { {
"text": "Task item 8", "text": "Task item 8",
"type": "text", "type": "text",
}, },
], ],
"type": "paragraph", "type": "paragraph",
}, },
Object { {
"content": Array [ "content": [
Object { {
"text": "Task item 9", "text": "Task item 9",
"type": "text", "type": "text",
}, },
], ],
"type": "paragraph", "type": "paragraph",
}, },
Object { {
"content": Array [ "content": [
Object { {
"text": "Task item 10", "text": "Task item 10",
"type": "text", "type": "text",
}, },
], ],
"type": "paragraph", "type": "paragraph",
}, },
Object { {
"content": Array [ "content": [
Object { {
"text": "Task item 11", "text": "Task item 11",
"type": "text", "type": "text",
}, },
], ],
"type": "paragraph", "type": "paragraph",
}, },
Object { {
"content": Array [ "content": [
Object { {
"text": "Task item 12", "text": "Task item 12",
"type": "text", "type": "text",
}, },
@@ -131,23 +126,23 @@ Array [
"type": "taskList", "type": "taskList",
}, },
] ]
` `;
exports[`src/extensions/task-list/tests/task-list.test.ts TAP delete checked items in a task list > must match snapshot 1`] = ` exports[`delete checked items in a task list 1`] = `
Array [ [
Object { {
"attrs": Null Object { "attrs": {
"title": null, "title": null,
}, },
"content": Array [ "content": [
Object { {
"attrs": Null Object { "attrs": {
"checked": false, "checked": false,
}, },
"content": Array [ "content": [
Object { {
"content": Array [ "content": [
Object { {
"text": "Task item 2", "text": "Task item 2",
"type": "text", "type": "text",
}, },
@@ -161,23 +156,23 @@ Array [
"type": "taskList", "type": "taskList",
}, },
] ]
` `;
exports[`src/extensions/task-list/tests/task-list.test.ts TAP sort checked items to the bottom of the task list > must match snapshot 1`] = ` exports[`sort checked items to the bottom of the task list 1`] = `
Array [ [
Object { {
"attrs": Null Object { "attrs": {
"title": null, "title": null,
}, },
"content": Array [ "content": [
Object { {
"attrs": Null Object { "attrs": {
"checked": false, "checked": false,
}, },
"content": Array [ "content": [
Object { {
"content": Array [ "content": [
Object { {
"text": "Task item 2", "text": "Task item 2",
"type": "text", "type": "text",
}, },
@@ -187,95 +182,95 @@ Array [
], ],
"type": "taskItem", "type": "taskItem",
}, },
Object { {
"attrs": Null Object { "attrs": {
"checked": false, "checked": false,
}, },
"content": Array [ "content": [
Object { {
"content": Array [ "content": [
Object { {
"text": "Task item 3", "text": "Task item 3",
"type": "text", "type": "text",
}, },
], ],
"type": "paragraph", "type": "paragraph",
}, },
Object { {
"content": Array [ "content": [
Object { {
"text": "Task item 4", "text": "Task item 4",
"type": "text", "type": "text",
}, },
], ],
"type": "paragraph", "type": "paragraph",
}, },
Object { {
"content": Array [ "content": [
Object { {
"text": "Task item 5", "text": "Task item 5",
"type": "text", "type": "text",
}, },
], ],
"type": "paragraph", "type": "paragraph",
}, },
Object { {
"content": Array [ "content": [
Object { {
"text": "Task item 6", "text": "Task item 6",
"type": "text", "type": "text",
}, },
], ],
"type": "paragraph", "type": "paragraph",
}, },
Object { {
"content": Array [ "content": [
Object { {
"text": "Task item 7", "text": "Task item 7",
"type": "text", "type": "text",
}, },
], ],
"type": "paragraph", "type": "paragraph",
}, },
Object { {
"content": Array [ "content": [
Object { {
"text": "Task item 8", "text": "Task item 8",
"type": "text", "type": "text",
}, },
], ],
"type": "paragraph", "type": "paragraph",
}, },
Object { {
"content": Array [ "content": [
Object { {
"text": "Task item 9", "text": "Task item 9",
"type": "text", "type": "text",
}, },
], ],
"type": "paragraph", "type": "paragraph",
}, },
Object { {
"content": Array [ "content": [
Object { {
"text": "Task item 10", "text": "Task item 10",
"type": "text", "type": "text",
}, },
], ],
"type": "paragraph", "type": "paragraph",
}, },
Object { {
"content": Array [ "content": [
Object { {
"text": "Task item 11", "text": "Task item 11",
"type": "text", "type": "text",
}, },
], ],
"type": "paragraph", "type": "paragraph",
}, },
Object { {
"content": Array [ "content": [
Object { {
"text": "Task item 12", "text": "Task item 12",
"type": "text", "type": "text",
}, },
@@ -285,14 +280,14 @@ Array [
], ],
"type": "taskItem", "type": "taskItem",
}, },
Object { {
"attrs": Null Object { "attrs": {
"checked": true, "checked": true,
}, },
"content": Array [ "content": [
Object { {
"content": Array [ "content": [
Object { {
"text": "Task item 1", "text": "Task item 1",
"type": "text", "type": "text",
}, },
@@ -306,4 +301,4 @@ Array [
"type": "taskList", "type": "taskList",
}, },
] ]
` `;

95
packages/editor/src/extensions/task-list/tests/task-list.test.ts
View File

@@ -18,8 +18,7 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
*/ */
import { createEditor, h, ul, li } from "@/test-utils"; import { createEditor, h, ul, li } from "@/test-utils";
import tap from "tap"; import { test, expect } from "vitest";
import expect from "expect";
import { TaskListNode } from "../index"; import { TaskListNode } from "../index";
import { TaskItemNode } from "../../task-item"; import { TaskItemNode } from "../../task-item";
import { p, eq } from "prosemirror-test-builder"; import { p, eq } from "prosemirror-test-builder";
@@ -72,7 +71,7 @@ const NESTED_TASK_LIST = taskList(
) )
).outerHTML; ).outerHTML;
tap.test(`count items in a task list`, async () => { test(`count items in a task list`, async () => {
const { const {
builder: { taskItem, taskList } builder: { taskItem, taskList }
} = createEditor({ } = createEditor({
@@ -97,7 +96,7 @@ tap.test(`count items in a task list`, async () => {
expect(total).toBe(4); expect(total).toBe(4);
}); });
tap.test(`delete checked items in a task list`, async (t) => { test(`delete checked items in a task list`, async () => {
const { editor } = createEditor({ const { editor } = createEditor({
initialContent: taskList( initialContent: taskList(
taskItem("Task item 1", { checked: true }), taskItem("Task item 1", { checked: true }),
@@ -111,10 +110,10 @@ tap.test(`delete checked items in a task list`, async (t) => {
editor.commands.command(({ tr }) => !!deleteCheckedItems(tr, 0)); editor.commands.command(({ tr }) => !!deleteCheckedItems(tr, 0));
t.matchSnapshot(editor.state.doc.content.toJSON()); expect(editor.state.doc.content.toJSON()).toMatchSnapshot();
}); });
tap.test(`delete checked items in a nested task list`, async (t) => { test(`delete checked items in a nested task list`, async () => {
const { editor } = createEditor({ const { editor } = createEditor({
initialContent: NESTED_TASK_LIST, initialContent: NESTED_TASK_LIST,
extensions: { extensions: {
@@ -127,40 +126,37 @@ tap.test(`delete checked items in a nested task list`, async (t) => {
tr = deleteCheckedItems(tr, 0) || tr; tr = deleteCheckedItems(tr, 0) || tr;
editor.view.dispatch(tr); editor.view.dispatch(tr);
t.matchSnapshot(editor.state.doc.content.toJSON()); expect(editor.state.doc.content.toJSON()).toMatchSnapshot();
}); });
tap.test( test(`delete checked items in a task list with no checked items should do nothing`, async () => {
`delete checked items in a task list with no checked items should do nothing`, const { editor } = createEditor({
async () => { initialContent: taskList(
const { editor } = createEditor({ taskItem("Task item 1", { checked: false }),
initialContent: taskList( taskItem("Task item 2"),
taskItem("Task item 1", { checked: false }), taskItem(
taskItem("Task item 2"), "Task item 3",
taskItem( { checked: false },
"Task item 3", taskList(
{ checked: false }, taskItem("Task item 4", { checked: false }),
taskList( taskItem("Task item 5"),
taskItem("Task item 4", { checked: false }), taskItem("Task item 6", { checked: false })
taskItem("Task item 5"),
taskItem("Task item 6", { checked: false })
)
) )
).outerHTML, )
extensions: { ).outerHTML,
taskItem: TaskItemNode, extensions: {
taskList: TaskListNode taskItem: TaskItemNode,
} taskList: TaskListNode
}); }
});
const beforeDoc = editor.state.doc.copy(editor.state.doc.content); const beforeDoc = editor.state.doc.copy(editor.state.doc.content);
editor.commands.command(({ tr }) => !!deleteCheckedItems(tr, 0)); editor.commands.command(({ tr }) => !!deleteCheckedItems(tr, 0));
expect(eq(editor.state.doc, beforeDoc)).toBe(true); expect(eq(editor.state.doc, beforeDoc)).toBe(true);
} });
);
tap.test(`sort checked items to the bottom of the task list`, async (t) => { test(`sort checked items to the bottom of the task list`, async () => {
const { editor } = createEditor({ const { editor } = createEditor({
initialContent: NESTED_TASK_LIST, initialContent: NESTED_TASK_LIST,
extensions: { extensions: {
@@ -171,24 +167,21 @@ tap.test(`sort checked items to the bottom of the task list`, async (t) => {
editor.commands.command(({ tr }) => !!sortList(tr, 0)); editor.commands.command(({ tr }) => !!sortList(tr, 0));
t.matchSnapshot(editor.state.doc.content.toJSON()); expect(editor.state.doc.content.toJSON()).toMatchSnapshot();
}); });
tap.test( test(`sorting a task list with no checked items should do nothing`, async () => {
`sorting a task list with no checked items should do nothing`, const { editor } = createEditor({
async () => { initialContent: taskList(taskItem("Task item 1"), taskItem("Task item 2"))
const { editor } = createEditor({ .outerHTML,
initialContent: taskList(taskItem("Task item 1"), taskItem("Task item 2")) extensions: {
.outerHTML, taskItem: TaskItemNode,
extensions: { taskList: TaskListNode
taskItem: TaskItemNode, }
taskList: TaskListNode });
}
});
const beforeDoc = editor.state.doc.copy(editor.state.doc.content); const beforeDoc = editor.state.doc.copy(editor.state.doc.content);
editor.commands.command(({ tr }) => !!sortList(tr, 0)); editor.commands.command(({ tr }) => !!sortList(tr, 0));
expect(eq(editor.state.doc, beforeDoc)).toBe(true); expect(eq(editor.state.doc, beforeDoc)).toBe(true);
} });
);

19
packages/editor/test-utils/index.ts
View File

@@ -17,7 +17,6 @@ You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>. along with this program. If not, see <http://www.gnu.org/licenses/>.
*/ */
import "./tests.setup";
import { Editor, AnyExtension, Extensions } from "@tiptap/core"; import { Editor, AnyExtension, Extensions } from "@tiptap/core";
import StarterKit from "@tiptap/starter-kit"; import StarterKit from "@tiptap/starter-kit";
import { builders, NodeBuilder } from "prosemirror-test-builder"; import { builders, NodeBuilder } from "prosemirror-test-builder";
@@ -28,6 +27,7 @@ type Builder<TNodes extends string> = {
} & Record<TNodes, NodeBuilder>; } & Record<TNodes, NodeBuilder>;
type EditorOptions<TNodes extends string> = { type EditorOptions<TNodes extends string> = {
element?: HTMLElement;
extensions: Record<TNodes, AnyExtension>; extensions: Record<TNodes, AnyExtension>;
initialContent?: string; initialContent?: string;
}; };
@@ -35,13 +35,18 @@ type EditorOptions<TNodes extends string> = {
export function createEditor<TNodes extends string>( export function createEditor<TNodes extends string>(
options: EditorOptions<TNodes> options: EditorOptions<TNodes>
) { ) {
const { extensions, initialContent } = options; const { extensions, initialContent, element } = options;
const editor = new Editor({ const editor = new Editor({
element,
content: initialContent,
parseOptions: { preserveWhitespace: "full" },
extensions: [ extensions: [
StarterKit.configure({ StarterKit.configure({
bulletList: false, bulletList: false,
listItem: false, listItem: false,
orderedList: false orderedList: false,
codeBlock: false,
code: false
}), }),
...(Object.values(extensions) as Extensions) ...(Object.values(extensions) as Extensions)
] ]
@@ -49,14 +54,6 @@ export function createEditor<TNodes extends string>(
const builder = builders(editor.schema) as unknown as Builder<TNodes>; const builder = builders(editor.schema) as unknown as Builder<TNodes>;
if (initialContent) {
editor.commands.setContent(initialContent, true, {
preserveWhitespace: "full"
});
return { editor, builder };
}
return { editor, builder }; return { editor, builder };
} }

14
packages/editor/test-utils/tests.setup.ts → packages/editor/vitest.config.ts
View File

@@ -17,6 +17,16 @@ You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>. along with this program. If not, see <http://www.gnu.org/licenses/>.
*/ */
import { GlobalRegistrator } from "@happy-dom/global-registrator"; import { defineConfig } from "vitest/config";
GlobalRegistrator.register(); export default defineConfig({
test: {
alias: {
"@/": "./"
},
environment: "happy-dom",
typecheck: {
tsconfig: "./tsconfig.tests.json"
}
}
});