{log.map(({ text, html }, i) => {
return (
diff --git a/src/demo/components/FilterableEditor.test.tsx b/src/demo/components/FilterableEditor.test.tsx
index abbdc5b6..bcbf4677 100644
--- a/src/demo/components/FilterableEditor.test.tsx
+++ b/src/demo/components/FilterableEditor.test.tsx
@@ -1,4 +1,12 @@
-import { describe, it, beforeEach, afterEach, expect, vi } from "vitest"
+import {
+ describe,
+ it,
+ beforeEach,
+ afterEach,
+ expect,
+ vi,
+ MockInstance,
+} from "vitest"
import { render } from "@testing-library/react"
import {
EditorState,
@@ -13,12 +21,12 @@ import React from "react"
import * as editor from "../../lib/filters/editor"
describe("FilterableEditor", () => {
- let getItem: any
- let toggleInlineStyle: any
- let toggleBlockType: any
- let toggleLink: any
- let handleKeyCommand: any
- let insertAtomicBlock: any
+ let getItem: MockInstance
+ let toggleInlineStyle: MockInstance
+ let toggleBlockType: MockInstance
+ let toggleLink: MockInstance
+ let handleKeyCommand: MockInstance
+ let insertAtomicBlock: MockInstance
beforeEach(() => {
getItem = vi.spyOn(Storage.prototype, "getItem")
@@ -200,6 +208,22 @@ describe("FilterableEditor", () => {
expect(editor.filterEditorState).toHaveBeenCalled()
})
+
+ it("#filtered shouldFilterPaste to avoid multiline", () => {
+ vi.spyOn(editor, "condenseBlocks").mockImplementation((_, e) => e)
+
+ const state = EditorState.createEmpty()
+ const fakeState = {
+ getCurrentContent: () => state.getCurrentContent(),
+ getLastChangeType: () => "insert-fragment",
+ }
+ const ref = React.createRef()
+ render()
+
+ ref.current?.onChange(fakeState as EditorState)
+
+ expect(editor.condenseBlocks).toHaveBeenCalled()
+ })
})
it("toggleStyle", () => {
@@ -286,6 +310,7 @@ describe("FilterableEditor", () => {
describe("handleKeyCommand", () => {
it("draftjs internal, handled", () => {
handleKeyCommand.mockImplementation(
+ // @ts-expect-error - ignore
(editorState: EditorState) => editorState,
)
const ref = React.createRef()
@@ -297,7 +322,7 @@ describe("FilterableEditor", () => {
})
it("draftjs internal, not handled", () => {
- handleKeyCommand.mockImplementation(() => false)
+ handleKeyCommand.mockImplementation(() => null)
const ref = React.createRef()
render()
@@ -306,4 +331,20 @@ describe("FilterableEditor", () => {
handleKeyCommand.mockRestore()
})
})
+
+ describe("handleReturn", () => {
+ it("prevents multiline", () => {
+ const ref = React.createRef()
+ render()
+
+ expect(ref.current?.handleReturn()).toBe("handled")
+ })
+
+ it("allows multiline", () => {
+ const ref = React.createRef()
+ render()
+
+ expect(ref.current?.handleReturn()).toBe("not-handled")
+ })
+ })
})
diff --git a/src/demo/components/FilterableEditor.tsx b/src/demo/components/FilterableEditor.tsx
index 3ae79c01..24d94473 100644
--- a/src/demo/components/FilterableEditor.tsx
+++ b/src/demo/components/FilterableEditor.tsx
@@ -243,7 +243,7 @@ class FilterableEditor extends Component<
handleKeyCommand(command: string) {
const { editorState } = this.state
- let newState = RichUtils.handleKeyCommand(editorState, command)
+ const newState = RichUtils.handleKeyCommand(editorState, command)
if (newState) {
this.onChange(newState)
diff --git a/src/demo/components/SentryBoundary.test.tsx b/src/demo/components/SentryBoundary.test.tsx
index 65dd000c..d808a4d9 100644
--- a/src/demo/components/SentryBoundary.test.tsx
+++ b/src/demo/components/SentryBoundary.test.tsx
@@ -7,15 +7,21 @@ const ErrorComponent = ({ throwError }: { throwError: boolean }) => {
if (throwError) {
throw new Error("Test error")
}
- return Normal operation
+ return Test
}
describe("SentryBoundary", () => {
it("renders", () => {
- const { asFragment } = render(Test)
+ const { asFragment } = render(
+
+
+ ,
+ )
expect(asFragment()).toMatchInlineSnapshot(`
- Test
+
+ Test
+
`)
})
diff --git a/src/demo/utils/typography.css b/src/demo/utils/typography.css
index 4eaf3750..0318dc58 100644
--- a/src/demo/utils/typography.css
+++ b/src/demo/utils/typography.css
@@ -4,8 +4,16 @@ body {
}
code {
- font-family: Monaco, Bitstream Vera Sans Mono, Lucida Console, Terminal,
- Consolas, Liberation Mono, DejaVu Sans Mono, Courier New, monospace;
+ font-family:
+ Monaco,
+ Bitstream Vera Sans Mono,
+ Lucida Console,
+ Terminal,
+ Consolas,
+ Liberation Mono,
+ DejaVu Sans Mono,
+ Courier New,
+ monospace;
}
h1,
diff --git a/src/index.test.ts b/src/index.test.ts
index f48cc654..3dd9cd26 100644
--- a/src/index.test.ts
+++ b/src/index.test.ts
@@ -1,4 +1,5 @@
import { describe, it, beforeEach, expect, vi } from "vitest"
+
describe("demo", () => {
beforeEach(() => {
vi.resetModules()
diff --git a/src/lib/filters/entities.test.ts b/src/lib/filters/entities.test.ts
index 5e77a431..39008c20 100644
--- a/src/lib/filters/entities.test.ts
+++ b/src/lib/filters/entities.test.ts
@@ -178,7 +178,7 @@ describe("entities", () => {
],
} as unknown as RawDraftContentState)
- content = filterEntityRanges((content, entityKey, _) => {
+ content = filterEntityRanges((content, entityKey) => {
const entityType = content.getEntity(entityKey).getType()
return ["IMAGE", "LINK"].includes(entityType)
}, content)
@@ -552,7 +552,7 @@ describe("entities", () => {
],
content,
)
- const entities: { [type: string]: {} } = {}
+ const entities: { [type: string]: object } = {}
content.getBlockMap().forEach((block) => {
block!.findEntityRanges(
(char) => {
@@ -616,7 +616,7 @@ describe("entities", () => {
],
content,
)
- const entities: { [type: string]: {} } = {}
+ const entities: { [type: string]: object } = {}
content.getBlockMap().forEach((block) => {
block!.findEntityRanges(
(char) => {
@@ -668,7 +668,7 @@ describe("entities", () => {
],
content,
)
- const entities: { [type: string]: {} } = {}
+ const entities: { [type: string]: object } = {}
content.getBlockMap().forEach((block) => {
block!.findEntityRanges(
(char) => {
diff --git a/src/lib/filters/entities.ts b/src/lib/filters/entities.ts
index 845e0b63..3c9a277f 100644
--- a/src/lib/filters/entities.ts
+++ b/src/lib/filters/entities.ts
@@ -1,4 +1,9 @@
-import { CharacterMetadata, ContentBlock, ContentState } from "draft-js"
+import {
+ CharacterMetadata,
+ ContentBlock,
+ ContentState,
+ EntityInstance,
+} from "draft-js"
import { List } from "immutable"
import { ATOMIC, IMAGE } from "../constants"
@@ -176,7 +181,7 @@ export const shouldRemoveImageEntity = (
export const shouldKeepEntityByAttribute = (
entityTypes: readonly EntityRule[],
entityType: string,
- data: { [attr: string]: any },
+ data: { [attr: string]: unknown },
) => {
const config = entityTypes.find((t) => t.type === entityType)
// If no allowlist is defined, the filter keeps the entity.
@@ -184,25 +189,25 @@ export const shouldKeepEntityByAttribute = (
config && config.allowlist
? config.allowlist
: config && config.whitelist
- ? config.whitelist
- : {}
+ ? config.whitelist
+ : {}
const isValid = Object.keys(allowlist).every((attr) => {
const check = allowlist[attr]
if (typeof check === "boolean") {
- const hasData = data.hasOwnProperty(attr)
+ const hasData = Object.prototype.hasOwnProperty.call(data, attr)
return check ? hasData : !hasData
}
- return new RegExp(check).test(data[attr])
+ return new RegExp(check).test(data[attr] as string)
})
return isValid
}
-type EntityData = { [attr: string]: any }
+type EntityData = { [attr: string]: unknown }
/**
* Filters data on an entity to only retain what is allowed.
@@ -214,10 +219,10 @@ export const filterEntityData = (
content: ContentState,
) => {
let newContent = content
- const entities: { [type: string]: EntityData } = {}
+ const entities: { [type: string]: EntityInstance } = {}
newContent.getBlockMap().forEach((block) => {
- // @ts-ignore
+ // @ts-expect-error not providing callback on find
block!.findEntityRanges((char: CharacterMetadata) => {
const entityKey = char.getEntity()
if (entityKey) {
@@ -241,7 +246,7 @@ export const filterEntityData = (
const newData = allowlist.reduce((attrs, attr) => {
// We do not want to include undefined values if there is no data.
- if (data.hasOwnProperty(attr)) {
+ if (Object.prototype.hasOwnProperty.call(data, attr)) {
attrs[attr] = data[attr]
}
diff --git a/src/lib/filters/selection.test.ts b/src/lib/filters/selection.test.ts
index 469a54d1..199494cc 100644
--- a/src/lib/filters/selection.test.ts
+++ b/src/lib/filters/selection.test.ts
@@ -54,7 +54,7 @@ describe("selection", () => {
})
it("inserts a block if there is none left, with selection on it", () => {
- let editorState = EditorState.createWithContent(
+ const editorState = EditorState.createWithContent(
convertFromRaw({
entityMap: {},
blocks: [
diff --git a/src/lib/index.test.ts b/src/lib/index.test.ts
index e13a5972..8f29e64d 100644
--- a/src/lib/index.test.ts
+++ b/src/lib/index.test.ts
@@ -1,12 +1,10 @@
import { describe, it, expect } from "vitest"
import * as exports from "./index"
-const pkg = require("../../package.json")
-
/**
* Makes sure the API shape is validated against.
*/
-describe(pkg.name, () => {
+describe("draftjs-filters", () => {
it("has a stable API", () => {
expect(exports).toMatchInlineSnapshot(`
{
diff --git a/src/setupTests.js b/src/setupTests.js
index 30faad74..8989914e 100644
--- a/src/setupTests.js
+++ b/src/setupTests.js
@@ -1,8 +1,16 @@
import { expect, vi } from "vitest"
-import snapshotDiff from "snapshot-diff"
// https://github.com/jest-community/snapshot-diff
-expect.addSnapshotSerializer(snapshotDiff.getSnapshotDiffSerializer())
+const SNAPSHOT_TITLE = "Snapshot Diff:\n"
+
+expect.addSnapshotSerializer({
+ test(value) {
+ return typeof value === "string" && value.indexOf(SNAPSHOT_TITLE) === 0
+ },
+ print(value) {
+ return value
+ },
+})
vi.mock("draft-js", async () => {
const packages = {
diff --git a/src/tests/fixtures.ts b/src/tests/fixtures.ts
index 7bf6ebb7..e3f25e70 100644
--- a/src/tests/fixtures.ts
+++ b/src/tests/fixtures.ts
@@ -1,61 +1,111 @@
+import word2010_chrome62_win81 from "../../pasting/json/word2010-chrome62-win81.json"
+import word2010_firefox57_win81 from "../../pasting/json/word2010-firefox57-win81.json"
+import word2010_ie11_noequation_strippastedstyles_win81 from "../../pasting/json/word2010-ie11-noequation-strippastedstyles-win81.json"
+import word2010_ie11_noequation_win81 from "../../pasting/json/word2010-ie11-noequation-win81.json"
+import word_safari_ios11 from "../../pasting/json/word-safari-ios11.json"
+// import word2016_chrome63_macos1013 from "../../pasting/json/word2016-chrome63-macos1013.json"
+// import word2016_word2010doc_chrome63_win from "../../pasting/json/word2016-word2010doc-chrome63-win.json"
+// import word2016_word2010doc_edge16_win from "../../pasting/json/word2016-word2010doc-edge16-win.json"
+// import word2016_word2010doc_firefox57_win from "../../pasting/json/word2016-word2010doc-firefox57-win.json"
+// import word2016_word2010doc_ie11_win from "../../pasting/json/word2016-word2010doc-ie11-win.json"
+// import word2016_word2016macosdoc_chrome63_win from "../../pasting/json/word2016-word2016macosdoc-chrome63-win.json"
+// import word2016_word2016macosdoc_edge16_win from "../../pasting/json/word2016-word2016macosdoc-edge16-win.json"
+// import word2016_word2016macosdoc_firefox57_macos1013 from "../../pasting/json/word2016-word2016macosdoc-firefox57-macos1013.json"
+// import word2016_word2016macosdoc_firefox57_win from "../../pasting/json/word2016-word2016macosdoc-firefox57-win.json"
+// import word2016_word2016macosdoc_ie11_win from "../../pasting/json/word2016-word2016macosdoc-ie11-win.json"
+// import word2016_word2016macosdoc_safari11_macos1013 from "../../pasting/json/word2016-word2016macosdoc-safari11-macos1013.json"
+import googledocs_chrome62_macos1013 from "../../pasting/json/googledocs-chrome62-macos1013.json"
+import googledocs_chrome62_win81 from "../../pasting/json/googledocs-chrome62-win81.json"
+import googledocs_edge16_win10 from "../../pasting/json/googledocs-edge16-win10.json"
+import googledocs_firefox57_macos1013 from "../../pasting/json/googledocs-firefox57-macos1013.json"
+import googledocs_firefox57_win81 from "../../pasting/json/googledocs-firefox57-win81.json"
+import googledocs_ie11_strippastedstyles_win81 from "../../pasting/json/googledocs-ie11-strippastedstyles-win81.json"
+import googledocs_ie11_win81 from "../../pasting/json/googledocs-ie11-win81.json"
+import googledocs_safari_ios11 from "../../pasting/json/googledocs-safari-ios11.json"
+import googledocs_safari11_macos1013 from "../../pasting/json/googledocs-safari11-macos1013.json"
+import dropboxpaper_chrome62_macos1013 from "../../pasting/json/dropboxpaper-chrome62-macos1013.json"
+import dropboxpaper_chrome62_win81 from "../../pasting/json/dropboxpaper-chrome62-win81.json"
+import dropboxpaper_edge16_win10 from "../../pasting/json/dropboxpaper-edge16-win10.json"
+import dropboxpaper_firefox57_macos1013 from "../../pasting/json/dropboxpaper-firefox57-macos1013.json"
+import dropboxpaper_firefox57_win81 from "../../pasting/json/dropboxpaper-firefox57-win81.json"
+import dropboxpaper_ie11_unsupported_strippastedstyles_win81 from "../../pasting/json/dropboxpaper-ie11-unsupported-strippastedstyles-win81.json"
+import dropboxpaper_ie11_unsupported_win81 from "../../pasting/json/dropboxpaper-ie11-unsupported-win81.json"
+import dropboxpaper_safari_ios11 from "../../pasting/json/dropboxpaper-safari-ios11.json"
+import dropboxpaper_safari11_macos1013 from "../../pasting/json/dropboxpaper-safari11-macos1013.json"
+import applepages_chrome62_macos1013 from "../../pasting/json/applepages-chrome62-macos1013.json"
+import applepages_firefox57_macos1013 from "../../pasting/json/applepages-firefox57-macos1013.json"
+import applepages_safari_ios11 from "../../pasting/json/applepages-safari-ios11.json"
+import applepages_safari11_macos1013 from "../../pasting/json/applepages-safari11-macos1013.json"
+import wordonline_chrome62_macos1013 from "../../pasting/json/wordonline-chrome62-macos1013.json"
+import wordonline_chrome62_win81 from "../../pasting/json/wordonline-chrome62-win81.json"
+import wordonline_edge16_win10 from "../../pasting/json/wordonline-edge16-win10.json"
+import wordonline_firefox57_macos1013 from "../../pasting/json/wordonline-firefox57-macos1013.json"
+import wordonline_firefox57_win81 from "../../pasting/json/wordonline-firefox57-win81.json"
+import wordonline_safari11_macos1013 from "../../pasting/json/wordonline-safari11-macos1013.json"
+import draftjs_chrome64_macos1013 from "../../pasting/json/draftjs-chrome64-macos1013.json"
+
export const microsoftWord = {
- "word2010-chrome62-win81": require("../../pasting/json/word2010-chrome62-win81.json"),
- "word2010-firefox57-win81": require("../../pasting/json/word2010-firefox57-win81.json"),
- "word2010-ie11-noequation-strippastedstyles-win81": require("../../pasting/json/word2010-ie11-noequation-strippastedstyles-win81.json"),
- "word2010-ie11-noequation-win81": require("../../pasting/json/word2010-ie11-noequation-win81.json"),
- "word-safari-ios11": require("../../pasting/json/word-safari-ios11.json"), // "word2016-chrome63-macos1013": require("../../pasting/json/word2016-chrome63-macos1013.json"),
- // "word2016-word2010doc-chrome63-win": require("../../pasting/json/word2016-word2010doc-chrome63-win.json"),
- // "word2016-word2010doc-edge16-win": require("../../pasting/json/word2016-word2010doc-edge16-win.json"),
- // "word2016-word2010doc-firefox57-win": require("../../pasting/json/word2016-word2010doc-firefox57-win.json"),
- // "word2016-word2010doc-ie11-win": require("../../pasting/json/word2016-word2010doc-ie11-win.json"),
- // "word2016-word2016macosdoc-chrome63-win": require("../../pasting/json/word2016-word2016macosdoc-chrome63-win.json"),
- // "word2016-word2016macosdoc-edge16-win": require("../../pasting/json/word2016-word2016macosdoc-edge16-win.json"),
- // "word2016-word2016macosdoc-firefox57-macos1013": require("../../pasting/json/word2016-word2016macosdoc-firefox57-macos1013.json"),
- // "word2016-word2016macosdoc-firefox57-win": require("../../pasting/json/word2016-word2016macosdoc-firefox57-win.json"),
- // "word2016-word2016macosdoc-ie11-win": require("../../pasting/json/word2016-word2016macosdoc-ie11-win.json"),
- // "word2016-word2016macosdoc-safari11-macos1013": require("../../pasting/json/word2016-word2016macosdoc-safari11-macos1013.json"),
+ "word2010-chrome62-win81": word2010_chrome62_win81,
+ "word2010-firefox57-win81": word2010_firefox57_win81,
+ "word2010-ie11-noequation-strippastedstyles-win81":
+ word2010_ie11_noequation_strippastedstyles_win81,
+ "word2010-ie11-noequation-win81": word2010_ie11_noequation_win81,
+ "word-safari-ios11": word_safari_ios11,
+ // "word2016-chrome63-macos1013": word2016_chrome63_macos1013,
+ // "word2016-word2010doc-chrome63-win": word2016_word2010doc_chrome63_win,
+ // "word2016-word2010doc-edge16-win": word2016_word2010doc_edge16_win,
+ // "word2016-word2010doc-firefox57-win": word2016_word2010doc_firefox57_win,
+ // "word2016-word2010doc-ie11-win": word2016_word2010doc_ie11_win,
+ // "word2016-word2016macosdoc-chrome63-win": word2016_word2016macosdoc_chrome63_win,
+ // "word2016-word2016macosdoc-edge16-win": word2016_word2016macosdoc_edge16_win,
+ // "word2016-word2016macosdoc-firefox57-macos1013": word2016_word2016macosdoc_firefox57_macos1013,
+ // "word2016-word2016macosdoc-firefox57-win": word2016_word2016macosdoc_firefox57_win,
+ // "word2016-word2016macosdoc-ie11-win": word2016_word2016macosdoc_ie11_win,
+ // "word2016-word2016macosdoc-safari11-macos1013": word2016_word2016macosdoc_safari11_macos1013,
}
export const googleDocs = {
- "googledocs-chrome62-macos1013": require("../../pasting/json/googledocs-chrome62-macos1013.json"),
- "googledocs-chrome62-win81": require("../../pasting/json/googledocs-chrome62-win81.json"),
- "googledocs-edge16-win10": require("../../pasting/json/googledocs-edge16-win10.json"),
- "googledocs-firefox57-macos1013": require("../../pasting/json/googledocs-firefox57-macos1013.json"),
- "googledocs-firefox57-win81": require("../../pasting/json/googledocs-firefox57-win81.json"),
- "googledocs-ie11-strippastedstyles-win81": require("../../pasting/json/googledocs-ie11-strippastedstyles-win81.json"),
- "googledocs-ie11-win81": require("../../pasting/json/googledocs-ie11-win81.json"),
- "googledocs-safari-ios11": require("../../pasting/json/googledocs-safari-ios11.json"),
- "googledocs-safari11-macos1013": require("../../pasting/json/googledocs-safari11-macos1013.json"),
+ "googledocs-chrome62-macos1013": googledocs_chrome62_macos1013,
+ "googledocs-chrome62-win81": googledocs_chrome62_win81,
+ "googledocs-edge16-win10": googledocs_edge16_win10,
+ "googledocs-firefox57-macos1013": googledocs_firefox57_macos1013,
+ "googledocs-firefox57-win81": googledocs_firefox57_win81,
+ "googledocs-ie11-strippastedstyles-win81":
+ googledocs_ie11_strippastedstyles_win81,
+ "googledocs-ie11-win81": googledocs_ie11_win81,
+ "googledocs-safari-ios11": googledocs_safari_ios11,
+ "googledocs-safari11-macos1013": googledocs_safari11_macos1013,
}
export const dropboxPaper = {
- "dropboxpaper-chrome62-macos1013": require("../../pasting/json/dropboxpaper-chrome62-macos1013.json"),
- "dropboxpaper-chrome62-win81": require("../../pasting/json/dropboxpaper-chrome62-win81.json"),
- "dropboxpaper-edge16-win10": require("../../pasting/json/dropboxpaper-edge16-win10.json"),
- "dropboxpaper-firefox57-macos1013": require("../../pasting/json/dropboxpaper-firefox57-macos1013.json"),
- "dropboxpaper-firefox57-win81": require("../../pasting/json/dropboxpaper-firefox57-win81.json"),
- "dropboxpaper-ie11-unsupported-strippastedstyles-win81": require("../../pasting/json/dropboxpaper-ie11-unsupported-strippastedstyles-win81.json"),
- "dropboxpaper-ie11-unsupported-win81": require("../../pasting/json/dropboxpaper-ie11-unsupported-win81.json"),
- "dropboxpaper-safari-ios11": require("../../pasting/json/dropboxpaper-safari-ios11.json"),
- "dropboxpaper-safari11-macos1013": require("../../pasting/json/dropboxpaper-safari11-macos1013.json"),
+ "dropboxpaper-chrome62-macos1013": dropboxpaper_chrome62_macos1013,
+ "dropboxpaper-chrome62-win81": dropboxpaper_chrome62_win81,
+ "dropboxpaper-edge16-win10": dropboxpaper_edge16_win10,
+ "dropboxpaper-firefox57-macos1013": dropboxpaper_firefox57_macos1013,
+ "dropboxpaper-firefox57-win81": dropboxpaper_firefox57_win81,
+ "dropboxpaper-ie11-unsupported-strippastedstyles-win81":
+ dropboxpaper_ie11_unsupported_strippastedstyles_win81,
+ "dropboxpaper-ie11-unsupported-win81": dropboxpaper_ie11_unsupported_win81,
+ "dropboxpaper-safari-ios11": dropboxpaper_safari_ios11,
+ "dropboxpaper-safari11-macos1013": dropboxpaper_safari11_macos1013,
}
export const applePages = {
- "applepages-chrome62-macos1013": require("../../pasting/json/applepages-chrome62-macos1013.json"),
- "applepages-firefox57-macos1013": require("../../pasting/json/applepages-firefox57-macos1013.json"),
- "applepages-safari-ios11": require("../../pasting/json/applepages-safari-ios11.json"),
- "applepages-safari11-macos1013": require("../../pasting/json/applepages-safari11-macos1013.json"),
+ "applepages-chrome62-macos1013": applepages_chrome62_macos1013,
+ "applepages-firefox57-macos1013": applepages_firefox57_macos1013,
+ "applepages-safari-ios11": applepages_safari_ios11,
+ "applepages-safari11-macos1013": applepages_safari11_macos1013,
}
export const wordOnline = {
- "wordonline-chrome62-macos1013": require("../../pasting/json/wordonline-chrome62-macos1013.json"),
- "wordonline-chrome62-win81": require("../../pasting/json/wordonline-chrome62-win81.json"),
- "wordonline-edge16-win10": require("../../pasting/json/wordonline-edge16-win10.json"),
- "wordonline-firefox57-macos1013": require("../../pasting/json/wordonline-firefox57-macos1013.json"),
- "wordonline-firefox57-win81": require("../../pasting/json/wordonline-firefox57-win81.json"),
- "wordonline-safari11-macos1013": require("../../pasting/json/wordonline-safari11-macos1013.json"),
+ "wordonline-chrome62-macos1013": wordonline_chrome62_macos1013,
+ "wordonline-chrome62-win81": wordonline_chrome62_win81,
+ "wordonline-edge16-win10": wordonline_edge16_win10,
+ "wordonline-firefox57-macos1013": wordonline_firefox57_macos1013,
+ "wordonline-firefox57-win81": wordonline_firefox57_win81,
+ "wordonline-safari11-macos1013": wordonline_safari11_macos1013,
}
export const draftjs = {
- "draftjs-chrome64-macos1013": require("../../pasting/json/draftjs-chrome64-macos1013.json"),
+ "draftjs-chrome64-macos1013": draftjs_chrome64_macos1013,
}
diff --git a/src/tests/snapshot-diff.ts b/src/tests/snapshot-diff.ts
new file mode 100644
index 00000000..892e1d8f
--- /dev/null
+++ b/src/tests/snapshot-diff.ts
@@ -0,0 +1,50 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+import { diff } from "jest-diff"
+
+type Options = {
+ expand?: boolean
+ colors?: boolean
+ contextLines?: number
+ aAnnotation?: string
+ bAnnotation?: string
+}
+
+const defaultOptions = {
+ expand: false,
+ contextLines: -1, // Forces to use default from Jest
+ aAnnotation: "First value",
+ bAnnotation: "Second value",
+}
+
+const SNAPSHOT_TITLE = "Snapshot Diff:\n"
+
+const identity = (value: any) => value
+
+const snapshotDiff = (valueA: any, valueB: any, options?: Options): string => {
+ const mergedOptions = { ...defaultOptions, ...options }
+
+ const difference = diffStrings(valueA, valueB, mergedOptions) as string
+
+ return SNAPSHOT_TITLE + difference
+}
+
+// https://github.com/facebook/jest/tree/d81464622dc8857ba995ed04e121af2b3e8e33bc/packages/jest-diff#example-of-options-for-no-colors
+const noDiffColors = {
+ aColor: identity,
+ bColor: identity,
+ changeColor: identity,
+ commonColor: identity,
+ patchColor: identity,
+}
+
+function diffStrings(valueA: any, valueB: any, options: Options) {
+ return diff(valueA, valueB, {
+ expand: options.expand,
+ contextLines: options.contextLines,
+ aAnnotation: options.aAnnotation,
+ bAnnotation: options.bAnnotation,
+ ...noDiffColors,
+ })
+}
+
+export default snapshotDiff
diff --git a/src/tests/utils.ts b/src/tests/utils.ts
index 441b9138..0ab01c3d 100644
--- a/src/tests/utils.ts
+++ b/src/tests/utils.ts
@@ -5,10 +5,11 @@ import {
convertToRaw,
RawDraftContentState,
} from "draft-js"
-import snapshotDiff from "snapshot-diff"
import { filterEditorState } from "../lib/index"
+import snapshotDiff from "./snapshot-diff"
+
export const config = {
blocks: [
"header-two",
@@ -39,10 +40,10 @@ export const config = {
whitespacedCharacters: ["\t"],
} as const
-export const testFilteringDiff = (raw: RawDraftContentState) => {
+export const testFilteringDiff = (raw: object | RawDraftContentState) => {
const editorState = filterEditorState(
config,
- EditorState.createWithContent(convertFromRaw(raw)),
+ EditorState.createWithContent(convertFromRaw(raw as RawDraftContentState)),
)
// We snapshot the difference in the content before-after filtering, instead of the resulting content.
// This makes it easier to review what exactly is filtered out.
diff --git a/tsconfig.json b/tsconfig.json
index a7fc6fbf..01bf06bf 100644
--- a/tsconfig.json
+++ b/tsconfig.json
@@ -21,5 +21,6 @@
"noFallthroughCasesInSwitch": true
},
"include": ["src"],
- "references": [{ "path": "./tsconfig.node.json" }]
+ "references": [{ "path": "./tsconfig.node.json" }],
+ "exclude": ["docs"]
}
diff --git a/vite.config.ts b/vite.config.ts
index eb326648..5ab51477 100644
--- a/vite.config.ts
+++ b/vite.config.ts
@@ -9,5 +9,16 @@ export default defineConfig({
test: {
environment: "jsdom",
setupFiles: ["./src/setupTests.js"],
+ coverage: {
+ provider: "v8",
+ exclude: [
+ "./*.{js,mjs,ts}",
+ "build",
+ "dist",
+ "docs",
+ "pasting",
+ "src/vite-env.d.ts",
+ ],
+ },
},
})