remark-docx 0.1.6 → 0.1.8

package/README.md

@@ -1,6 +1,6 @@
 # remark-docx
 
-![npm](https://img.shields.io/npm/v/remark-docx) ![check](https://github.com/inokawa/remark-docx/workflows/check/badge.svg) ![demo](https://github.com/inokawa/remark-docx/workflows/demo/badge.svg)
+![npm](https://img.shields.io/npm/v/remark-docx) ![npm](https://img.shields.io/npm/dw/remark-docx) ![check](https://github.com/inokawa/remark-docx/workflows/check/badge.svg) ![demo](https://github.com/inokawa/remark-docx/workflows/demo/badge.svg)
 
 [remark](https://github.com/remarkjs/remark) plugin to compile markdown to docx (Microsoft Word, Office Open XML).
 
@@ -23,7 +23,7 @@ If you have some feature requests or improvements, please create a [issue](https
 - [ ] code
 - [ ] yaml
 - [ ] toml
-- [ ] definition
+- [x] definition
 - [x] footnoteDefinition
 - [x] text
 - [x] emphasis
@@ -33,8 +33,8 @@ If you have some feature requests or improvements, please create a [issue](https
 - [x] break
 - [x] link
 - [x] image
-- [ ] linkReference
-- [ ] imageReference
+- [x] linkReference
+- [x] imageReference
 - [x] footnote
 - [x] footnoteReference
 - [x] LaTeX support with math and inlineMath ([remark-math](https://github.com/remarkjs/remark-math) is required)
@@ -100,10 +100,11 @@ If you find a problem, feel free to create an [issue](https://github.com/inokawa
 
 ### Making a Pull Request
 
-1. Clone this repo.
+1. Fork this repo.
 2. Run `npm install`.
 3. Commit your fix.
-4. Make a PR and confirm all the CI checks passed.
+4. Add tests to cover the fix.
+5. Make a PR and confirm all the CI checks passed.
 
 ## Related projects
 

package/lib/index.js

@@ -4,9 +4,15 @@ var unistUtilVisit = require('unist-util-visit');
 var docx = require('docx');
 var unifiedLatexUtilParse = require('@unified-latex/unified-latex-util-parse');
 
+/**
+ * @internal
+ */
 const unreachable = (_) => {
     throw new Error("unreachable");
 };
+/**
+ * @internal
+ */
 function invariant(cond, message) {
     if (!cond)
         throw new Error(message);
@@ -336,6 +342,9 @@ const mapNode = (n, runs) => {
     }
     return [];
 };
+/**
+ * @internal
+ */
 const parseLatex = (value) => {
     const parsed = unifiedLatexUtilParse.parseMath(value);
     const paragraphs = [[]];
@@ -418,11 +427,44 @@ const DEFAULT_NUMBERINGS = [
         },
     },
 ];
+const createFootnoteRegistry = () => {
+    const idToInternalId = new Map();
+    const defs = new Map();
+    const getId = (id) => {
+        let internalId = idToInternalId.get(id);
+        if (internalId == null) {
+            idToInternalId.set(id, (internalId = idToInternalId.size + 1));
+        }
+        return internalId;
+    };
+    return {
+        ref: (id) => {
+            return getId(id);
+        },
+        def: (id, def) => {
+            const internalId = getId(id);
+            defs.set(internalId, def);
+        },
+        footnotes: () => {
+            return defs.entries().reduce((acc, [key, def]) => {
+                acc[key] = def;
+                return acc;
+            }, {});
+        },
+    };
+};
 const mdastToDocx = async (node, { output = "buffer", title, subject, creator, keywords, description, lastModifiedBy, revision, styles, background, }, images) => {
-    const { nodes, footnotes } = convertNodes(node.children, {
+    const definition = {};
+    unistUtilVisit.visit(node, "definition", (node) => {
+        definition[node.identifier] = node.url;
+    });
+    const footnote = createFootnoteRegistry();
+    const nodes = convertNodes(node.children, {
         deco: {},
         images,
         indent: 0,
+        def: definition,
+        footnote,
     });
     const doc = new docx.Document({
         title,
@@ -434,7 +476,7 @@ const mdastToDocx = async (node, { output = "buffer", title, subject, creator, k
         revision,
         styles,
         background,
-        footnotes,
+        footnotes: footnote.footnotes(),
         sections: [{ children: nodes }],
         numbering: {
             config: [
@@ -458,24 +500,27 @@ const mdastToDocx = async (node, { output = "buffer", title, subject, creator, k
 };
 const convertNodes = (nodes, ctx) => {
     const results = [];
-    let footnotes = {};
     for (const node of nodes) {
         switch (node.type) {
-            case "paragraph":
+            case "paragraph": {
                 results.push(buildParagraph(node, ctx));
                 break;
-            case "heading":
+            }
+            case "heading": {
                 results.push(buildHeading(node, ctx));
                 break;
+            }
             case "thematicBreak":
                 results.push(buildThematicBreak());
                 break;
-            case "blockquote":
+            case "blockquote": {
                 results.push(...buildBlockquote(node, ctx));
                 break;
-            case "list":
+            }
+            case "list": {
                 results.push(...buildList(node, ctx));
                 break;
+            }
             case "listItem":
                 invariant(false, "unreachable");
             case "table":
@@ -498,11 +543,12 @@ const convertNodes = (nodes, ctx) => {
                 // FIXME: unimplemented
                 break;
             case "definition":
-                // FIXME: unimplemented
+                // noop
                 break;
-            case "footnoteDefinition":
-                footnotes[node.identifier] = buildFootnoteDefinition(node, ctx);
+            case "footnoteDefinition": {
+                registerFootnoteDefinition(node, ctx);
                 break;
+            }
             case "text":
                 results.push(buildText(node.value, ctx.deco));
                 break;
@@ -510,7 +556,7 @@ const convertNodes = (nodes, ctx) => {
             case "strong":
             case "delete": {
                 const { type, children } = node;
-                const { nodes } = convertNodes(children, {
+                const nodes = convertNodes(children, {
                     ...ctx,
                     deco: { ...ctx.deco, [type]: true },
                 });
@@ -524,24 +570,29 @@ const convertNodes = (nodes, ctx) => {
             case "break":
                 results.push(buildBreak());
                 break;
-            case "link":
+            case "link": {
                 results.push(buildLink(node, ctx));
                 break;
+            }
             case "image":
                 results.push(buildImage(node, ctx.images));
                 break;
             case "linkReference":
-                // FIXME: unimplemented
+                results.push(...buildLinkReference(node, ctx));
                 break;
-            case "imageReference":
-                // FIXME: unimplemented
+            case "imageReference": {
+                const image = buildImageReference(node, ctx);
+                if (image) {
+                    results.push(image);
+                }
                 break;
-            case "footnote":
-                results.push(buildFootnote(node, ctx));
+            }
+            case "footnote": {
+                // inline footnote was removed in mdast v5
                 break;
+            }
             case "footnoteReference":
-                // do we need context here?
-                results.push(buildFootnoteReference(node));
+                results.push(buildFootnoteReference(node, ctx));
                 break;
             case "math":
                 results.push(...buildMath(node));
@@ -554,14 +605,11 @@ const convertNodes = (nodes, ctx) => {
                 break;
         }
     }
-    return {
-        nodes: results,
-        footnotes,
-    };
+    return results;
 };
 const buildParagraph = ({ children }, ctx) => {
     const list = ctx.list;
-    const { nodes } = convertNodes(children, ctx);
+    const nodes = convertNodes(children, ctx);
     if (list && list.checked != null) {
         nodes.unshift(new docx.CheckBox({
             checked: list.checked,
@@ -592,30 +640,30 @@ const buildParagraph = ({ children }, ctx) => {
     });
 };
 const buildHeading = ({ children, depth }, ctx) => {
-    let heading;
+    let headingLevel;
     switch (depth) {
         case 1:
-            heading = docx.HeadingLevel.TITLE;
+            headingLevel = docx.HeadingLevel.TITLE;
             break;
         case 2:
-            heading = docx.HeadingLevel.HEADING_1;
+            headingLevel = docx.HeadingLevel.HEADING_1;
             break;
         case 3:
-            heading = docx.HeadingLevel.HEADING_2;
+            headingLevel = docx.HeadingLevel.HEADING_2;
             break;
         case 4:
-            heading = docx.HeadingLevel.HEADING_3;
+            headingLevel = docx.HeadingLevel.HEADING_3;
             break;
         case 5:
-            heading = docx.HeadingLevel.HEADING_4;
+            headingLevel = docx.HeadingLevel.HEADING_4;
             break;
         case 6:
-            heading = docx.HeadingLevel.HEADING_5;
+            headingLevel = docx.HeadingLevel.HEADING_5;
             break;
     }
-    const { nodes } = convertNodes(children, ctx);
+    const nodes = convertNodes(children, ctx);
     return new docx.Paragraph({
-        heading,
+        heading: headingLevel,
         children: nodes,
     });
 };
@@ -625,8 +673,10 @@ const buildThematicBreak = (_) => {
     });
 };
 const buildBlockquote = ({ children }, ctx) => {
-    const { nodes } = convertNodes(children, { ...ctx, indent: ctx.indent + 1 });
-    return nodes;
+    return convertNodes(children, {
+        ...ctx,
+        indent: ctx.indent + 1,
+    });
 };
 const buildList = ({ children, ordered, start: _start, spread: _spread }, ctx) => {
     const list = {
@@ -641,11 +691,10 @@ const buildList = ({ children, ordered, start: _start, spread: _spread }, ctx) =
     });
 };
 const buildListItem = ({ children, checked, spread: _spread }, ctx) => {
-    const { nodes } = convertNodes(children, {
+    return convertNodes(children, {
         ...ctx,
         ...(ctx.list && { list: { ...ctx.list, checked: checked !== null && checked !== void 0 ? checked : undefined } }),
     });
-    return nodes;
 };
 const buildTable = ({ children, align }, ctx) => {
     const cellAligns = align === null || align === void 0 ? void 0 : align.map((a) => {
@@ -674,7 +723,7 @@ const buildTableRow = ({ children }, ctx, cellAligns) => {
     });
 };
 const buildTableCell = ({ children }, ctx, align) => {
-    const { nodes } = convertNodes(children, ctx);
+    const nodes = convertNodes(children, ctx);
     return new docx.TableCell({
         children: [
             new docx.Paragraph({
@@ -690,7 +739,7 @@ const buildHtml = ({ value }) => {
         children: [buildText(value, {})],
     });
 };
-const buildCode = ({ value, lang: _lang, meta: _meta }) => {
+const buildCode = ({ value, lang: _lang, meta: _meta, }) => {
     // FIXME: transform to text for now
     return new docx.Paragraph({
         children: [buildText(value, {})],
@@ -721,14 +770,14 @@ const buildText = (text, deco) => {
 const buildBreak = (_) => {
     return new docx.TextRun({ text: "", break: 1 });
 };
-const buildLink = ({ children, url, title: _title }, ctx) => {
-    const { nodes } = convertNodes(children, ctx);
+const buildLink = ({ children, url }, ctx) => {
+    const nodes = convertNodes(children, ctx);
     return new docx.ExternalHyperlink({
         link: url,
         children: nodes,
     });
 };
-const buildImage = ({ url, title: _title, alt: _alt }, images) => {
+const buildImage = ({ url }, images) => {
     const img = images[url];
     invariant(img, `Fetch image was failed: ${url}`);
     const { image, width, height } = img;
@@ -740,24 +789,36 @@ const buildImage = ({ url, title: _title, alt: _alt }, images) => {
         },
     });
 };
-const buildFootnote = ({ children }, ctx) => {
-    // FIXME: transform to paragraph for now
-    const { nodes } = convertNodes(children, ctx);
-    return new docx.Paragraph({
-        children: nodes,
-    });
+const buildLinkReference = ({ children, identifier }, ctx) => {
+    const def = ctx.def[identifier];
+    if (def == null) {
+        return convertNodes(children, ctx);
+    }
+    return [buildLink({ children, url: def }, ctx)];
 };
-const buildFootnoteDefinition = ({ children }, ctx) => {
-    return {
+const buildImageReference = ({ identifier }, ctx) => {
+    const def = ctx.def[identifier];
+    if (def == null) {
+        return;
+    }
+    return buildImage({ url: def }, ctx.images);
+};
+const registerFootnoteDefinition = ({ children, identifier }, ctx) => {
+    const definition = {
         children: children.map((node) => {
-            const { nodes } = convertNodes([node], ctx);
-            return nodes[0];
+            // Convert each node and extract the first result as a paragraph
+            const nodes = convertNodes([node], ctx);
+            if (nodes[0] instanceof docx.Paragraph) {
+                return nodes[0];
+            }
+            // For non-paragraph content, wrap in a paragraph
+            return new docx.Paragraph({ children: nodes });
         }),
     };
+    ctx.footnote.def(identifier, definition);
 };
-const buildFootnoteReference = ({ identifier }) => {
-    // do we need Context?
-    return new docx.FootnoteReferenceRun(parseInt(identifier));
+const buildFootnoteReference = ({ identifier }, ctx) => {
+    return new docx.FootnoteReferenceRun(ctx.footnote.ref(identifier));
 };
 
 const plugin = function (opts = {}) {
@@ -770,14 +831,34 @@ const plugin = function (opts = {}) {
         unistUtilVisit.visit(node, "image", (node) => {
             imageList.push(node);
         });
+        const defs = new Map();
+        unistUtilVisit.visit(node, "definition", (node) => {
+            defs.set(node.identifier, node);
+        });
+        unistUtilVisit.visit(node, "imageReference", (node) => {
+            const maybeImage = defs.get(node.identifier);
+            if (maybeImage) {
+                imageList.push(maybeImage);
+            }
+        });
         if (imageList.length === 0) {
             return node;
         }
         const imageResolver = opts.imageResolver;
         invariant(imageResolver, "options.imageResolver is not defined.");
-        const imageDatas = await Promise.all(imageList.map(({ url }) => imageResolver(url)));
-        images = imageList.reduce((acc, img, i) => {
-            acc[img.url] = imageDatas[i];
+        const resolved = new Set();
+        const promises = [];
+        imageList.forEach(({ url }) => {
+            if (!resolved.has(url)) {
+                resolved.add(url);
+                promises.push((async () => {
+                    const img = await imageResolver(url);
+                    return { img, url };
+                })());
+            }
+        });
+        images = (await Promise.all(promises)).reduce((acc, { img, url }) => {
+            acc[url] = img;
             return acc;
         }, {});
         return node;