SPB Git

Repository Public

editor.test.ts 16.7 KB 287 lines typescript

1// Modèle de l'éditeur : commandes, sérialisation, sélection ⇄ chemin, historique. La sélection s'écrit « [ … ] » (ou « | ») dans le HTML.2import assert from "node:assert/strict"3import { test } from "node:test"4import { JSDOM } from "jsdom"5import {6  History, assistScope, backspaceHandled, clearFormatting, deleteBefore, enterHandled, formatState, indent, insertHtml, insertImage, insertText, normalize, outdent, pathToRange, plainText, run, selectionToPath, serialize,7  setAlign, setBlock, setLink, snapshot, toggleList, toggleMark, toggleQuote, unlink, type Command,8} from "./editor"910const dom = new JSDOM("<!doctype html><body></body>")11const doc = dom.window.document1213/** Monte un document ; « [ » et « ] » (ou un seul « | ») y marquent la sélection. */14function mount(html: string): { root: HTMLElement; range: Range } {15  const root = doc.createElement("div")16  root.innerHTML = html17  doc.body.replaceChildren(root)18  const range = doc.createRange()19  const find = (ch: string): { node: Text; offset: number } | null => {20    const w = doc.createTreeWalker(root, 4)21    for (let n = w.nextNode(); n; n = w.nextNode()) {22      const t = n as Text23      const i = t.data.indexOf(ch)24      if (i >= 0) {25        t.data = t.data.slice(0, i) + t.data.slice(i + 1)26        return { node: t, offset: i }27      }28    }29    return null30  }31  const caret = find("|")32  if (caret) {33    range.setStart(caret.node, caret.offset)34    range.collapse(true)35  } else {36    const a = find("[")37    const b = find("]")38    assert.ok(a && b, "sélection manquante dans le HTML d'essai")39    range.setStart(a.node, a.offset)40    range.setEnd(b.node, b.offset)41  }42  return { root, range }43}44/** HTML résultant, la sélection réinscrite avec les mêmes signes. */45function show(root: HTMLElement, range: Range): string {46  const r = range.cloneRange()47  const end = doc.createTextNode(range.collapsed ? "|" : "]")48  const e = r.cloneRange()49  e.collapse(false)50  e.insertNode(end)51  if (!range.collapsed) {52    const s = r.cloneRange()53    s.collapse(true)54    s.insertNode(doc.createTextNode("["))55  }56  root.normalize()57  return root.innerHTML.replace(/​/g, "·")58}59const apply = (html: string, command: Command): string => {60  const { root, range } = mount(html)61  return show(root, run(root, range, command))62}6364test("gras : pose sur une sélection partielle, retrait, fusion des voisins", () => {65  assert.equal(apply("<div>un [deux] trois</div>", toggleMark("bold")), "<div>un <strong>[deux]</strong> trois</div>")66  assert.equal(apply("<div>un <strong>[deux]</strong> trois</div>", toggleMark("bold")), "<div>un [deux] trois</div>")67  assert.equal(apply("<div><strong>un [deux] trois</strong></div>", toggleMark("bold")), "<div><strong>un </strong>[deux]<strong> trois</strong></div>")68  // sélection à cheval : tout devient gras, en un seul élément69  assert.equal(apply("<div><strong>un [deux</strong> trois] quatre</div>", toggleMark("bold")), "<div><strong>un [deux trois]</strong> quatre</div>")70  // <b> hérité d'un collage = <strong>71  assert.equal(apply("<div><b>[gras]</b></div>", toggleMark("bold")), "<div>[gras]</div>")72})7374test("marques combinées et sur plusieurs blocs", () => {75  assert.equal(apply("<div><em>un [deux] trois</em></div>", toggleMark("bold")), "<div><em>un <strong>[deux]</strong> trois</em></div>")76  assert.equal(apply("<div>a[b</div><div>c]d</div>", toggleMark("italic")), "<div>a<em>[b</em></div><div><em>c]</em>d</div>")77  assert.equal(apply("<div>[x]</div>", toggleMark("strike")), "<div><s>[x]</s></div>")78  assert.equal(apply("<div>[x]</div>", toggleMark("underline")), "<div><u>[x]</u></div>")79  assert.equal(apply("<div>appelez [npm run build] ici</div>", toggleMark("code")), "<div>appelez <code>[npm run build]</code> ici</div>")80})8182test("sélection vide : un porteur de largeur nulle reçoit la marque, puis la perd", () => {83  assert.equal(apply("<div>mot |</div>", toggleMark("bold")), "<div>mot <strong>·|</strong></div>")84  assert.equal(apply("<div><strong>gras|</strong></div>", toggleMark("bold")), "<div><strong>gras</strong>·|</div>")85  // le porteur ne part jamais : la sérialisation l'efface86  const { root, range } = mount("<div>mot |</div>")87  run(root, range, toggleMark("bold"))88  assert.equal(serialize(root), "<div>mot </div>")89})9091test("titres : deux niveaux, bascule vers paragraphe", () => {92  assert.equal(apply("<div>Ti|tre</div>", setBlock("h1")), "<h1>Ti|tre</h1>")93  assert.equal(apply("<h1>Ti|tre</h1>", setBlock("h2")), "<h2>Ti|tre</h2>")94  assert.equal(apply("<h2>Ti|tre</h2>", setBlock("h2")), "<div>Ti|tre</div>")95  assert.equal(apply("<div>[a</div><div>b]</div>", setBlock("h2")), "<h2>[a</h2><h2>b]</h2>")96})9798test("listes : création, changement de type, sortie, retrait et ajout de niveau", () => {99  assert.equal(apply("<div>[a</div><div>b]</div><div>c</div>", toggleList("ul")), "<ul><li>[a</li><li>b]</li></ul><div>c</div>")100  assert.equal(apply("<ul><li>[a</li><li>b]</li></ul>", toggleList("ol")), "<ol><li>[a</li><li>b]</li></ol>")101  assert.equal(apply("<ul><li>a</li><li>b|</li><li>c</li></ul>", toggleList("ul")), "<ul><li>a</li></ul><div>b|</div><ul><li>c</li></ul>")102  assert.equal(apply("<ul><li>a</li><li>b|</li></ul>", indent), "<ul><li>a<ul><li>b|</li></ul></li></ul>")103  assert.equal(apply("<ul><li>a<ul><li>b|</li><li>c</li></ul></li></ul>", outdent), "<ul><li>a</li><li>b|<ul><li>c</li></ul></li></ul>")104  // le premier élément ne peut pas être décalé : rien ne change105  assert.equal(apply("<ul><li>a|</li></ul>", indent), "<ul><li>a|</li></ul>")106  // une ligne ajoutée à une liste voisine la rejoint107  assert.equal(apply("<ul><li>a</li></ul><div>b|</div>", toggleList("ul")), "<ul><li>a</li><li>b|</li></ul>")108})109110test("citation : pose sur plusieurs blocs, retrait d'une ligne au milieu", () => {111  const q = 'style="margin: 0 0 0 0.8ex; border-left: 2px solid #c4c0b4; padding-left: 1ex"'112  assert.equal(apply("<div>[a</div><div>b]</div><div>c</div>", toggleQuote), `<blockquote ${q}><div>[a</div><div>b]</div></blockquote><div>c</div>`)113  assert.equal(apply("<blockquote><div>a</div><div>b|</div><div>c</div></blockquote>", toggleQuote), "<blockquote><div>a</div></blockquote><div>b|</div><blockquote><div>c</div></blockquote>")114})115116test("liens : pose, modification, retrait", () => {117  assert.equal(apply("<div>voir [le site] ici</div>", setLink("https://example.org/")), '<div>voir <a href="https://example.org/">[le site]</a> ici</div>')118  assert.equal(apply("<div>voir |</div>", setLink("https://example.org/", "le site")), '<div>voir <a href="https://example.org/">le site</a>|</div>')119  assert.equal(apply('<div><a href="https://a.example/">li|en</a></div>', setLink("https://b.example/")), '<div><a href="https://b.example/">lien</a>|</div>')120  assert.equal(apply('<div><a href="https://a.example/">li|en</a> x</div>', unlink), "<div>li|en x</div>")121  assert.equal(apply('<div><a href="https://a.example/">un [deux] trois</a></div>', unlink), '<div><a href="https://a.example/">un </a>[deux]<a href="https://a.example/"> trois</a></div>')122})123124test("effacer la mise en forme : marques, polices, titres, alignement — liens et listes gardés", () => {125  assert.equal(apply('<h1 style="text-align: center">[<strong>a</strong> <font color="red"><em>b</em></font> <a href="https://x.example/">c</a>]</h1>', clearFormatting), '<div>[a b <a href="https://x.example/">c]</a></div>')126  assert.equal(apply("<div>x|</div>", setAlign("center")), '<div style="text-align: center;">x|</div>')127  assert.equal(apply('<div style="text-align: center;">x|</div>', setAlign("left")), "<div>x|</div>")128})129130test("insertion : texte sur plusieurs lignes, fragment structuré, dans un élément de liste, image", () => {131  assert.equal(apply("<div>a|b</div>", insertText("X")), "<div>aX|b</div>")132  assert.equal(apply("<div>a[zz]b</div>", insertText("un\ndeux")), "<div>a</div><div>un</div><div>deux|</div><div>b</div>")133  assert.equal(apply("<div>|<br></div>", insertHtml("<div>Bonjour,</div><ul><li>un</li><li>deux</li></ul>")), "<div>Bonjour,</div><ul><li>un</li><li>deux|</li></ul>")134  assert.equal(apply("<ul><li>a|</li></ul>", insertHtml("<div>x</div><div>y</div>")), "<ul><li>ax<br>y|</li></ul>")135  assert.equal(apply("<div>a|</div>", insertHtml("<strong>gras</strong> et normal")), "<div>a<strong>gras</strong> et normal|</div>")136  // un collage apporte ses propres balises : elles rejoignent la forme canonique137  assert.equal(apply("<div>a|</div>", insertHtml("<b>gras</b> <i>ital</i> <strike>barré</strike>")), "<div>a<strong>gras</strong> <em>ital</em> <s>barré</s>|</div>")138  assert.equal(apply("<div>a|</div>", insertImage({ cid: "c1@spmail", url: "blob:x", alt: "Logo", width: 320 })), '<div>a<img data-cid="c1@spmail" src="blob:x" alt="Logo" width="320">|</div>')139  // suppression à cheval sur deux blocs : ils sont réunis140  assert.equal(apply("<div>ab[cd</div><div>ef]gh</div>", insertText("-")), "<div>ab-|gh</div>")141  assert.equal(apply("<div>bonjour ;merci|</div>", deleteBefore(6)), "<div>bonjour |</div>")142})143144test("Entrée et Retour arrière : sortie d'une liste, d'une citation, d'un titre", () => {145  const go = (html: string, fn: (c: Parameters<Command>[0]) => boolean) => {146    const { root, range } = mount(html)147    let handled = false148    const r = run(root, range, (c) => void (handled = fn(c)))149    return [handled, show(root, r)] as const150  }151  assert.deepEqual(go("<ul><li>a</li><li>|<br></li></ul>", enterHandled), [true, "<ul><li>a</li></ul><div>|<br></div>"])152  assert.deepEqual(go("<blockquote><div>a</div><div>|<br></div><div>b</div></blockquote>", enterHandled), [true, "<blockquote><div>a</div></blockquote><div>|<br></div><blockquote><div>b</div></blockquote>"])153  assert.deepEqual(go("<div>a|</div>", enterHandled), [false, "<div>a|</div>"])154  assert.deepEqual(go("<ul><li>|a</li></ul>", backspaceHandled), [true, "<div>|a</div>"])155  assert.deepEqual(go("<h1>|Titre</h1>", backspaceHandled), [true, "<div>|Titre</div>"])156  assert.deepEqual(go("<div>a|b</div>", backspaceHandled), [false, "<div>a|b</div>"])157})158159test("normalisation : texte hors bloc enveloppé, document jamais vide, « tout sélectionner » sans paragraphe en trop", () => {160  const root = doc.createElement("div")161  root.innerHTML = "bonjour <b>vous</b><br>suite<div>bloc</div>"162  normalize(root)163  assert.equal(root.innerHTML, "<div>bonjour <strong>vous</strong></div><div>suite</div><div>bloc</div>")164  root.innerHTML = ""165  normalize(root)166  assert.equal(root.innerHTML, "<div><br></div>")167  // sélection au niveau de la racine (Ctrl+A)168  root.innerHTML = "<div>a</div><div>b</div>"169  doc.body.replaceChildren(root)170  const all = doc.createRange()171  all.selectNodeContents(root)172  run(root, all, toggleMark("bold"))173  assert.equal(root.innerHTML, "<div><strong>a</strong></div><div><strong>b</strong></div>")174})175176test("état de la sélection pour la barre de mise en forme", () => {177  const st = (html: string) => {178    const { root, range } = mount(html)179    return formatState(root, range)180  }181  assert.equal(st("<div><strong>a|b</strong></div>").bold, true)182  assert.equal(st("<div><strong>[a</strong>b]</div>").bold, false)183  assert.equal(st("<div><strong><em>[ab]</em></strong></div>").italic, true)184  assert.deepEqual([st("<ol><li>a|</li></ol>").list, st("<ul><li>a|</li></ul>").list, st("<div>a|</div>").list], ["ol", "ul", null])185  assert.equal(st("<blockquote><div>a|</div></blockquote>").quote, true)186  assert.equal(st("<h2>a|</h2>").block, "h2")187  assert.equal(st('<div><a href="https://x.example/">a|b</a></div>').link, "https://x.example/")188  assert.equal(st('<div style="text-align: right">a|</div>').align, "right")189})190191test("sérialisation : images ramenées à cid:, image sans identifiant retirée, texte brut", () => {192  const root = doc.createElement("div")193  root.innerHTML = '<div>a​<strong>​</strong><img data-cid="c1@spmail" src="blob:http://x/1" alt="Logo" width="320"><img src="https://evil.example/t.gif"></div><div><br></div>'194  assert.equal(serialize(root), '<div>a<img src="cid:c1@spmail" alt="Logo" width="320"></div><div><br></div>')195  root.innerHTML = "<div><br></div>"196  assert.equal(serialize(root), "")197  root.innerHTML = "<div>un</div><ul><li>deux</li></ul><div>trois<br>quatre</div>"198  assert.equal(plainText(root), "un\ndeux\ntrois\nquatre")199})200201test("sélection ⇄ chemin : stable malgré le découpage des nœuds de texte", () => {202  const { root, range } = mount("<div>abc <strong>d[ef</strong> gh]i</div>")203  const path = selectionToPath(root, range)204  // même document, texte découpé autrement205  const text = root.firstChild!.firstChild as Text206  text.splitText(2)207  ;(root.querySelector("strong")!.firstChild as Text).splitText(1)208  const again = selectionToPath(root, range)209  assert.deepEqual(again, path)210  const fresh = doc.createElement("div")211  fresh.innerHTML = root.innerHTML212  doc.body.replaceChildren(fresh)213  const r = pathToRange(fresh, path)214  assert.equal(r.toString(), "ef gh")215})216217test("historique : la frappe continue est une étape, chaque commande une autre ; annuler / rétablir", () => {218  const h = new History(50, 1000)219  const snap = (html: string) => ({ html, sel: null })220  h.reset(snap("<div><br></div>"))221  h.record(snap("<div>a</div>"), "typing", 0)222  h.record(snap("<div>ab</div>"), "typing", 300)223  h.record(snap("<div>abc</div>"), "typing", 600)224  h.record(snap("<div><strong>abc</strong></div>"), "command", 700)225  h.record(snap("<div><strong>abc</strong>d</div>"), "typing", 800)226  // pause : nouvelle étape de frappe227  h.record(snap("<div><strong>abc</strong>de</div>"), "typing", 5000)228  assert.equal(h.undo()?.html, "<div><strong>abc</strong>d</div>")229  assert.equal(h.undo()?.html, "<div><strong>abc</strong></div>")230  assert.equal(h.undo()?.html, "<div>abc</div>")231  assert.equal(h.undo()?.html, "<div><br></div>")232  assert.equal(h.undo(), null)233  assert.equal(h.redo()?.html, "<div>abc</div>")234  // une modification après un retour en arrière coupe la branche « rétablir »235  h.record(snap("<div>abc!</div>"), "typing", 9000)236  assert.equal(h.canRedo, false)237  assert.equal(h.undo()?.html, "<div>abc</div>")238  // la saisie dans un champ annexe (texte de remplacement) ne se fond pas dans la frappe qui suit239  const g = new History(50, 1000)240  g.reset(snap("a"))241  g.record(snap("b"), "attr", 0)242  g.record(snap("c"), "attr", 100)243  g.record(snap("d"), "typing", 200)244  assert.equal(g.undo()?.html, "c")245  assert.equal(g.undo()?.html, "a")246  // instantané vivant247  const { root, range } = mount("<div>a[b]c</div>")248  const s = snapshot(root, range)249  assert.equal(s.html, "<div>abc</div>")250  assert.deepEqual(s.sel, { start: { path: [0, 0], offset: 1 }, end: { path: [0, 0], offset: 2 } })251})252253// ---------------------------------------------------------------- portée de l'assistant d'écriture254const REPLY = '<div>Bonjour Camille,</div><div>Voici ma [réponse].</div><div><br></div><div class="spm-signature">Simon</div><div><br></div><div class="spm-quote-intro">Le 3 nov., Camille a écrit :</div><blockquote class="spm-quote" type="cite"><div>Texte cité</div></blockquote>'255test("assistant : la sélection rédigée est la portée ; la remplacer ne touche ni la signature ni la citation", () => {256  const { root, range } = mount(REPLY)257  const scope = assistScope(root, range)258  assert.equal(scope.kind, "selection")259  assert.equal(scope.text, "réponse")260  run(root, scope.range!, insertText("<b>proposition</b>"))261  assert.match(root.innerHTML, /Voici ma &lt;b&gt;proposition&lt;\/b&gt;\./)262  assert.equal(root.querySelector("b"), null)263  assert.equal(root.querySelector(".spm-signature")?.textContent, "Simon")264  assert.equal(root.querySelector("blockquote")?.textContent, "Texte cité")265})266test("assistant : sans sélection, tout le texte rédigé — jamais la signature ni la citation", () => {267  const { root, range } = mount(REPLY.replace("[", "|").replace("]", ""))268  const scope = assistScope(root, range)269  assert.equal(scope.kind, "authored")270  assert.equal(scope.text, "Bonjour Camille,\nVoici ma réponse.")271  run(root, scope.range!, insertText("Ligne une\nLigne <deux>"))272  assert.equal(plainText(root).split("\n").slice(0, 2).join("|"), "Ligne une|Ligne <deux>")273  assert.equal(root.querySelectorAll(".spm-signature").length, 1)274  assert.equal(root.querySelector(".spm-quote-intro")?.textContent, "Le 3 nov., Camille a écrit :")275  assert.equal(root.querySelector("blockquote")?.textContent, "Texte cité")276  assert.ok(!/Bonjour Camille/.test(root.textContent ?? ""))277})278test("assistant : une sélection qui mord sur la citation est ignorée ; rien de rédigé = portée vide", () => {279  const { root, range } = mount('<div>Mon [texte</div><blockquote class="spm-quote"><div>cité] ici</div></blockquote>')280  const scope = assistScope(root, range)281  assert.equal(scope.kind, "authored")282  assert.equal(scope.text, "Mon texte")283  const empty = mount('<div><br></div><div class="spm-signature">S|</div><blockquote><div>q</div></blockquote>')284  const none = assistScope(empty.root, empty.range)285  assert.deepEqual([none.kind, none.text, none.range], ["authored", "", null])286})287
Files main
Menu

Theme