@modusoperandi/licit 0.1.7 → 0.1.8

package/src/consolidateListNodes.js

@@ -1,281 +1,281 @@
-// @flow
-
-import isOrderedListNode from './isOrderedListNode';
-import isListNode from './isListNode';
-import { Fragment } from 'prosemirror-model';
-import { Node } from 'prosemirror-model';
-import { Transform } from 'prosemirror-transform';
-
-type JointInfo = {
-  content: Fragment,
-  deleteFrom: number,
-  deleteTo: number,
-  firstListNodePos: number,
-  insertAt: number,
-};
-
-// This function consolidates list nodes among the same "Lists Island".
-//
-// ## Definition of a "Lists Island"
-//   Separate list that are adjacent to each other are grouped as
-//   a "Lists Island".
-//   For example, the following HTML snippets contains two "Lists Island":
-//
-//     <h1>text</h1>
-//     <!-- Lists Island Starts -->
-//     <ul><li>text</li><li>text</li></ul>
-//     <ol><li>text</li><li>text</li></ul>
-//     <!-- Lists Island Ends -->
-//     <p>text</p>
-//     <!-- Lists Island Starts -->
-//     <ul><li>text</li><li>text</li></ul>
-//     <ol><li>text</li><li>text</li></ul>
-//     <!-- Lists Island Ends -->
-//     <p>text</p>
-//
-// List nodes with the same list type and indent level among the same Lists
-// Island will be joined into one list node.
-// Note that this transform may change the current user selection.
-export default function consolidateListNodes(tr: Transform): Transform {
-  if (tr.getMeta('dryrun')) {
-    // This transform is potentially expensive to perform, so skip it if
-    // the transform is performed as "dryrun".
-    return tr;
-  }
-
-  let prevJointInfo;
-
-  // Keep the loop running until there's no more list nodes that can be joined.
-  while (true) {
-    const jointInfo = traverseDocAndFindJointInfo(tr.doc, prevJointInfo);
-    if (jointInfo) {
-      const { deleteFrom, deleteTo, insertAt, content } = jointInfo;
-      tr = tr.delete(deleteFrom, deleteTo);
-      tr = tr.insert(insertAt, content);
-      prevJointInfo = jointInfo;
-    } else {
-      tr = linkOrderedListCounters(tr);
-      break;
-    }
-  }
-  return tr;
-}
-
-/**
- * This ensures that ordered lists with the same indent level among the same
- * Lists Island share the same counter.
- *
- * For example, the following three lists:
- *   --------
- *   1. AAA
- *   2. BBB
- *   --------
- *     a. CCC
- *     d. DDD
- *   --------
- *   1. EEE
- *   2. FFF
- *   --------
- * Will transform into
- *   --------
- *   1. AAA
- *   2. BBB
- *   --------
- *     a. CCC
- *     d. DDD
- *   --------
- *   3. EEE
- *   4. FFF
- *   --------
- * This means that the 1st and the 3rd lists are linked.
- */
-function linkOrderedListCounters(tr: Transform): Transform {
-  const from = 1;
-  const to = tr.doc.nodeSize - 2;
-  if (from >= to) {
-    return tr;
-  }
-
-  const namedLists = new Set();
-
-  let listsBefore = null;
-  tr.doc.nodesBetween(from, to, (node, pos, parentNode) => {
-    let willTraverseNodeChildren = true;
-    if (isListNode(node)) {
-      // List Node can't be nested, no need to traverse its children.
-      willTraverseNodeChildren = false;
-      const indent = node.attrs.indent || 0;
-      const start = node.attrs.start || 1;
-      const { name, following } = node.attrs;
-      if (name) {
-        namedLists.add(name);
-      }
-
-      if (listsBefore) {
-        if (start === 1 && isOrderedListNode(node)) {
-          // Look backward until we could find another ordered list node to
-          // link with.
-          let counterIsLinked;
-          listsBefore.some((list, index) => {
-            if (list.node.type !== node.type && list.indent === indent) {
-              // This encounters different type of list node (e.g a bullet
-              // list node), we need to restart the counter.
-              // ------
-              // 1. AAA
-              // 2. BBB
-              // ------
-              // -. CCC
-              // -. DDD
-              // ------
-              // 1. DDD <- Counter restarts here.
-              // 2. EEE
-              // ------
-              counterIsLinked = false;
-              return true;
-            } else if (list.indent < indent) {
-              // This encounters an ordered list node that has less indent.
-              // we need to restart the counter.
-              // ------
-              // 1. AAA
-              // 2. BBB
-              // ------
-              //   1. DDD <- Counter restarts here.
-              //   2. EEE
-              // ------
-              counterIsLinked = false;
-              return true;
-            } else if (list.indent === indent) {
-              // This encounters an ordered list node that has same indent.
-              // Do not Restart the counter.
-              // ------
-              // 1. AAA
-              // 2. BBB
-              // ------
-              // 3. DDD <- Counter continues here.
-              // 4. EEE
-              // ------
-              counterIsLinked = true;
-              return true;
-            }
-            return false;
-          });
-
-          if (counterIsLinked !== undefined) {
-            tr = setCounterLinked(tr, pos, counterIsLinked);
-          }
-        }
-      } else {
-        // Found the first list among a new Lists Island.
-        // ------
-        // 1. AAA <- Counter restarts here.
-        // 2. BBB
-        listsBefore = [];
-        if (isOrderedListNode(node)) {
-          // The list may follow a previous list that is among another Lists
-          // Island. If so, do not reset the list counter.
-          const counterIsLinked = namedLists.has(following);
-          tr = setCounterLinked(tr, pos, counterIsLinked);
-        }
-      }
-      listsBefore.unshift({ parentNode, indent, node });
-    } else {
-      // Not traversing within any list node. No lists need to be updated.
-      listsBefore = null;
-    }
-    return willTraverseNodeChildren;
-  });
-  return tr;
-}
-
-function setCounterLinked(
-  tr: Transform,
-  pos: number,
-  linked: boolean
-): Transform {
-  const node = tr.doc.nodeAt(pos);
-  const currentValue = node.attrs.counterReset || null;
-  const nextValue = linked ? 'none' : null;
-  if (nextValue !== currentValue) {
-    const nodeAttrs = { ...node.attrs, counterReset: nextValue };
-    tr = tr.setNodeMarkup(pos, node.type, nodeAttrs, node.marks);
-  }
-  return tr;
-}
-
-function traverseDocAndFindJointInfo(
-  doc: Node,
-  prevJointInfo: ?JointInfo
-): ?JointInfo {
-  const minFrom = 1;
-
-  const from = prevJointInfo
-    ? Math.max(minFrom, prevJointInfo.firstListNodePos)
-    : minFrom;
-
-  const to = doc.nodeSize - 2;
-
-  if (to <= from) {
-    return null;
-  }
-
-  let prevNode = null;
-  let jointInfo = null;
-  let firstListNodePos = 0;
-
-  // Perform the breadth-first traversal.
-  doc.nodesBetween(from, to, (node, pos) => {
-    if (jointInfo) {
-      // We've found the list to merge. Stop traversing deeper.
-      return false;
-    } else if (isListNode(node)) {
-      firstListNodePos = firstListNodePos === 0 ? pos : firstListNodePos;
-      jointInfo = resolveJointInfo(node, pos, prevNode, firstListNodePos);
-      prevNode = node;
-      // Stop the traversing recursively inside the this list node because
-      // its content only contains inline nodes.
-      return false;
-    } else {
-      prevNode = node;
-      // This is not a list node, will keep traversing deeper until we've found
-      // a list node or reach the leaf node.
-      return true;
-    }
-  });
-
-  if (jointInfo) {
-    // Reduce the range of the next traversal so it could run faster.
-    jointInfo.firstListNodePos = firstListNodePos;
-  }
-
-  return jointInfo;
-}
-
-// If two siblings nodes that can be joined as single list, returns
-// the information of how to join them.
-function resolveJointInfo(
-  node: Node,
-  pos: number,
-  prevNode: ?Node,
-  firstListNodePos: number
-): ?JointInfo {
-  if (!prevNode || !canJoinListNodes(node, prevNode)) {
-    return null;
-  }
-
-  return {
-    deleteFrom: pos,
-    deleteTo: pos + node.nodeSize,
-    insertAt: pos - 1,
-    content: node.content,
-    firstListNodePos,
-  };
-}
-
-function canJoinListNodes(one: Node, two: Node): boolean {
-  return !!(
-    one.type === two.type &&
-    one.attrs.indent === two.attrs.indent &&
-    isListNode(one) &&
-    isListNode(two)
-  );
-}
+// @flow
+
+import isOrderedListNode from './isOrderedListNode';
+import isListNode from './isListNode';
+import { Fragment } from 'prosemirror-model';
+import { Node } from 'prosemirror-model';
+import { Transform } from 'prosemirror-transform';
+
+type JointInfo = {
+  content: Fragment,
+  deleteFrom: number,
+  deleteTo: number,
+  firstListNodePos: number,
+  insertAt: number,
+};
+
+// This function consolidates list nodes among the same "Lists Island".
+//
+// ## Definition of a "Lists Island"
+//   Separate list that are adjacent to each other are grouped as
+//   a "Lists Island".
+//   For example, the following HTML snippets contains two "Lists Island":
+//
+//     <h1>text</h1>
+//     <!-- Lists Island Starts -->
+//     <ul><li>text</li><li>text</li></ul>
+//     <ol><li>text</li><li>text</li></ul>
+//     <!-- Lists Island Ends -->
+//     <p>text</p>
+//     <!-- Lists Island Starts -->
+//     <ul><li>text</li><li>text</li></ul>
+//     <ol><li>text</li><li>text</li></ul>
+//     <!-- Lists Island Ends -->
+//     <p>text</p>
+//
+// List nodes with the same list type and indent level among the same Lists
+// Island will be joined into one list node.
+// Note that this transform may change the current user selection.
+export default function consolidateListNodes(tr: Transform): Transform {
+  if (tr.getMeta('dryrun')) {
+    // This transform is potentially expensive to perform, so skip it if
+    // the transform is performed as "dryrun".
+    return tr;
+  }
+
+  let prevJointInfo;
+
+  // Keep the loop running until there's no more list nodes that can be joined.
+  while (true) {
+    const jointInfo = traverseDocAndFindJointInfo(tr.doc, prevJointInfo);
+    if (jointInfo) {
+      const { deleteFrom, deleteTo, insertAt, content } = jointInfo;
+      tr = tr.delete(deleteFrom, deleteTo);
+      tr = tr.insert(insertAt, content);
+      prevJointInfo = jointInfo;
+    } else {
+      tr = linkOrderedListCounters(tr);
+      break;
+    }
+  }
+  return tr;
+}
+
+/**
+ * This ensures that ordered lists with the same indent level among the same
+ * Lists Island share the same counter.
+ *
+ * For example, the following three lists:
+ *   --------
+ *   1. AAA
+ *   2. BBB
+ *   --------
+ *     a. CCC
+ *     d. DDD
+ *   --------
+ *   1. EEE
+ *   2. FFF
+ *   --------
+ * Will transform into
+ *   --------
+ *   1. AAA
+ *   2. BBB
+ *   --------
+ *     a. CCC
+ *     d. DDD
+ *   --------
+ *   3. EEE
+ *   4. FFF
+ *   --------
+ * This means that the 1st and the 3rd lists are linked.
+ */
+function linkOrderedListCounters(tr: Transform): Transform {
+  const from = 1;
+  const to = tr.doc.nodeSize - 2;
+  if (from >= to) {
+    return tr;
+  }
+
+  const namedLists = new Set();
+
+  let listsBefore = null;
+  tr.doc.nodesBetween(from, to, (node, pos, parentNode) => {
+    let willTraverseNodeChildren = true;
+    if (isListNode(node)) {
+      // List Node can't be nested, no need to traverse its children.
+      willTraverseNodeChildren = false;
+      const indent = node.attrs.indent || 0;
+      const start = node.attrs.start || 1;
+      const { name, following } = node.attrs;
+      if (name) {
+        namedLists.add(name);
+      }
+
+      if (listsBefore) {
+        if (start === 1 && isOrderedListNode(node)) {
+          // Look backward until we could find another ordered list node to
+          // link with.
+          let counterIsLinked;
+          listsBefore.some((list, index) => {
+            if (list.node.type !== node.type && list.indent === indent) {
+              // This encounters different type of list node (e.g a bullet
+              // list node), we need to restart the counter.
+              // ------
+              // 1. AAA
+              // 2. BBB
+              // ------
+              // -. CCC
+              // -. DDD
+              // ------
+              // 1. DDD <- Counter restarts here.
+              // 2. EEE
+              // ------
+              counterIsLinked = false;
+              return true;
+            } else if (list.indent < indent) {
+              // This encounters an ordered list node that has less indent.
+              // we need to restart the counter.
+              // ------
+              // 1. AAA
+              // 2. BBB
+              // ------
+              //   1. DDD <- Counter restarts here.
+              //   2. EEE
+              // ------
+              counterIsLinked = false;
+              return true;
+            } else if (list.indent === indent) {
+              // This encounters an ordered list node that has same indent.
+              // Do not Restart the counter.
+              // ------
+              // 1. AAA
+              // 2. BBB
+              // ------
+              // 3. DDD <- Counter continues here.
+              // 4. EEE
+              // ------
+              counterIsLinked = true;
+              return true;
+            }
+            return false;
+          });
+
+          if (counterIsLinked !== undefined) {
+            tr = setCounterLinked(tr, pos, counterIsLinked);
+          }
+        }
+      } else {
+        // Found the first list among a new Lists Island.
+        // ------
+        // 1. AAA <- Counter restarts here.
+        // 2. BBB
+        listsBefore = [];
+        if (isOrderedListNode(node)) {
+          // The list may follow a previous list that is among another Lists
+          // Island. If so, do not reset the list counter.
+          const counterIsLinked = namedLists.has(following);
+          tr = setCounterLinked(tr, pos, counterIsLinked);
+        }
+      }
+      listsBefore.unshift({ parentNode, indent, node });
+    } else {
+      // Not traversing within any list node. No lists need to be updated.
+      listsBefore = null;
+    }
+    return willTraverseNodeChildren;
+  });
+  return tr;
+}
+
+function setCounterLinked(
+  tr: Transform,
+  pos: number,
+  linked: boolean
+): Transform {
+  const node = tr.doc.nodeAt(pos);
+  const currentValue = node.attrs.counterReset || null;
+  const nextValue = linked ? 'none' : null;
+  if (nextValue !== currentValue) {
+    const nodeAttrs = { ...node.attrs, counterReset: nextValue };
+    tr = tr.setNodeMarkup(pos, node.type, nodeAttrs, node.marks);
+  }
+  return tr;
+}
+
+function traverseDocAndFindJointInfo(
+  doc: Node,
+  prevJointInfo: ?JointInfo
+): ?JointInfo {
+  const minFrom = 1;
+
+  const from = prevJointInfo
+    ? Math.max(minFrom, prevJointInfo.firstListNodePos)
+    : minFrom;
+
+  const to = doc.nodeSize - 2;
+
+  if (to <= from) {
+    return null;
+  }
+
+  let prevNode = null;
+  let jointInfo = null;
+  let firstListNodePos = 0;
+
+  // Perform the breadth-first traversal.
+  doc.nodesBetween(from, to, (node, pos) => {
+    if (jointInfo) {
+      // We've found the list to merge. Stop traversing deeper.
+      return false;
+    } else if (isListNode(node)) {
+      firstListNodePos = firstListNodePos === 0 ? pos : firstListNodePos;
+      jointInfo = resolveJointInfo(node, pos, prevNode, firstListNodePos);
+      prevNode = node;
+      // Stop the traversing recursively inside the this list node because
+      // its content only contains inline nodes.
+      return false;
+    } else {
+      prevNode = node;
+      // This is not a list node, will keep traversing deeper until we've found
+      // a list node or reach the leaf node.
+      return true;
+    }
+  });
+
+  if (jointInfo) {
+    // Reduce the range of the next traversal so it could run faster.
+    jointInfo.firstListNodePos = firstListNodePos;
+  }
+
+  return jointInfo;
+}
+
+// If two siblings nodes that can be joined as single list, returns
+// the information of how to join them.
+function resolveJointInfo(
+  node: Node,
+  pos: number,
+  prevNode: ?Node,
+  firstListNodePos: number
+): ?JointInfo {
+  if (!prevNode || !canJoinListNodes(node, prevNode)) {
+    return null;
+  }
+
+  return {
+    deleteFrom: pos,
+    deleteTo: pos + node.nodeSize,
+    insertAt: pos - 1,
+    content: node.content,
+    firstListNodePos,
+  };
+}
+
+function canJoinListNodes(one: Node, two: Node): boolean {
+  return !!(
+    one.type === two.type &&
+    one.attrs.indent === two.attrs.indent &&
+    isListNode(one) &&
+    isListNode(two)
+  );
+}

package/src/convertFromDOMElement.js

@@ -1,36 +1,36 @@
-// @flow
-
-import { Schema } from 'prosemirror-model';
-import { DOMParser } from 'prosemirror-model';
-import { EditorState } from 'prosemirror-state';
-import { Plugin } from 'prosemirror-state';
-
-import { getAttrs } from './DocNodeSpec';
-import EditorPlugins from './EditorPlugins';
-import EditorSchema from './EditorSchema';
-
-export default function convertFromDOMElement(
-  el: HTMLElement,
-  schema: ?Schema,
-  plugins: ?Array<Plugin>
-): EditorState {
-  const effectiveSchema = schema || EditorSchema;
-  const effectivePlugins = plugins || EditorPlugins;
-  const bodyEl = el.querySelector('body');
-
-  // https://prosemirror.net/docs/ref/#model.ParseOptions.preserveWhitespace
-  const doc = DOMParser.fromSchema(effectiveSchema).parse(el, {
-    preserveWhitespace: true,
-  });
-
-  if (bodyEl) {
-    // Unfortunately the root node `doc` does not supoort `parseDOM`, thus
-    // we'd have to assign its `attrs` manually.
-    doc.attrs = getAttrs(bodyEl);
-  }
-
-  return EditorState.create({
-    doc,
-    plugins: effectivePlugins,
-  });
-}
+// @flow
+
+import { Schema } from 'prosemirror-model';
+import { DOMParser } from 'prosemirror-model';
+import { EditorState } from 'prosemirror-state';
+import { Plugin } from 'prosemirror-state';
+
+import { getAttrs } from './DocNodeSpec';
+import EditorPlugins from './EditorPlugins';
+import EditorSchema from './EditorSchema';
+
+export default function convertFromDOMElement(
+  el: HTMLElement,
+  schema: ?Schema,
+  plugins: ?Array<Plugin>
+): EditorState {
+  const effectiveSchema = schema || EditorSchema;
+  const effectivePlugins = plugins || EditorPlugins;
+  const bodyEl = el.querySelector('body');
+
+  // https://prosemirror.net/docs/ref/#model.ParseOptions.preserveWhitespace
+  const doc = DOMParser.fromSchema(effectiveSchema).parse(el, {
+    preserveWhitespace: true,
+  });
+
+  if (bodyEl) {
+    // Unfortunately the root node `doc` does not supoort `parseDOM`, thus
+    // we'd have to assign its `attrs` manually.
+    doc.attrs = getAttrs(bodyEl);
+  }
+
+  return EditorState.create({
+    doc,
+    plugins: effectivePlugins,
+  });
+}

package/src/convertFromHTML.js

@@ -1,19 +1,19 @@
-// @flow
-
-import { Schema } from 'prosemirror-model';
-import { EditorState } from 'prosemirror-state';
-import { Plugin } from 'prosemirror-state';
-
-import convertFromDOMElement from './convertFromDOMElement';
-import normalizeHTML from './normalizeHTML';
-
-export default function convertFromHTML(
-  html: string,
-  schema: ?Schema,
-  plugins: ?Array<Plugin>
-): EditorState {
-  const root = document.createElement('html');
-  const newHTML = normalizeHTML(html);
-  root.innerHTML = newHTML;
-  return convertFromDOMElement(root, schema, plugins);
-}
+// @flow
+
+import { Schema } from 'prosemirror-model';
+import { EditorState } from 'prosemirror-state';
+import { Plugin } from 'prosemirror-state';
+
+import convertFromDOMElement from './convertFromDOMElement';
+import normalizeHTML from './normalizeHTML';
+
+export default function convertFromHTML(
+  html: string,
+  schema: ?Schema,
+  plugins: ?Array<Plugin>
+): EditorState {
+  const root = document.createElement('html');
+  const newHTML = normalizeHTML(html);
+  root.innerHTML = newHTML;
+  return convertFromDOMElement(root, schema, plugins);
+}